shareSplit()

/**
   * Split the shares of the Collective Portrait.
   *
   * @remarks
   * Splitting the shares of the Collective Portrait will split the shares of the Collective Portrait by the multiplier.
   * For example, if the multiplier is 2, then the number of shares of the Collective Portrait will be doubled.
   * The multiplier must be greater than 1.
   * The minimum control shares will be updated to be the minimum control shares multiplied by the multiplier.
   *
   * @param {CollectivePortraitName | number} identity - The name of the Collective Portrait that the user would like to split the shares for.
   * @param {number} multiplier - The multiplier to split the shares by.
   * @returns {ethers.ContractTransaction} - The transaction object of the transaction that splits the shares of the Collective Portrait.
   * @beta
   * @async
   */
  shareSplit(
    identity: CollectivePortraitName | number,
    multiplier: number,
  ): Promise<ethers.ContractTransaction> {
    const id =
      typeof identity === 'number' ? identity : this.getTokenIdByName(identity);

    return this.portrait.portraitCollectiveContract.shareSplit(id, multiplier);
  }

Last updated