@requestnetwork/smart-contracts 0.21.1-next.1351 → 0.21.1-next.709

package/README.md

@@ -9,28 +9,58 @@ The package stores the sources and artifacts of the smart contracts deployed on
 npm install @requestnetwork/smart-contracts
 ```
 
+You may need some environment variables.
+You can create a .env file at the root of this package:
+
+```
+DEPLOYMENT_PRIVATE_KEY=...  # Mandatory to deploy on live blockchains (legacy)
+ADMIN_PRIVATE_KEY=...       # Mandatory to deploy on live blockchains (xdeployer)
+WEB3_PROVIDER_URL=...       # Mandatory to interact with live blockchains
+ETHERSCAN_API_KEY=...       # Only used to verify smart contracts code on live blockchains, even for other explorers, except:
+BSCSCAN_API_KEY=...         # ... for BSCScan
+POLYGONSCAN_API_KEY=...     # ... for PolygonScan
+FTMSCAN_API_KEY=...         # ... for FTMScan
+SNOWTRACE_API_KEY=...       # ... for Snowtrace
+ARBISCAN_API_KEY=...        # ... for Arbiscan
+ADMIN_WALLET_ADDRESS=...    # Mandatory to deploy contracts with admin tasks (e.g. ChainlinkConversionPath)
+DEPLOYER_MASTER_KEY=...     # Mandatory to deploy the request deployer smart contract on live blockchains
+REQUEST_DEPLOYER_LIVE=...   # Must be true to deploy contracts through the request deployer on live blockchains.
+NETWORK=...                 # List of network to deploy contracts on with the request deployer. If not set default to all supported chain.
+```
+
 ## Usage
 
 Library usage:
 
 ```js
 import * as SmartContracts from '@requestnetwork/smart-contracts';
+import { erc20FeeProxyArtifact } from '@requestnetwork/smart-contracts';
+import { providers } from 'ethers';
 
-const requestHashStorageMainnetAddress = SmartContracts.requestHashStorageArtifact.getAddress(
-  'mainnet',
-);
+const requestHashStorageMainnetAddress =
+  SmartContracts.requestHashStorageArtifact.getAddress('mainnet');
 
-const requestHashSubmitterRinkebyAddress = SmartContracts.requestHashSubmitterArtifact.getAddress(
-  'rinkeby',
-);
+const requestHashSubmitterRinkebyAddress =
+  SmartContracts.requestHashSubmitterArtifact.getAddress('rinkeby');
 
 const requestHashStorageABI = SmartContracts.requestHashStorageArtifact.getContractAbi();
+
+const erc20FeeProxyInstance = erc20FeeProxyArtifact.connect(
+  // network.name
+  'private',
+  // RPC Provider or Signer
+  new providers.JsonRpcProvider(),
+);
 ```
 
-## Smart Contract
+## Smart Contracts
 
 The package stores the following smart contracts:
 
+**Smart contracts for request deployment**
+
+- `RequestDeployer` smart contract to which we delegate our deployment through the function `deploy(value, salt, bytecode)`. It enables to deploy contract with the `CREATE2` opcode to easily manage our contract deployment addresses.
+
 **Smart contracts for ethereum-storage package**
 
 - `RequestHashStorage` allows to declare a hash `NewHash(hash, submitter, feesParameters)`. Only a whitelisted contract can declare hashes.
@@ -40,36 +70,235 @@ The package stores the following smart contracts:
 **Smart contracts for advanced-logic package**
 
 - `TestERC20` minimal erc20 token used for tests.
-- `ERC20Proxy` smart contract used by the erc20 proxy contract payment network to store payment references of erc20 transfers
-- `EthereumProxy` smart contract used by the ethereum proxy contract payment network to store payment references of Ethereum transfers
-- `ERC20FeeProxy` smart contract used by the erc20 fee proxy contract payment network to store payment references of erc20 transfers with fees
+- `ERC20Proxy` used to pay requests with an ERC20 proxy contract payment network
+- `EthereumProxy` used to pay requests in blockchain native tokens such as ETH on mainnet
+- `ERC20FeeProxy` used to pay requests in ERC20 with a fee for the builder [cf. the payment network ERC20 with fee](../advanced-logic/specs/payment-network-erc20-fee-proxy-contract-0.1.0.md)
+- `ERC20ConversionProxy` used to process a payment in ERC20 for an amount fixed in fiat, relying on `ERC20FeeProxy`, [cf. the payment network any-to-erc20](../advanced-logic/specs/payment-network-erc20-fee-proxy-contract-0.1.0.md)
+
+**Smart contracts for payments with swaps**
+
+- `ERC20SwapToPay` same as `ERC20FeeProxy` but allowing the payer to swap another token before paying
+- `ERC20SwapToConversion` same as `ERC20ConversionProxy` but allowing the payer to swap another token before paying
 
-#### Smart contracts local deployment
+## Local deployment
 
 The smart contracts can be deployed locally with the following commands:
 
 ```bash
 git clone https://github.com/RequestNetwork/requestNetwork.git
 cd requestNetwork/packages/smart-contracts
+# Install packages
 yarn install
-yarn run build
-yarn run ganache
+# Compile smart contracts, generate types and build the library
+yarn build
+# Run an instance of Ganache, ready for testing
+yarn ganache
 ```
 
-And in another terminal:
+And in another terminal, deploy the smart contracts locally with:
 
 ```bash
 yarn run deploy
 ```
 
-#### Configuring the provider using Truffle and the development network
+## Live deployment
+
+The request deployer enables multichain deployment of several smart contracts at predefined address. It is based on https://github.com/pcaversaccio/xdeployer
+
+The deployer contract should be deployed at `0xE99Ab70a5FAE59551544FA326fA048f7B95A24B2` on live chains.
+
+Be sure to run `yarn build:sol` before deploying the deployer or a contract.
+
+The contracts implemented are listed in the array `create2ContractDeploymentList` in [Utils](scripts-create2/utils.ts).
+
+### Deploy the request deployer (once per chain)
+
+Environment variables needed: `DEPLOYER_MASTER_KEY`
+
+```bash
+yarn hardhat deploy-deployer-contract --network <NETWORK>
+```
+
+### Compute the contract addresses
+
+Run:
+
+```bash
+yarn hardhat compute-contract-addresses
+```
+
+It will compute the addresses of the contracts to be deployed via the request deployer.
+
+### Deploy the contracts
+
+Depending on the xdeployer config, this script will deploy the smart contracts on several chain simultaneously
+Environment variables needed: `ADMIN_PRIVATE_KEY`
+You will need the request deployer to be deployed.
+Then run:
 
-When deploying the smart contracts for development you can manually set the provider host and port via env variables:
+To deploy all contracts to one network, use:
 
 ```bash
-TRUFFLE_GANACHE_HOST="host" TRUFFLE_GANACHE_PORT=1010 yarn run deploy
+NETWORK=<NETWORK> yarn hardhat deploy-contracts-through-deployer
 ```
 
+If you want to deploy all contracts on all networks:
+
+```bash
+yarn hardhat deploy-contracts-through-deployer
+```
+
+To deploy on live chains set `REQUEST_DEPLOYER_LIVE` to true
+
+This command will output details about each contract deployment on each chain:
+
+- If successfull: the network, the contract address and block number
+- If already deployed: the network, and the contract address
+- If an error occured: the said error
+
+### Verify the contracts
+
+Verify and publish the contract code automatically to blockchain explorers, right after smart contracts compilation.
+Environment variables needed: `ADMIN_...` key and wallet, `ETHERSCAN_API_KEY`, and `REQUEST_DEPLOYER_LIVE`.
+Depending on the contracts you're verifying you will need to set up `WEB3_PROVIDER_URL`.
+See `hardhat.config.ts`.
+
+```bash
+yarn hardhat verify-contract-from-deployer --network <NETWORK>
+```
+
+### Add the contracts to Tenderly
+
+Once the contract has been added to the artifacts (`./src/lib/artifacts`), run the following command to synchronize
+contracts with the Tenderly account.
+Environment variables needed: `TENDERLY_...` (see `hardhat.config.ts`).
+
+```bash
+yarn hardhat tenderly-monitor-contracts
+```
+
+### Verify the RequestDeployer contract
+
+If the RequestDeployer contract verification failed initially, it can be verified with:
+
+```bash
+yarn hardhat verify-deployer-contract --network <NETWORK>
+```
+
+#### Verify the contracts manually With Hardhat (legacy)
+
+A more generic way to verify any contract by setting constructor argments manually:
+
+```bash
+yarn hardhat verify --network NETWORK_NAME DEPLOYED_CONTRACT_ADDRESS "Constructor argument 1"
+```
+
+### Deprecated payment deployment scripts (legacy)
+
+The goal of this script is to let all our payment contracts be deployed with the same sequence on every chain.
+
+The script also verify deployed contracts.
+
+**Be sure that artifacts are up-to-date with most recent deployments**
+
+Environment variables needed: `ETHERSCAN_API_KEY`, `ADMIN_WALLET_ADDRESS`, `DEPLOYMENT_PRIVATE_KEY`
+
+```bash
+# First check what will be done
+yarn hardhat deploy-live-payments --network matic --dry-run
+
+# Run
+yarn hardhat deploy-live-payments --network matic
+
+# To test locally
+yarn hardhat deploy-live-payments --network private --force
+yarn hardhat deploy-live-payments --network private --force --dry-run
+```
+
+## ZkSyncEra support
+
+### Compilation
+
+To compile the contracts with the zkSync compiler, we use the same compile task but with the zkSync network specified.
+
+```bash
+yarn hardhat compile --network zksyncera
+```
+
+The compiled results go in separate directories build-zk and cache-zk.
+In order for the zkSync compiler to be activated, this networks has the `zksync: true` flag in the hardhat.config.ts file.
+
+### Deployment
+
+We have deployment scripts in the /deploy directory for contracts ERC20FeeProxy, EthereumFeeProxy and BatchPayments.
+These are different deploy scripts than regular EVM ones because they use the zkSync deploy package.
+
+We deploy with the following commands:
+
+First deploy the Proxy contracts:
+
+```bash
+yarn hardhat deploy-zksync --script deploy-zk-proxy-contracts --network zksyncera
+```
+
+Then deploy the Batch contract:
+
+```bash
+yarn hardhat deploy-zksync --script deploy-zk-batch-contracts --network zksyncera
+```
+
+We don't have deploy scripts for our Conversion proxy because there is no Chainlink feed yet on this chain.
+
+## Administrate the contracts
+
+The contracts to be updated are listed in the array `create2ContractDeploymentList` in [Utils](scripts-create2/utils.ts).
+Modify the content of the array depending on your need when you perform an administration task.
+Environment variables needed: `ADMIN_PRIVATE_KEY`
+
+To update the contracts on one network, use:
+
+```bash
+NETWORK=<NETWORK> yarn hardhat update-contracts
+```
+
+If you want to update the contracts on all networks:
+
+```bash
+yarn hardhat update-contracts
+```
+
+This command will output details about each update on each chain
+
+By default, updates are performed by a Safe wallet. They need to be confirmed by co-owners in the RN Admin Safe.
+If the contracts are to be administrated by an EOA, use the flag `eoa`:
+
+```bash
+yarn hardhat update-contracts --eoa
+```
+
+If you want to transfer the ownership of eligible contracts (Payment contracts that have owners / admins) run:
+
+```bash
+yarn hardhat transfer-ownership
+```
+
+Similarly to the previous examples, you can use this command for all networks at once, or specify one in particular.
+If the ownership is transferred from an EOA, use the flag `eoa`;
+
+## Tests
+
+After a local deployment:
+
+```bash
+yarn test
+```
+
+## Configuration
+
+Networks and providers are configured in [hardhat.config.ts](hardhat.config.ts).
+
+Have a look at the [Hardhat documentation](https://hardhat.org/config/).
+
 ## Contributing
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

package/dist/deploy/deploy-zk-batch-contracts.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Deploys Batch payments contracts to zkSync network.
+ * This script is supposed to be run with the deploy-zksync plugin
+ * check zkSync section in smart-contracts/README file
+ */
+export default function (): Promise<void>;
+//# sourceMappingURL=deploy-zk-batch-contracts.d.ts.map

package/dist/deploy/deploy-zk-batch-contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-zk-batch-contracts.d.ts","sourceRoot":"","sources":["../../deploy/deploy-zk-batch-contracts.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,0CAYC"}

package/dist/deploy/deploy-zk-batch-contracts.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const lib_1 = require("../src/lib");
+const utils_zk_1 = require("./utils-zk");
+const hre = tslib_1.__importStar(require("hardhat"));
+/**
+ * Deploys Batch payments contracts to zkSync network.
+ * This script is supposed to be run with the deploy-zksync plugin
+ * check zkSync section in smart-contracts/README file
+ */
+function default_1() {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const [deployer] = yield hre.ethers.getSigners();
+        const constructorArguments = [
+            lib_1.erc20FeeProxyArtifact.getAddress(hre.network.name),
+            lib_1.ethereumFeeProxyArtifact.getAddress(hre.network.name),
+            hre.ethers.constants.AddressZero,
+            hre.ethers.constants.AddressZero,
+            hre.ethers.constants.AddressZero,
+            deployer.address,
+        ];
+        console.log(`Deploying BatchConversionPayments to zkSync ...`);
+        yield (0, utils_zk_1.deployContract)('BatchConversionPayments', constructorArguments);
+    });
+}
+exports.default = default_1;
+//# sourceMappingURL=deploy-zk-batch-contracts.js.map

package/dist/deploy/deploy-zk-batch-contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-zk-batch-contracts.js","sourceRoot":"","sources":["../../deploy/deploy-zk-batch-contracts.ts"],"names":[],"mappings":";;;AAAA,oCAA6E;AAC7E,yCAA4C;AAC5C,qDAA+B;AAG/B;;;;GAIG;AACH;;QACE,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACjD,MAAM,oBAAoB,GAAG;YAC3B,2BAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,IAAkC,CAAC;YAChF,8BAAwB,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,IAAkC,CAAC;YACnF,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW;YAChC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW;YAChC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW;YAChC,QAAQ,CAAC,OAAO;SACjB,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;QAC/D,MAAM,IAAA,yBAAc,EAAC,yBAAyB,EAAE,oBAAoB,CAAC,CAAC;IACxE,CAAC;CAAA;AAZD,4BAYC"}

package/dist/deploy/deploy-zk-proxy-contracts.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Deploys Proxy contracts to zkSync network.
+ * This script is supposed to be run with the deploy-zksync plugin
+ * check zkSync section in smart-contracts/README file
+ */
+export default function (): Promise<void>;
+//# sourceMappingURL=deploy-zk-proxy-contracts.d.ts.map

package/dist/deploy/deploy-zk-proxy-contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-zk-proxy-contracts.d.ts","sourceRoot":"","sources":["../../deploy/deploy-zk-proxy-contracts.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,0CAQC"}

package/dist/deploy/deploy-zk-proxy-contracts.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const utils_zk_1 = require("./utils-zk");
+/**
+ * Deploys Proxy contracts to zkSync network.
+ * This script is supposed to be run with the deploy-zksync plugin
+ * check zkSync section in smart-contracts/README file
+ */
+function default_1() {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const deployList = ['ERC20FeeProxy', 'EthereumFeeProxy'];
+        for (let index = 0; index < deployList.length; index++) {
+            const contractName = deployList[index];
+            console.log(`Deploying ${contractName} to zkSync ...`);
+            yield (0, utils_zk_1.deployContract)(contractName, []);
+        }
+    });
+}
+exports.default = default_1;
+//# sourceMappingURL=deploy-zk-proxy-contracts.js.map

package/dist/deploy/deploy-zk-proxy-contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy-zk-proxy-contracts.js","sourceRoot":"","sources":["../../deploy/deploy-zk-proxy-contracts.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAE5C;;;;GAIG;AACH;;QACE,MAAM,UAAU,GAAa,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;QAEnE,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACtD,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,aAAa,YAAY,gBAAgB,CAAC,CAAC;YACvD,MAAM,IAAA,yBAAc,EAAC,YAAY,EAAE,EAAE,CAAC,CAAC;SACxC;IACH,CAAC;CAAA;AARD,4BAQC"}

package/dist/deploy/utils-zk.d.ts

@@ -0,0 +1,32 @@
+import { Provider, Wallet, Contract } from 'zksync-web3';
+import { BigNumberish } from 'ethers';
+export declare const getProvider: () => Provider;
+export declare const getWallet: (privateKey?: string) => Wallet;
+export declare const verifyEnoughBalance: (wallet: Wallet, amount: BigNumberish) => Promise<void>;
+/**
+ * @param {string} data.contract The contract's path and name. E.g., "contracts/Greeter.sol:Greeter"
+ */
+export declare const verifyContract: (data: {
+    address: string;
+    contract: string;
+    constructorArguments: string | [];
+    bytecode: string;
+}) => Promise<number>;
+type DeployContractOptions = {
+    /**
+     * If true, the deployment process will not print any logs
+     */
+    silent?: boolean;
+    /**
+     * If true, the contract will not be verified on Block Explorer
+     */
+    noVerify?: boolean;
+    /**
+     * If specified, the contract will be deployed using this wallet
+     */
+    wallet?: Wallet;
+};
+export declare const verifyContractByName: (contractArtifactName: string, contractAddress: string) => Promise<void>;
+export declare const deployContract: (contractArtifactName: string, constructorArguments?: any[], options?: DeployContractOptions) => Promise<Contract>;
+export {};
+//# sourceMappingURL=utils-zk.d.ts.map

package/dist/deploy/utils-zk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils-zk.d.ts","sourceRoot":"","sources":["../../deploy/utils-zk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAIzD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAiBtC,eAAO,MAAM,WAAW,gBASvB,CAAC;AAEF,eAAO,MAAM,SAAS,gBAAiB,MAAM,KAAG,MAY/C,CAAC;AAEF,eAAO,MAAM,mBAAmB,WAAkB,MAAM,UAAU,YAAY,kBAO7E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,SAAgB;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,EAAE,MAAM,GAAG,EAAE,CAAC;IAClC,QAAQ,EAAE,MAAM,CAAC;CAClB,oBAMA,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,oBAAoB,yBACT,MAAM,mBACX,MAAM,kBA4BxB,CAAC;AAEF,eAAO,MAAM,cAAc,yBACH,MAAM,yBACL,GAAG,EAAE,YAClB,qBAAqB,KAC9B,QAAQ,QAAQ,CAiDlB,CAAC"}

package/dist/deploy/utils-zk.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deployContract = exports.verifyContractByName = exports.verifyContract = exports.verifyEnoughBalance = exports.getWallet = exports.getProvider = void 0;
+const tslib_1 = require("tslib");
+const zksync_web3_1 = require("zksync-web3");
+const hre = tslib_1.__importStar(require("hardhat"));
+const hardhat_zksync_deploy_1 = require("@matterlabs/hardhat-zksync-deploy");
+const utils_1 = require("ethers/lib/utils");
+const dotenv_1 = require("dotenv");
+const utils_2 = require("@requestnetwork/utils");
+(0, dotenv_1.config)();
+const accounts = process.env.DEPLOYMENT_PRIVATE_KEY
+    ? [process.env.DEPLOYMENT_PRIVATE_KEY]
+    : process.env.DEPLOYER_MASTER_KEY
+        ? [process.env.DEPLOYER_MASTER_KEY]
+        : process.env.ADMIN_PRIVATE_KEY
+            ? [process.env.ADMIN_PRIVATE_KEY]
+            : undefined;
+const WALLET_PRIVATE_KEY = (accounts || [])[0];
+const getProvider = () => {
+    const rpcUrl = utils_2.networkRpcs[hre.network.name];
+    if (!rpcUrl)
+        throw `⛔️ RPC URL wasn't found in "${hre.network.name}"! Please add a "url" field to the network config in hardhat.config.ts`;
+    // Initialize zkSync Provider
+    const provider = new zksync_web3_1.Provider(rpcUrl);
+    return provider;
+};
+exports.getProvider = getProvider;
+const getWallet = (privateKey) => {
+    if (!privateKey) {
+        // Get wallet private key from .env file
+        if (!WALLET_PRIVATE_KEY)
+            throw "⛔️ Wallet private key wasn't found in .env file!";
+    }
+    const provider = (0, exports.getProvider)();
+    // Initialize zkSync Wallet
+    const wallet = new zksync_web3_1.Wallet(privateKey !== null && privateKey !== void 0 ? privateKey : WALLET_PRIVATE_KEY, provider);
+    return wallet;
+};
+exports.getWallet = getWallet;
+const verifyEnoughBalance = (wallet, amount) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    // Check if the wallet has enough balance
+    const balance = yield wallet.getBalance();
+    if (balance.lt(amount))
+        throw `⛔️ Wallet balance is too low! Required ${(0, utils_1.formatEther)(amount)} ETH, but current ${wallet.address} balance is ${(0, utils_1.formatEther)(balance)} ETH`;
+});
+exports.verifyEnoughBalance = verifyEnoughBalance;
+/**
+ * @param {string} data.contract The contract's path and name. E.g., "contracts/Greeter.sol:Greeter"
+ */
+const verifyContract = (data) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const verificationRequestId = yield hre.run('verify:verify', Object.assign(Object.assign({}, data), { noCompile: true }));
+    return verificationRequestId;
+});
+exports.verifyContract = verifyContract;
+const verifyContractByName = (contractArtifactName, contractAddress) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const wallet = (0, exports.getWallet)();
+    const deployer = new hardhat_zksync_deploy_1.Deployer(hre, wallet);
+    const artifact = yield deployer.loadArtifact(contractArtifactName).catch((error) => {
+        var _a;
+        if ((_a = error === null || error === void 0 ? void 0 : error.message) === null || _a === void 0 ? void 0 : _a.includes(`Artifact for contract "${contractArtifactName}" not found.`)) {
+            console.error(error.message);
+            throw `⛔️ Please make sure you have compiled your contracts or specified the correct contract name!`;
+        }
+        else {
+            throw error;
+        }
+    });
+    const fullContractSource = `${artifact.sourceName}:${artifact.contractName}`;
+    // Display contract deployment info
+    console.log(`\n"${artifact.contractName}" was successfully deployed:`);
+    console.log(` - Contract address: ${contractAddress}`);
+    console.log(` - Contract source: ${fullContractSource}`);
+    console.log(`Requesting contract verification...`);
+    yield (0, exports.verifyContract)({
+        address: contractAddress,
+        contract: fullContractSource,
+        constructorArguments: [],
+        bytecode: artifact.bytecode,
+    });
+});
+exports.verifyContractByName = verifyContractByName;
+const deployContract = (contractArtifactName, constructorArguments, options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const log = (message) => {
+        if (!(options === null || options === void 0 ? void 0 : options.silent))
+            console.log(message);
+    };
+    log(`\nStarting deployment process of "${contractArtifactName}"...`);
+    const wallet = (_a = options === null || options === void 0 ? void 0 : options.wallet) !== null && _a !== void 0 ? _a : (0, exports.getWallet)();
+    const deployer = new hardhat_zksync_deploy_1.Deployer(hre, wallet);
+    const artifact = yield deployer.loadArtifact(contractArtifactName).catch((error) => {
+        var _a;
+        if ((_a = error === null || error === void 0 ? void 0 : error.message) === null || _a === void 0 ? void 0 : _a.includes(`Artifact for contract "${contractArtifactName}" not found.`)) {
+            console.error(error.message);
+            throw `⛔️ Please make sure you have compiled your contracts or specified the correct contract name!`;
+        }
+        else {
+            throw error;
+        }
+    });
+    // Estimate contract deployment fee
+    const deploymentFee = yield deployer.estimateDeployFee(artifact, constructorArguments || []);
+    log(`Estimated deployment cost: ${(0, utils_1.formatEther)(deploymentFee)} ETH`);
+    // Check if the wallet has enough balance
+    yield (0, exports.verifyEnoughBalance)(wallet, deploymentFee);
+    // Deploy the contract to zkSync
+    const contract = yield deployer.deploy(artifact, constructorArguments);
+    const constructorArgs = contract.interface.encodeDeploy(constructorArguments);
+    const fullContractSource = `${artifact.sourceName}:${artifact.contractName}`;
+    // Display contract deployment info
+    log(`\n"${artifact.contractName}" was successfully deployed:`);
+    log(` - Contract address: ${contract.address}`);
+    log(` - Contract source: ${fullContractSource}`);
+    log(` - Encoded constructor arguments: ${constructorArgs}\n`);
+    if (!(options === null || options === void 0 ? void 0 : options.noVerify) && hre.network.config.verifyURL) {
+        log(`Requesting contract verification...`);
+        yield (0, exports.verifyContract)({
+            address: contract.address,
+            contract: fullContractSource,
+            constructorArguments: constructorArgs,
+            bytecode: artifact.bytecode,
+        });
+    }
+    return contract;
+});
+exports.deployContract = deployContract;
+//# sourceMappingURL=utils-zk.js.map

package/dist/deploy/utils-zk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils-zk.js","sourceRoot":"","sources":["../../deploy/utils-zk.ts"],"names":[],"mappings":";;;;AAAA,6CAAyD;AACzD,qDAA+B;AAC/B,6EAA6D;AAC7D,4CAA+C;AAG/C,mCAAgC;AAChC,iDAAoD;AAEpD,IAAA,eAAM,GAAE,CAAC;AAET,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,sBAAsB;IACjD,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;IACtC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB;QACjC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACnC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB;YAC/B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;YACjC,CAAC,CAAC,SAAS,CAAC;AAEd,MAAM,kBAAkB,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAExC,MAAM,WAAW,GAAG,GAAG,EAAE;IAC9B,MAAM,MAAM,GAAG,mBAAW,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM;QACT,MAAM,+BAA+B,GAAG,CAAC,OAAO,CAAC,IAAI,wEAAwE,CAAC;IAEhI,6BAA6B;IAC7B,MAAM,QAAQ,GAAG,IAAI,sBAAQ,CAAC,MAAM,CAAC,CAAC;IAEtC,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AATW,QAAA,WAAW,eAStB;AAEK,MAAM,SAAS,GAAG,CAAC,UAAmB,EAAU,EAAE;IACvD,IAAI,CAAC,UAAU,EAAE;QACf,wCAAwC;QACxC,IAAI,CAAC,kBAAkB;YAAE,MAAM,kDAAkD,CAAC;KACnF;IAED,MAAM,QAAQ,GAAG,IAAA,mBAAW,GAAE,CAAC;IAE/B,2BAA2B;IAC3B,MAAM,MAAM,GAAG,IAAI,oBAAM,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,kBAAmB,EAAE,QAAQ,CAAC,CAAC;IAEvE,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAZW,QAAA,SAAS,aAYpB;AAEK,MAAM,mBAAmB,GAAG,CAAO,MAAc,EAAE,MAAoB,EAAE,EAAE;IAChF,yCAAyC;IACzC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;IAC1C,IAAI,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC;QACpB,MAAM,0CAA0C,IAAA,mBAAW,EAAC,MAAM,CAAC,qBACjE,MAAM,CAAC,OACT,eAAe,IAAA,mBAAW,EAAC,OAAO,CAAC,MAAM,CAAC;AAC9C,CAAC,CAAA,CAAC;AAPW,QAAA,mBAAmB,uBAO9B;AAEF;;GAEG;AACI,MAAM,cAAc,GAAG,CAAO,IAKpC,EAAE,EAAE;IACH,MAAM,qBAAqB,GAAW,MAAM,GAAG,CAAC,GAAG,CAAC,eAAe,kCAC9D,IAAI,KACP,SAAS,EAAE,IAAI,IACf,CAAC;IACH,OAAO,qBAAqB,CAAC;AAC/B,CAAC,CAAA,CAAC;AAXW,QAAA,cAAc,kBAWzB;AAiBK,MAAM,oBAAoB,GAAG,CAClC,oBAA4B,EAC5B,eAAuB,EACvB,EAAE;IACF,MAAM,MAAM,GAAG,IAAA,iBAAS,GAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,IAAI,gCAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAE3C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;;QACjF,IAAI,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,0CAAE,QAAQ,CAAC,0BAA0B,oBAAoB,cAAc,CAAC,EAAE;YAC1F,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,MAAM,8FAA8F,CAAC;SACtG;aAAM;YACL,MAAM,KAAK,CAAC;SACb;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,kBAAkB,GAAG,GAAG,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;IAE7E,mCAAmC;IACnC,OAAO,CAAC,GAAG,CAAC,MAAM,QAAQ,CAAC,YAAY,8BAA8B,CAAC,CAAC;IACvE,OAAO,CAAC,GAAG,CAAC,wBAAwB,eAAe,EAAE,CAAC,CAAC;IACvD,OAAO,CAAC,GAAG,CAAC,uBAAuB,kBAAkB,EAAE,CAAC,CAAC;IAEzD,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;IACnD,MAAM,IAAA,sBAAc,EAAC;QACnB,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,kBAAkB;QAC5B,oBAAoB,EAAE,EAAE;QACxB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;KAC5B,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AA9BW,QAAA,oBAAoB,wBA8B/B;AAEK,MAAM,cAAc,GAAG,CAC5B,oBAA4B,EAC5B,oBAA4B,EAC5B,OAA+B,EACZ,EAAE;;IACrB,MAAM,GAAG,GAAG,CAAC,OAAe,EAAE,EAAE;QAC9B,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAA;YAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,GAAG,CAAC,qCAAqC,oBAAoB,MAAM,CAAC,CAAC;IAErE,MAAM,MAAM,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,IAAA,iBAAS,GAAE,CAAC;IAC9C,MAAM,QAAQ,GAAG,IAAI,gCAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAE3C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;;QACjF,IAAI,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,0CAAE,QAAQ,CAAC,0BAA0B,oBAAoB,cAAc,CAAC,EAAE;YAC1F,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,MAAM,8FAA8F,CAAC;SACtG;aAAM;YACL,MAAM,KAAK,CAAC;SACb;IACH,CAAC,CAAC,CAAC;IAEH,mCAAmC;IACnC,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,EAAE,oBAAoB,IAAI,EAAE,CAAC,CAAC;IAC7F,GAAG,CAAC,8BAA8B,IAAA,mBAAW,EAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAEpE,yCAAyC;IACzC,MAAM,IAAA,2BAAmB,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAEjD,gCAAgC;IAChC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IAEvE,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAC9E,MAAM,kBAAkB,GAAG,GAAG,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;IAE7E,mCAAmC;IACnC,GAAG,CAAC,MAAM,QAAQ,CAAC,YAAY,8BAA8B,CAAC,CAAC;IAC/D,GAAG,CAAC,wBAAwB,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IAChD,GAAG,CAAC,uBAAuB,kBAAkB,EAAE,CAAC,CAAC;IACjD,GAAG,CAAC,qCAAqC,eAAe,IAAI,CAAC,CAAC;IAE9D,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAA,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE;QACtD,GAAG,CAAC,qCAAqC,CAAC,CAAC;QAC3C,MAAM,IAAA,sBAAc,EAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,QAAQ,EAAE,kBAAkB;YAC5B,oBAAoB,EAAE,eAAe;YACrC,QAAQ,EAAE,QAAQ,CAAC,QAAQ;SAC5B,CAAC,CAAC;KACJ;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAA,CAAC;AArDW,QAAA,cAAc,kBAqDzB"}