feat: add support to deployment metadata (#532)

* add support to deployment notes * add metadata field to deployments instead of note
OpenZeppelin · Sep 4, 2024 · 7d969a1 · 7d969a1
1 parent cecac6f
commit 7d969a1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/examples/deploy-contract/index.js b/examples/deploy-contract/index.js
@@ -35,6 +35,11 @@ async function main() {
     licenseType: 'MIT',
     verifySourceCode: true,
     constructorBytecode: AbiCoder.defaultAbiCoder().encode(['uint'], ['5']), // or constructorInputs: [5],
+    metadata: {
+      commitHash: '1234567890abcdef',
+      tag: 'v1.0.0',
+      anyOtherField: 'anyValue',
+    },
   });
 
   const deploymentStatus = await client.deploy.getDeployedContract(deployment.deploymentId);

diff --git a/packages/deploy/src/models/deployment.ts b/packages/deploy/src/models/deployment.ts
@@ -50,11 +50,21 @@ export interface DeployContractRequest {
    * @default undefined
    */
   txOverrides?: TxOverrides;
+  /*
+   * A note to be included in the deployment.
+   */
+  metadata?: DeployMetadata;
 }
 export interface DeployRequestLibraries {
   [k: `${string}:${string}`]: string;
 }
 
+export interface DeployMetadata {
+  commitHash?: string;
+  tag?: string;
+  [k: string]: any;
+}
+
 export interface DeploymentResponse {
   deploymentId: string;
   createdAt: string;