{"id":28380708,"url":"https://github.com/0xsequence/solidity-deployer","last_synced_at":"2026-04-02T01:06:59.269Z","repository":{"id":212172123,"uuid":"633643878","full_name":"0xsequence/solidity-deployer","owner":"0xsequence","description":"Simplifies the process of deploying, managing, and verifying Solidity smart contracts","archived":false,"fork":false,"pushed_at":"2026-02-13T16:30:08.000Z","size":6473,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":14,"default_branch":"main","last_synced_at":"2026-02-28T18:52:39.522Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0xsequence.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-28T00:59:50.000Z","updated_at":"2025-06-04T21:59:36.000Z","dependencies_parsed_at":"2025-04-16T23:53:31.861Z","dependency_job_id":"cc00fefc-f73a-40d4-b9ae-6b6f5a2f5056","html_url":"https://github.com/0xsequence/solidity-deployer","commit_stats":null,"previous_names":["0xsequence/solidity-deployer"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/0xsequence/solidity-deployer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xsequence%2Fsolidity-deployer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xsequence%2Fsolidity-deployer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xsequence%2Fsolidity-deployer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xsequence%2Fsolidity-deployer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0xsequence","download_url":"https://codeload.github.com/0xsequence/solidity-deployer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xsequence%2Fsolidity-deployer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31293637,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T01:05:07.454Z","status":"ssl_error","status_checked_at":"2026-04-02T00:56:46.496Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-30T03:09:06.094Z","updated_at":"2026-04-02T01:06:59.261Z","avatar_url":"https://github.com/0xsequence.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Solidity Deployer\n\nSolidity Deployer is a TypeScript project that simplifies the process of deploying, managing, and verifying Solidity smart contracts. It streamlines the deployment process by providing a robust workflow for deploying contracts, deploying guard wallets, recovering funds, and verifying contracts through Etherscan and Tenderly.\n\n## Key Features\n\n- Deploying Guard Wallets\n- Deploying Contracts\n- Verifying Contracts on Tenderly and Etherscan\n- Recovering Funds\n\n## Installation\n\nTo use Solidity Deployer in your project, you need to have Node.js and Yarn installed. You can install the package via Yarn:\n\n```bash\nyarn add solidity-deployer\n```\n\n## Usage\n\n### DeploymentFlow\n\nThe `DeploymentFlow` class is the core of the project, which handles the deployment and management of smart contracts.\n\n#### Constructor\n\n```typescript\nconstructor(tenderly: TenderlyConfiguration | Tenderly, etherscanApiKey: string, signer: Signer, logger?: Logger, deployer?: Deployer)\n```\n\nInitialize a new `DeploymentFlow` instance with the required configuration options for Tenderly, Etherscan, and other necessary parameters.\n\n#### Deploying Guard Wallets\n\n```typescript\ndeployGuards: (moduleAddr: string, guards: string[]) =\u003e Promise\u003cstring[]\u003e\n```\n\nThis method deploys guard wallets for a given module address and a list of image hashes. It returns a promise that resolves to an array of deployed guard wallet addresses.\n\n#### Deploying and Verifying Contracts\n\n```typescript\ndeployAndVerify: \u003cT extends ContractFactory\u003e(\n  friendlyName: string,\n  contract: new (signer: Signer) =\u003e T,\n  verificationRequest: ContractVerificationRequest,\n  deploymentArgs?: Parameters\u003cT['deploy']\u003e[],\n  contractInstance?: BigNumberish,\n  txParams?: providers.TransactionRequest,\n  fundsRecoveryAddr?: string,\n) =\u003e Promise\u003cContract\u003e\n```\n\nThis method deploys and verifies a contract using the provided contract factory and deployment arguments. It also takes a friendly name for the contract, verification request details, and optional transaction parameters and funds recovery address.\n\n#### Recovering Funds\n\n```typescript\nrecoverFunds: (address: string) =\u003e Promise\u003cBigNumber\u003e\n```\n\nThis method helps to recover all funds in the signer and returns them to the specified address. It returns a promise that resolves to the remaining dust in the signer.\n\n## Example\n\n```typescript\nimport { Tenderly } from \"tenderly\";\nimport { Wallet } from \"ethers\";\nimport { DeploymentFlow } from \"solidity-deployer\";\n\nconst tenderlyConfig = {...}; // Your Tenderly configuration\nconst etherscanApiKey = \"your-etherscan-api-key\";\nconst privateKey = \"your-private-key\";\nconst networkName = \"mainnet\";\n\nconst signer = new Wallet(privateKey);\nconst tenderly = new Tenderly(tenderlyConfig);\n\nconst deploymentFlow = new DeploymentFlow(tenderly, etherscanApiKey, signer);\n\nasync function main() {\n  // Deploy and verify a contract\n  const contract = ...; // Your contract factory\n  const verificationRequest = ...; // Contract verification request\n  const deploymentArgs = ...; // Contract deployment arguments\n\n  const deployedContract = await deploymentFlow.deployAndVerify(\"MyContract\", contract, verificationRequest, deploymentArgs);\n  console.log(\"Deployed contract address:\", deployedContract.address);\n\n  // Deploy guards\n  const moduleAddr = deployedContract.address;\n  const guards = [...]; // List of image hashes for each guard wallet\n  const deployedGuardWallets = await deploymentFlow.deployGuards(moduleAddr, guards);\n  console.log(\"Deployed guard wallets:\", deployedGuardWallets);\n\n  // Recover funds\n  const recoveryAddress = \"your-recovery-address\";\n  const remainingDust = await deploymentFlow.recoverFunds(recoveryAddress);\n  console.log(\"Remaining dust in signer:\", remainingDust.toString());\n}\n\nmain()\n  .then(() =\u003e {\n    process.exit(0);\n  })\n  .catch(error =\u003e {\n    console.error(error);\n    process.exit(1);\n  });\n```\n\n## License\n\nThis project is released under the [Apache License 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xsequence%2Fsolidity-deployer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0xsequence%2Fsolidity-deployer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xsequence%2Fsolidity-deployer/lists"}