@hyperlane-xyz/sdk 12.0.0 → 12.1.0-cli-bundle.0

package/dist/zksync/ZKSyncDeployer.js

@@ -0,0 +1,123 @@
+import { utils } from 'ethers';
+import { ContractFactory, } from 'zksync-ethers';
+import { assert } from '@hyperlane-xyz/utils';
+import { defaultZKProviderBuilder } from '../providers/providerBuilders.js';
+import { getZKSyncArtifactByContractName } from '../utils/zksync.js';
+/**
+ * Class for deploying contracts to the ZKSync network.
+ */
+export class ZKSyncDeployer {
+    zkWallet;
+    deploymentType;
+    constructor(zkWallet, deploymentType) {
+        this.deploymentType = deploymentType;
+        this.zkWallet = zkWallet.connect(zkWallet.provider ??
+            defaultZKProviderBuilder([{ http: 'http://127.0.0.1:8011' }], 260));
+    }
+    /**
+     * Loads and validates a ZKSync contract artifact by name
+     * @param contractTitle - Contract name or qualified name (sourceName:contractName)
+     *
+     * @returns The ZKSync artifact
+     */
+    async loadArtifact(contractTitle) {
+        const artifact = await getZKSyncArtifactByContractName(contractTitle);
+        assert(artifact, `No ZKSync artifact for contract ${contractTitle} found!`);
+        return artifact;
+    }
+    /**
+     * Estimates the price of calling a deploy transaction in ETH.
+     *
+     * @param artifact The previously loaded artifact object.
+     * @param constructorArguments List of arguments to be passed to the contract constructor.
+     *
+     * @returns Calculated fee in ETH wei
+     */
+    async estimateDeployFee(artifact, constructorArguments) {
+        const gas = await this.estimateDeployGas(artifact, constructorArguments);
+        const gasPrice = await this.zkWallet.provider.getGasPrice();
+        return gas.mul(gasPrice);
+    }
+    /**
+     * Estimates the amount of gas needed to execute a deploy transaction.
+     *
+     * @param artifact The previously loaded artifact object.
+     * @param constructorArguments List of arguments to be passed to the contract constructor.
+     *
+     * @returns Calculated amount of gas.
+     */
+    async estimateDeployGas(artifact, constructorArguments) {
+        const factoryDeps = await this.extractFactoryDeps(artifact);
+        const factory = new ContractFactory(artifact.abi, artifact.bytecode, this.zkWallet, this.deploymentType);
+        // Encode deploy transaction so it can be estimated.
+        const deployTx = factory.getDeployTransaction(...constructorArguments, {
+            customData: {
+                factoryDeps,
+            },
+        });
+        deployTx.from = this.zkWallet.address;
+        return this.zkWallet.provider.estimateGas(deployTx);
+    }
+    /**
+     * Sends a deploy transaction to the zkSync network.
+     * For now, it will use defaults for the transaction parameters:
+     * - fee amount is requested automatically from the zkSync server.
+     *
+     * @param artifact The previously loaded artifact object.
+     * @param constructorArguments List of arguments to be passed to the contract constructor.
+     * @param overrides Optional object with additional deploy transaction parameters.
+     * @param additionalFactoryDeps Additional contract bytecodes to be added to the factory dependencies list.
+     *
+     * @returns A contract object.
+     */
+    async deploy(artifact, constructorArguments = [], overrides, additionalFactoryDeps) {
+        const baseDeps = await this.extractFactoryDeps(artifact);
+        const additionalDeps = additionalFactoryDeps
+            ? additionalFactoryDeps.map((val) => utils.hexlify(val))
+            : [];
+        const factoryDeps = [...baseDeps, ...additionalDeps];
+        const factory = new ContractFactory(artifact.abi, artifact.bytecode, this.zkWallet, this.deploymentType);
+        const { customData, ..._overrides } = overrides ?? {};
+        // Encode and send the deploy transaction providing factory dependencies.
+        const contract = await factory.deploy(...constructorArguments, {
+            ..._overrides,
+            customData: {
+                ...customData,
+                factoryDeps,
+            },
+        });
+        await contract.deployed();
+        return contract;
+    }
+    /**
+     * Extracts factory dependencies from the artifact.
+     *
+     * @param artifact Artifact to extract dependencies from
+     *
+     * @returns Factory dependencies in the format expected by SDK.
+     */
+    async extractFactoryDeps(artifact) {
+        const visited = new Set();
+        visited.add(`${artifact.sourceName}:${artifact.contractName}`);
+        return this.extractFactoryDepsRecursive(artifact, visited);
+    }
+    async extractFactoryDepsRecursive(artifact, visited) {
+        // Load all the dependency bytecodes.
+        // We transform it into an array of bytecodes.
+        const factoryDeps = [];
+        for (const dependencyHash in artifact.factoryDeps) {
+            if (Object.prototype.hasOwnProperty.call(artifact.factoryDeps, dependencyHash)) {
+                const dependencyContract = artifact.factoryDeps[dependencyHash];
+                if (!visited.has(dependencyContract)) {
+                    const dependencyArtifact = await this.loadArtifact(dependencyContract);
+                    factoryDeps.push(dependencyArtifact.bytecode);
+                    visited.add(dependencyContract);
+                    const transitiveDeps = await this.extractFactoryDepsRecursive(dependencyArtifact, visited);
+                    factoryDeps.push(...transitiveDeps);
+                }
+            }
+        }
+        return factoryDeps;
+    }
+}
+//# sourceMappingURL=ZKSyncDeployer.js.map

package/dist/zksync/ZKSyncDeployer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZKSyncDeployer.js","sourceRoot":"","sources":["../../src/zksync/ZKSyncDeployer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,KAAK,EAAE,MAAM,QAAQ,CAAC;AAChE,OAAO,EAEL,eAAe,GAGhB,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,+BAA+B,EAAE,MAAM,oBAAoB,CAAC;AAErE;;GAEG;AACH,MAAM,OAAO,cAAc;IAClB,QAAQ,CAAS;IACjB,cAAc,CAA8B;IAEnD,YAAY,QAAgB,EAAE,cAA2C;QACvE,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QAErC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAC9B,QAAQ,CAAC,QAAQ;YACf,wBAAwB,CAAC,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,EAAE,GAAG,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,YAAY,CAAC,aAAqB;QAC9C,MAAM,QAAQ,GAAG,MAAM,+BAA+B,CAAC,aAAa,CAAC,CAAC;QACtE,MAAM,CAAC,QAAQ,EAAE,mCAAmC,aAAa,SAAS,CAAC,CAAC;QAC5E,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,iBAAiB,CAC5B,QAAwB,EACxB,oBAA2B;QAE3B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAC5D,OAAO,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,iBAAiB,CAC5B,QAAwB,EACxB,oBAA2B;QAE3B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAE5D,MAAM,OAAO,GAAG,IAAI,eAAe,CACjC,QAAQ,CAAC,GAAG,EACZ,QAAQ,CAAC,QAAQ,EACjB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,cAAc,CACpB,CAAC;QAEF,oDAAoD;QACpD,MAAM,QAAQ,GAAG,OAAO,CAAC,oBAAoB,CAAC,GAAG,oBAAoB,EAAE;YACrE,UAAU,EAAE;gBACV,WAAW;aACZ;SACF,CAAC,CAAC;QACH,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAEtC,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,MAAM,CACjB,QAAwB,EACxB,uBAA8B,EAAE,EAChC,SAAqB,EACrB,qBAAmC;QAEnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,cAAc,GAAG,qBAAqB;YAC1C,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxD,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,WAAW,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,cAAc,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,IAAI,eAAe,CACjC,QAAQ,CAAC,GAAG,EACZ,QAAQ,CAAC,QAAQ,EACjB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,cAAc,CACpB,CAAC;QAEF,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,GAAG,SAAS,IAAI,EAAE,CAAC;QAEtD,yEAAyE;QACzE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,oBAAoB,EAAE;YAC7D,GAAG,UAAU;YACb,UAAU,EAAE;gBACV,GAAG,UAAU;gBACb,WAAW;aACZ;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAE1B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CAAC,QAAwB;QAC/C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;QAElC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC,2BAA2B,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAEO,KAAK,CAAC,2BAA2B,CACvC,QAAwB,EACxB,OAAoB;QAEpB,qCAAqC;QACrC,8CAA8C;QAC9C,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,KAAK,MAAM,cAAc,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;YAClD,IACE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAClC,QAAQ,CAAC,WAAW,EACpB,cAAc,CACf,EACD,CAAC;gBACD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;gBAChE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBACrC,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,YAAY,CAChD,kBAAkB,CACnB,CAAC;oBACF,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;oBAC9C,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;oBAChC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAC3D,kBAAkB,EAClB,OAAO,CACR,CAAC;oBACF,WAAW,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;CACF"}

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@hyperlane-xyz/sdk",
   "description": "The official SDK for the Hyperlane Network",
-  "version": "12.0.0",
+  "version": "12.1.0-cli-bundle.0",
   "dependencies": {
     "@arbitrum/sdk": "^4.0.0",
     "@aws-sdk/client-s3": "^3.577.0",
     "@chain-registry/types": "^0.50.14",
     "@cosmjs/cosmwasm-stargate": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
-    "@hyperlane-xyz/core": "7.0.0",
-    "@hyperlane-xyz/utils": "12.0.0",
+    "@hyperlane-xyz/core": "7.1.0-cli-bundle.0",
+    "@hyperlane-xyz/utils": "12.1.0-cli-bundle.0",
     "@safe-global/api-kit": "1.3.0",
     "@safe-global/protocol-kit": "1.3.0",
     "@safe-global/safe-deployments": "1.37.23",