feat: export pubkey and update description of deployment

privacy-scaling-explorations · May 16, 2024 · c782d24 · c782d24
1 parent 7a69aa7
commit c782d24
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 10 deletions.
diff --git a/cli/ts/sdk/index.ts b/cli/ts/sdk/index.ts
@@ -20,7 +20,7 @@ export {
 
 export * from "maci-contracts/typechain-types";
 
-export { VerifyingKey, type IVkObjectParams } from "maci-domainobjs";
+export { VerifyingKey, PubKey, type IVkObjectParams } from "maci-domainobjs";
 
 export type {
   TallyData,

diff --git a/contracts/tasks/helpers/Deployment.ts b/contracts/tasks/helpers/Deployment.ts
@@ -14,8 +14,8 @@ import type { ConfigurableTaskDefinition, HardhatRuntimeEnvironment, TaskArgumen
 import { ContractStorage } from "./ContractStorage";
 import {
   EContracts,
-  IDeployContractArgs,
-  IDeployContractWithLinkedLibrariesArgs,
+  IDeployContractParams,
+  IDeployContractWithLinkedLibrariesParams,
   IDeployParams,
   IDeployStep,
   IDeployStepCatalog,
@@ -309,13 +309,12 @@ export class Deployment {
   /**
    * Deploy contract and return it
    *
-   * @param contractName - contract name
-   * @param signer - signer
+   * @param {IDeployContractParams} params - parameters of deploy contract
    * @param args - constructor arguments
    * @returns deployed contract
    */
   async deployContract<T extends BaseContract>(
-    { name, abi, bytecode, signer }: IDeployContractArgs,
+    { name, abi, bytecode, signer }: IDeployContractParams,
     ...args: unknown[]
   ): Promise<T> {
     const deployer = signer || (await this.getDeployer());
@@ -337,12 +336,12 @@ export class Deployment {
   /**
    * Deploy contract with linked libraries using contract factory
    *
-   * @param contractFactory - ethers contract factory
+   * @param {IDeployContractWithLinkedLibrariesParams} params - parameters of deploy contract with linked libraries
    * @param args - constructor arguments
    * @returns deployed contract
    */
   async deployContractWithLinkedLibraries<T extends BaseContract>(
-    { contractFactory, signer }: IDeployContractWithLinkedLibrariesArgs,
+    { contractFactory, signer }: IDeployContractWithLinkedLibrariesParams,
     ...args: unknown[]
   ): Promise<T> {
     const deployer = signer || (await this.getDeployer());

diff --git a/contracts/tasks/helpers/types.ts b/contracts/tasks/helpers/types.ts
@@ -651,7 +651,7 @@ export type TAbi = string | readonly (string | Fragment | JsonFragment)[];
 /**
  * Interface that represents deploy params
  */
-export interface IDeployContractArgs {
+export interface IDeployContractParams {
   /**
    * Contract name
    */
@@ -676,7 +676,7 @@ export interface IDeployContractArgs {
 /**
  * Interface that represents deploy params
  */
-export interface IDeployContractWithLinkedLibrariesArgs {
+export interface IDeployContractWithLinkedLibrariesParams {
   /**
    * Contract factory
    */