fix(contract-factory): move more towards ethers.js api

src/contract/contractFactory.ts

@@ -2,28 +2,23 @@ import assert from 'minimalistic-assert';
 
 import { Account } from '../account';
 import { Provider, defaultProvider } from '../provider';
-import { Abi, CompiledContract, GetTransactionResponse, RawCalldata } from '../types';
+import { Abi, CompiledContract, RawCalldata } from '../types';
 import { BigNumberish } from '../utils/number';
 import { Contract } from './default';
 
 export class ContractFactory {
-  address!: string | null;
+  abi: Abi;
 
-  abi!: Abi;
-
-  transaction_hash!: string | null;
-
-  code!: string | null;
+  compiledContract: CompiledContract;
 
   providerOrAccount: Provider | Account;
 
-  compiledContract: CompiledContract;
-
   constructor(
     compiledContract: CompiledContract,
-    providerOrAccount: Provider | Account = defaultProvider
+    providerOrAccount: Provider | Account = defaultProvider,
+    abi: Abi = compiledContract.abi // abi can be different from the deployed contract ie for proxy contracts
   ) {
-    this.abi = compiledContract.abi;
+    this.abi = abi;
     this.compiledContract = compiledContract;
     this.providerOrAccount = providerOrAccount;
   }
@@ -44,41 +39,40 @@ export class ContractFactory {
       constructorCalldata,
       addressSalt,
     });
-    assert(code === 'TRANSACTION_RECEIVED', 'Deployment of the contract failed');
-    this.address = address as string;
-    this.transaction_hash = transaction_hash;
-    this.code = code;
-    return new Contract(this.compiledContract.abi, address as string, this.providerOrAccount);
-  }
+    assert(
+      code === 'TRANSACTION_RECEIVED' && Boolean(address),
+      'Deployment of the contract failed'
+    );
 
-  /**
-   * Attaches current abi and provider or account to the new address
-   *
-   * @param address - Contract address
-   * @returns Contract
-   */
-  attach(address: string): Contract {
-    return ContractFactory.getContract(this.abi, address, this.providerOrAccount);
+    const contractInstance = new Contract(
+      this.compiledContract.abi,
+      address!,
+      this.providerOrAccount
+    );
+    contractInstance.deployTransactionHash = transaction_hash;
+
+    return contractInstance;
   }
 
   /**
-   * Fetch the transaction of the deployment
+   * Attaches to new Provider or Account
    *
-   * @returns Transaction
+   * @param providerOrAccount - new Provider or Account to attach to
    */
-  public async getDeployTransaction(): Promise<GetTransactionResponse> {
-    if (this.transaction_hash) {
-      return this.providerOrAccount.getTransaction(this.transaction_hash);
-    }
-    throw Error('Deployment not initialized yet');
+  connect(providerOrAccount: Provider | Account): ContractFactory {
+    this.providerOrAccount = providerOrAccount;
+    return this;
   }
 
   /**
-   * Instances contract
+   * Attaches current abi and provider or account to the new address
    *
+   * @param address - Contract address
    * @returns Contract
    */
-  static getContract(abi: Abi, address: string, providerOrAccount?: Provider | Account): Contract {
-    return new Contract(abi, address, providerOrAccount);
+  attach(address: string): Contract {
+    return new Contract(this.abi, address, this.providerOrAccount);
   }
+
+  // ethers.js' getDeployTransaction cant be supported as it requires the account or signer to return a signed transaction which is not possible with the current implementation
 }

src/contract/default.ts

@@ -85,6 +85,8 @@ export class Contract implements ContractInterface {
 
   providerOrAccount: Provider | Account;
 
+  deployTransactionHash?: string;
+
   protected readonly abi: Abi;
 
   protected readonly structs: { [name: string]: StructAbi };

src/contract/interface.ts

@@ -13,6 +13,8 @@ export abstract class ContractInterface {
 
   public abstract providerOrAccount: Provider | Account;
 
+  public abstract deployTransactionHash?: string;
+
   readonly functions!: { [name: string]: AsyncContractFunction };
 
   readonly callStatic!: { [name: string]: AsyncContractFunction };