Type alias MultirecipientCollectActionConfig

MultirecipientCollectActionConfig: {
    amount: Erc20Amount;
    collectLimit?: number;
    endsAt?: Date;
    followerOnly: boolean;
    recipients: RecipientWithSplit[];
    referralFee?: number;
    type: MULTIRECIPIENT_COLLECT;
}

Type declaration

  • amount: Erc20Amount

    The collect fee amount.

    Use Amount.erc20 with instances Erc20 to create an instance of this type.

  • Optional collectLimit?: number

    The maximum number of NFT to mint.

    Default Value

    no limit
  • Optional endsAt?: Date

    The date when the collect ends.

    Default Value

    no end date
  • followerOnly: boolean

    Whether only followers can collect.

  • recipients: RecipientWithSplit[]

    The recipients of the collect fee and their split.

  • Optional referralFee?: number

    The referral reward as a percentage.

    This is the maximum referral fee percentage that can be used to reward the referrer. The referrers are determined by the FE app used when this multirecipient collect open action is executed.

    Number between 1-100 with up to 2 decimals of precision (e.g. 10.5 for 10.5%)

    Default Value

    no referral reward
  • type: MULTIRECIPIENT_COLLECT

Settings

Member Visibility

Theme