feat: return precalculated address from deploy

starknet-io · Dec 6, 2022 · 5e40224 · 5e40224
1 parent 9d85e25
commit 5e40224
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 22 deletions.
diff --git a/__tests__/account.test.ts b/__tests__/account.test.ts
@@ -2,6 +2,7 @@ import { isBN } from 'bn.js';
 
 import typedDataExample from '../__mocks__/typedDataExample.json';
 import { Account, Contract, Provider, number, stark } from '../src';
+import { parseUDCEvent } from '../src/utils/events';
 import { feeTransactionVersion } from '../src/utils/hash';
 import { hexToDecimalString, toBN } from '../src/utils/number';
 import { encodeShortString } from '../src/utils/shortString';
@@ -265,7 +266,7 @@ describe('deploy and test Wallet', () => {
       expect(deployResponse.salt).toBeDefined();
     });
 
-    test('UDC Deploy', async () => {
+    test('UDC Deploy unique', async () => {
       const salt = randomAddress(); // use random salt
 
       const deployment = await account.deploy({
@@ -276,12 +277,35 @@ describe('deploy and test Wallet', () => {
           account.address,
         ],
         salt,
-        unique: true, // Using true here so as not to clash with normal erc20 deploy in account and provider test
+        unique: true,
       });
+      expect(deployment).toHaveProperty('transaction_hash');
+
+      // check pre-calculated address
+      const txReceipt = await provider.waitForTransaction(deployment.transaction_hash);
+      const udcEvent = parseUDCEvent(txReceipt);
+      expect(deployment.contract_address).toBe(udcEvent.contract_address);
+    });
 
-      await provider.waitForTransaction(deployment.transaction_hash);
+    test('UDC Deploy non-unique', async () => {
+      const salt = randomAddress(); // use random salt
 
+      const deployment = await account.deploy({
+        classHash: erc20ClassHash,
+        constructorCalldata: [
+          encodeShortString('Token'),
+          encodeShortString('ERC20'),
+          account.address,
+        ],
+        salt,
+        unique: false,
+      });
       expect(deployment).toHaveProperty('transaction_hash');
+
+      // check pre-calculated address
+      const txReceipt = await provider.waitForTransaction(deployment.transaction_hash);
+      const udcEvent = parseUDCEvent(txReceipt);
+      expect(deployment.contract_address).toBe(udcEvent.contract_address);
     });
   });
 });
diff --git a/src/account/default.ts b/src/account/default.ts
@@ -22,13 +22,15 @@ import {
   InvocationsSignerDetails,
   InvokeFunctionResponse,
   KeyPair,
+  MultiDeployContractResponse,
   Signature,
   UniversalDeployerContractPayload,
 } from '../types';
 import { parseUDCEvent } from '../utils/events';
 import {
   calculateContractAddressFromHash,
   feeTransactionVersion,
+  pedersen,
   transactionVersion,
 } from '../utils/hash';
 import { BigNumberish, hexToDecimalString, toBN, toCairoBool } from '../utils/number';
@@ -329,29 +331,39 @@ export class Account extends Provider implements AccountInterface {
       additionalCalls = [],
     }: UniversalDeployerContractPayload,
     invocationsDetails: InvocationsDetails = {}
-  ): Promise<InvokeFunctionResponse> {
+  ): Promise<DeployContractResponse | MultiDeployContractResponse> {
     const compiledConstructorCallData = compileCalldata(constructorCalldata);
     const callsArray = Array.isArray(additionalCalls) ? additionalCalls : [additionalCalls];
     const deploySalt = salt ?? randomAddress();
 
-    return this.execute(
-      [
-        {
-          contractAddress: UDC.ADDRESS,
-          entrypoint: UDC.ENTRYPOINT,
-          calldata: [
-            classHash,
-            deploySalt,
-            toCairoBool(unique),
-            compiledConstructorCallData.length,
-            ...compiledConstructorCallData,
-          ],
-        },
-        ...callsArray,
-      ],
-      undefined,
-      invocationsDetails
+    const calls = [
+      {
+        contractAddress: UDC.ADDRESS,
+        entrypoint: UDC.ENTRYPOINT,
+        calldata: [
+          classHash,
+          deploySalt,
+          toCairoBool(unique),
+          compiledConstructorCallData.length,
+          ...compiledConstructorCallData,
+        ],
+      },
+      ...callsArray,
+    ];
+
+    const invokeResponse = await this.execute(calls, undefined, invocationsDetails);
+
+    const calculated_address = calculateContractAddressFromHash(
+      unique ? pedersen([this.address, deploySalt]) : deploySalt,
+      classHash,
+      compiledConstructorCallData,
+      unique ? UDC.ADDRESS : 0
     );
+
+    return {
+      ...invokeResponse,
+      contract_address: calculated_address,
+    };
   }
 
   public async deployContract(
@@ -385,7 +397,6 @@ export class Account extends Provider implements AccountInterface {
     return { declare: { ...declare, class_hash: classHash }, deploy };
   }
 
-
   public async deployAccount(
     {
       classHash,

diff --git a/src/types/account.ts b/src/types/account.ts
@@ -18,6 +18,11 @@ export interface DeployContractResponse {
   transaction_hash: string;
 }
 
+export interface MultiDeployContractResponse {
+  contract_address: Array<string>;
+  transaction_hash: string;
+}
+
 export interface DeployContractUDCResponse extends DeployContractResponse {
   address: string;
   deployer: string;