Merge pull request #402 from alephium/deploy-contract-template

Add method for deploying contract template

artifacts/ts/Add.ts

@@ -161,10 +161,6 @@ class Factory extends ContractFactory<AddInstance, AddTypes.Fields> {
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as AddTypes.Fields;
-  }
-
   eventIndex = { Add: 0, Add1: 1, Empty: 2 };
 
   at(address: string): AddInstance {

artifacts/ts/DeprecatedNFTTest1.ts

@@ -98,10 +98,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as DeprecatedNFTTest1Types.Fields;
-  }
-
   at(address: string): DeprecatedNFTTest1Instance {
     return new DeprecatedNFTTest1Instance(address);
   }

artifacts/ts/DeprecatedNFTTest2.ts

@@ -106,10 +106,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as DeprecatedNFTTest2Types.Fields;
-  }
-
   at(address: string): DeprecatedNFTTest2Instance {
     return new DeprecatedNFTTest2Instance(address);
   }

artifacts/ts/DeprecatedNFTTest3.ts

@@ -106,10 +106,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as DeprecatedNFTTest3Types.Fields;
-  }
-
   at(address: string): DeprecatedNFTTest3Instance {
     return new DeprecatedNFTTest3Instance(address);
   }

artifacts/ts/DeprecatedNFTTest4.ts

@@ -106,10 +106,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as DeprecatedNFTTest4Types.Fields;
-  }
-
   at(address: string): DeprecatedNFTTest4Instance {
     return new DeprecatedNFTTest4Instance(address);
   }

artifacts/ts/DeprecatedNFTTest5.ts

@@ -106,10 +106,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as DeprecatedNFTTest5Types.Fields;
-  }
-
   at(address: string): DeprecatedNFTTest5Instance {
     return new DeprecatedNFTTest5Instance(address);
   }

artifacts/ts/DeprecatedNFTTest6.ts

@@ -106,10 +106,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as DeprecatedNFTTest6Types.Fields;
-  }
-
   at(address: string): DeprecatedNFTTest6Instance {
     return new DeprecatedNFTTest6Instance(address);
   }

artifacts/ts/DeprecatedNFTTest7.ts

@@ -106,10 +106,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as DeprecatedNFTTest7Types.Fields;
-  }
-
   at(address: string): DeprecatedNFTTest7Instance {
     return new DeprecatedNFTTest7Instance(address);
   }

artifacts/ts/FakeTokenTest.ts

@@ -129,10 +129,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as FakeTokenTestTypes.Fields;
-  }
-
   at(address: string): FakeTokenTestInstance {
     return new FakeTokenTestInstance(address);
   }

artifacts/ts/Greeter.ts

@@ -102,10 +102,6 @@ class Factory extends ContractFactory<GreeterInstance, GreeterTypes.Fields> {
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as GreeterTypes.Fields;
-  }
-
   at(address: string): GreeterInstance {
     return new GreeterInstance(address);
   }

artifacts/ts/NFTCollectionTest.ts

@@ -134,10 +134,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as NFTCollectionTestTypes.Fields;
-  }
-
   at(address: string): NFTCollectionTestInstance {
     return new NFTCollectionTestInstance(address);
   }

artifacts/ts/NFTCollectionWithRoyaltyTest.ts

@@ -169,10 +169,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as NFTCollectionWithRoyaltyTestTypes.Fields;
-  }
-
   at(address: string): NFTCollectionWithRoyaltyTestInstance {
     return new NFTCollectionWithRoyaltyTestInstance(address);
   }

artifacts/ts/NFTTest.ts

@@ -104,10 +104,6 @@ class Factory extends ContractFactory<NFTTestInstance, NFTTestTypes.Fields> {
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as NFTTestTypes.Fields;
-  }
-
   at(address: string): NFTTestInstance {
     return new NFTTestInstance(address);
   }

artifacts/ts/NFTTestStd.ts

@@ -115,10 +115,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as NFTTestStdTypes.Fields;
-  }
-
   at(address: string): NFTTestStdInstance {
     return new NFTTestStdInstance(address);
   }

artifacts/ts/OwnerOnly.ts

@@ -97,10 +97,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as OwnerOnlyTypes.Fields;
-  }
-
   at(address: string): OwnerOnlyInstance {
     return new OwnerOnlyInstance(address);
   }

artifacts/ts/Sub.ts

@@ -96,10 +96,6 @@ class Factory extends ContractFactory<SubInstance, SubTypes.Fields> {
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as SubTypes.Fields;
-  }
-
   eventIndex = { Sub: 0 };
 
   at(address: string): SubInstance {

artifacts/ts/TokenTest.ts

@@ -124,10 +124,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as TokenTestTypes.Fields;
-  }
-
   at(address: string): TokenTestInstance {
     return new TokenTestInstance(address);
   }

artifacts/ts/TokenTestStd.ts

@@ -132,10 +132,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as TokenTestStdTypes.Fields;
-  }
-
   at(address: string): TokenTestStdInstance {
     return new TokenTestStdInstance(address);
   }

artifacts/ts/UserAccount.ts

@@ -118,10 +118,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as UserAccountTypes.Fields;
-  }
-
   at(address: string): UserAccountInstance {
     return new UserAccountInstance(address);
   }

artifacts/ts/Warnings.ts

@@ -95,10 +95,6 @@ class Factory extends ContractFactory<WarningsInstance, WarningsTypes.Fields> {
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as WarningsTypes.Fields;
-  }
-
   consts = { C: BigInt("0") };
 
   at(address: string): WarningsInstance {

artifacts/ts/WrongNFTTest.ts

@@ -107,10 +107,6 @@ class Factory extends ContractFactory<
     );
   }
 
-  getInitialFieldsWithDefaultValues() {
-    return this.contract.getInitialFieldsWithDefaultValues() as WrongNFTTestTypes.Fields;
-  }
-
   at(address: string): WrongNFTTestInstance {
     return new WrongNFTTestInstance(address);
   }

packages/cli/src/codegen.ts

@@ -307,18 +307,6 @@ function genEncodeFieldsFunc(contract: Contract): string {
   `
 }
 
-function genGetInitialFieldsWithDefaultValues(contract: Contract): string {
-  const fieldsSig = getContractFields(contract)
-  if (fieldsSig.names.length === 0) {
-    return ''
-  }
-  return `
-    getInitialFieldsWithDefaultValues() {
-      return this.contract.getInitialFieldsWithDefaultValues() as ${contract.name}Types.Fields
-    }
-  `
-}
-
 function genContractStateType(contract: Contract): string {
   if (contract.fieldsSig.names.length === 0) {
     return `export type State = Omit<ContractState<any>, 'fields'>`
@@ -526,7 +514,6 @@ function genContract(contract: Contract, artifactRelativePath: string): string {
 
     class Factory extends ContractFactory<${contract.name}Instance, ${contractFieldType(contract.name, fieldsSig)}> {
       ${genEncodeFieldsFunc(contract)}
-      ${genGetInitialFieldsWithDefaultValues(contract)}
       ${genEventIndex(contract)}
       ${genLocalConsts(contract)}
       ${genAttach(getInstanceName(contract))}

packages/cli/src/deployment.ts

@@ -359,7 +359,7 @@ function createDeployer<Settings = unknown>(
   const deployedContracts: string[] = []
   const executedScripts: string[] = []
 
-  const deployContract = async <T extends ContractInstance, P extends Fields>(
+  const deployContractInner = async <T extends ContractInstance, P extends Fields>(
     contractFactory: ContractFactory<T, P>,
     params: DeployContractParams<P>,
     taskTag?: string
@@ -416,6 +416,24 @@ function createDeployer<Settings = unknown>(
     return deployResult
   }
 
+  const deployContract = async <T extends ContractInstance, P extends Fields>(
+    contractFactory: ContractFactory<T, P>,
+    params: DeployContractParams<P>,
+    taskTag?: string
+  ): Promise<DeployContractResult<T>> => {
+    return deployContractInner(contractFactory, params, taskTag)
+  }
+
+  const deployContractTemplate = async <T extends ContractInstance, P extends Fields>(
+    contractFactory: ContractFactory<T, P>,
+    taskTag?: string
+  ): Promise<DeployContractResult<T>> => {
+    const params: DeployContractParams<P> = {
+      initialFields: contractFactory.contract.getInitialFieldsWithDefaultValues() as P
+    }
+    return deployContractInner(contractFactory, params, taskTag)
+  }
+
   const runScript = async <P extends Fields>(
     executableScript: ExecutableScript<P>,
     params: ExecuteScriptParams<P>,
@@ -490,6 +508,7 @@ function createDeployer<Settings = unknown>(
     provider: web3.getCurrentNodeProvider(),
     account: account,
     deployContract: deployContract,
+    deployContractTemplate: deployContractTemplate,
     runScript: runScript,
     getDeployContractResult: getDeployContractResult,
     getRunScriptResult: getRunScriptResult,

packages/cli/src/types.ts

@@ -135,6 +135,11 @@ export interface Deployer {
     taskTag?: string
   ): Promise<DeployContractResult<T>>
 
+  deployContractTemplate<T extends ContractInstance, P extends Fields>(
+    constractFactory: ContractFactory<T, P>,
+    taskTag?: string
+  ): Promise<DeployContractResult<T>>
+
   runScript<P extends Fields>(
     executableScript: ExecutableScript<P>,
     params: ExecuteScriptParams<P>,

packages/web3/src/contract/contract.ts

@@ -1010,6 +1010,12 @@ export abstract class ContractFactory<I extends ContractInstance, F extends Fiel
     }
   }
 
+  async deployTemplate(signer: SignerProvider): Promise<DeployContractResult<I>> {
+    return this.deploy(signer, {
+      initialFields: this.contract.getInitialFieldsWithDefaultValues() as F
+    })
+  }
+
   // This is used for testing contract functions
   stateForTest(initFields: F, asset?: Asset, address?: string): ContractState<F> {
     const newAsset = {