Class DARC

darc-js/src/DARC/DARC.ts:32–137

 * The DARC class is used to interact with the DARC contract.
 */
export class DARC {
  private darcContract: Contract;
  private darcAddress: string;
  private darcVersion: darcBinary.DARC_VERSION;
  private wallet: ethers.Wallet | undefined;
  private provider: ethers.providers.Provider | undefined;

  /**
   * The constructor of the DARC class.
   * @param param: the init param including the address, version, wallet and/or provider.
   */
  constructor(param: InitParam) {
    const { address, version, wallet, provider } = param;
    this.darcAddress = address;
    this.darcVersion = version;
    this.wallet = wallet;
    this.provider = provider;
    if (wallet !== undefined) {
      this.darcContract = new ethers.Contract(address, darcBinary.darcBinary(version).abi, wallet);
    } else if (provider !== undefined) {
      this.darcContract = new ethers.Contract(address, darcBinary.darcBinary(version).abi, provider);
    } else {
      throw new Error("Either wallet or provider should be provided.");
    }
  } 

  /**
   * Run the program on the DARC contract.
   * @param program: the program to be run.
   */
  async entrance(program:any){
    if (this.wallet === undefined){
      throw new Error("Wallet is not provided for this DARC instance.");
    }
    await this.darcContract.entrance(program);
  }

  /**
   * Below are all DARC's dashboard functions, read parameters from the DARC contract.
   */
  async getTokenOwners(tokenClass: BigInt): Promise<string[]> {
    return await this.darcContract.getTokenOwners(tokenClass);
  }

  async getTokenInfo(tokenClass: BigInt): Promise<TokenInfo> {
    const result = await this.darcContract.getTokenInfo(tokenClass);
    //console.log("result: " + JSON.stringify(result));
    const {0: returnVotingWeight, 1: returnDividendWeight, 2: returnTokenInfo, 3: returnTotalSupply} = result;

    let returnStruct: TokenInfo = {
      votingWeight: returnVotingWeight,
      dividendWeight: returnDividendWeight,
      tokenInfo: returnTokenInfo,
      totalSupply: returnTotalSupply,
    };

    return returnStruct;
  }