feat(core): update diff to include constructor arg variables and post…

…-deployment actions
hujw77 · Sep 4, 2023 · 2913976 · 2913976
1 parent 5de8fa5
commit 2913976
Show file tree

Hide file tree

Showing 16 changed files with 999 additions and 265 deletions.
diff --git a/.changeset/quick-guests-leave.md b/.changeset/quick-guests-leave.md
@@ -0,0 +1,5 @@
+---
+'@sphinx-labs/core': minor
+---
+
+Update diff to include constructor arg variables and post-deployment actions
diff --git a/docs/faq.md b/docs/faq.md
@@ -1,15 +1,9 @@
 # FAQ
 
-### How do I deploy a contract when another contract already exists at its `CREATE3` address?
+### Why is Sphinx skipping a contract deployment or function call?
 
-Sphinx detects this situation and outputs the following message in the diff:
-```bash
-Skipping:
-Reason: Contract already deployed at the Create3 address.
-Contract(s):
-...
-```
+With Sphinx, contract deployments and function calls are idempotent. This means that they'll only be executed once per chain, even if you re-deploy your config file.
 
-To deploy a new contract, you must change its `CREATE3` address. There are two ways to do this:
+If you'd like to re-deploy a contract instead of skipping it, you must change its `CREATE3` address. There are two ways to do this:
 1. (Recommended): Add a `salt` to the contract definition in the Sphinx config file. For more info on the `salt`, see [here](https://github.com/sphinx-labs/sphinx/blob/develop/docs/config-file.md#contract-definitions).
 2. Change the reference name of the contract. For more info on reference names, see [here](https://github.com/sphinx-labs/sphinx/blob/develop/docs/config-file.md#reference-names).
diff --git a/packages/core/src/actions/bundle.ts b/packages/core/src/actions/bundle.ts
@@ -23,9 +23,10 @@ import {
   getEmptyCanonicalConfig,
   toHexString,
   fromHexString,
-  getCallHash,
   isSupportedChainId,
   parseSemverVersion,
+  prettyFunctionCall,
+  skipCallAction,
 } from '../utils'
 import {
   ApproveDeployment,
@@ -535,6 +536,12 @@ export const makeActionBundleFromConfig = (
     const { isTargetDeployed } = configCache.contractConfigCache[referenceName]
     const { kind, salt, constructorArgs } = contractConfig
 
+    const readableSignature = prettyFunctionCall(
+      referenceName,
+      'constructor',
+      constructorArgs
+    )
+
     const deployContractCost = getEstDeployContractCost(
       buildInfo.output.contracts[sourceName][contractName].evm.gasEstimates
     )
@@ -570,7 +577,7 @@ export const makeActionBundleFromConfig = (
 
       humanReadableActions[actionIndex] = {
         actionIndex,
-        reason: referenceName,
+        reason: readableSignature,
         actionType: SphinxActionType.DEPLOY_CONTRACT,
       }
 
@@ -604,7 +611,7 @@ export const makeActionBundleFromConfig = (
 
       humanReadableActions[actionIndex] = {
         actionIndex,
-        reason: referenceName,
+        reason: readableSignature,
         actionType: SphinxActionType.DEPLOY_CONTRACT,
       }
 
@@ -618,9 +625,7 @@ export const makeActionBundleFromConfig = (
   const postDeployActions = parsedConfig.postDeploy[chainId]
   if (postDeployActions) {
     for (const { to, data, nonce, readableSignature } of postDeployActions) {
-      const callHash = getCallHash(to, data)
-      const currentNonce = configCache.callNonces[callHash]
-      if (nonce >= currentNonce) {
+      if (!skipCallAction(to, data, nonce, configCache.callNonces)) {
         actions.push({
           to,
           index: actionIndex,
@@ -631,7 +636,11 @@ export const makeActionBundleFromConfig = (
 
         humanReadableActions[actionIndex] = {
           actionIndex,
-          reason: readableSignature,
+          reason: prettyFunctionCall(
+            readableSignature.referenceNameOrAddress,
+            readableSignature.functionName,
+            readableSignature.variables
+          ),
           actionType: SphinxActionType.CALL,
         }
 
@@ -676,6 +685,7 @@ export const makeActionBundleFromConfig = (
 
       humanReadableActions[actionIndex] = {
         actionIndex,
+        // TODO(upgrades): add reason
         reason: '',
         actionType: SphinxActionType.SET_STORAGE,
       }
@@ -812,7 +822,7 @@ export const getAuthLeafsForChain = async (
   const managerVersionString = `v${configCache.managerVersion.major}.${configCache.managerVersion.minor}.${configCache.managerVersion.patch}`
   if (
     managerVersionString !== parsedConfig.options.managerVersion &&
-    configCache.isManagerDeployed
+    !configCache.isManagerDeployed
   ) {
     const version = parseSemverVersion(parsedConfig.options.managerVersion)
     const upgradeLeaf: AuthLeaf = {

diff --git a/packages/core/src/config/parse.ts b/packages/core/src/config/parse.ts
@@ -55,7 +55,6 @@ import {
   getFunctionArgValueArray,
   getCallActionAddressForNetwork,
   isSupportedChainId,
-  prettyFunctionCall,
   hyperlink,
 } from '../utils'
 import { SphinxJsonRpcProvider } from '../provider'
@@ -3589,10 +3588,11 @@ export const parsePostDeploymentActions = (
         to: address,
         data,
         nonce,
-        readableSignature: `${referenceName ?? address}.${prettyFunctionCall(
-          callAction.functionName,
-          argValues
-        )}`,
+        readableSignature: {
+          referenceNameOrAddress: referenceName ?? address,
+          functionName: callAction.functionName,
+          variables: parsedArgs,
+        },
       }
 
       const parsedActions: Array<ParsedCallAction> | undefined =

diff --git a/packages/core/src/config/types.ts b/packages/core/src/config/types.ts
@@ -77,7 +77,6 @@ export type UserConfigVariable =
 export type ParsedConfigVariable =
   | boolean
   | string
-  | number
   | Array<ParsedConfigVariable>
   | {
       [name: string]: ParsedConfigVariable
@@ -140,7 +139,13 @@ export type ParsedCallAction = {
   to: string
   data: string
   nonce: number
-  readableSignature: string
+  readableSignature: SphinxFunctionSignature
+}
+
+export type SphinxFunctionSignature = {
+  referenceNameOrAddress: string
+  functionName: string
+  variables: ParsedConfigVariables
 }
 
 export interface ParsedConfig {

diff --git a/packages/core/src/config/validation-error-messages.ts b/packages/core/src/config/validation-error-messages.ts
@@ -67,10 +67,9 @@ export const failedToEncodeFunctionCall = (
   referenceName?: string
 ): string => {
   return (
-    `Failed to encode data for the function call on ${
-      referenceName ?? callAction.address
-    }:\n` +
+    `Failed to encode data for:\n` +
     `${prettyFunctionCall(
+      referenceName ?? callAction.address,
       callAction.functionName,
       callAction.functionArgs
     )}\n` +