Class TransferPolicyTransaction

constructor

• new TransferPolicyTransaction(__namedParameters): TransferPolicyTransaction

• Parameters

  • __namedParameters: TransferPolicyTransactionParams

  Returns TransferPolicyTransaction

kioskClient

Optionalpolicy

OptionalpolicyCap

transaction

Optionaltype

addFloorPriceRule

• addFloorPriceRule(minPrice): TransferPolicyTransaction

• A function to add the floor price rule to a transfer policy.

  Parameters

  • minPrice: string | bigint

    The minimum price in MIST.

  Returns TransferPolicyTransaction

addLockRule

• addLockRule(): TransferPolicyTransaction

• Adds the Kiosk Lock Rule to the Transfer Policy. This Rule forces buyer to lock the item in the kiosk, preserving strong royalties.

  Returns TransferPolicyTransaction

addPersonalKioskRule

• addPersonalKioskRule(): TransferPolicyTransaction

• Attaches the Personal Kiosk Rule, making a purchase valid only for SoulBound kiosks.

  Returns TransferPolicyTransaction

addRoyaltyRule

• addRoyaltyRule(percentageBps, minAmount): TransferPolicyTransaction

• Adds the Kiosk Royalty rule to the Transfer Policy. You can pass the percentage, as well as a minimum amount. The royalty that will be paid is the MAX(percentage, minAmount). You can pass 0 in either value if you want only percentage royalty, or a fixed amount fee. (but you should define at least one of them for the rule to make sense).

  Parameters

  • percentageBps: string | number

    The royalty percentage in basis points. Use percentageToBasisPoints helper to convert from percentage [0,100].
  • minAmount: string | number

    The minimum royalty amount per request in MIST.

  Returns TransferPolicyTransaction

create

• create(__namedParameters): Promise<TransferPolicyTransaction>

• A convenient function to create a Transfer Policy and attach some rules before sharing it (so you can prepare it in a single PTB)

  Parameters

  • __namedParameters: TransferPolicyBaseParams

  Returns Promise<TransferPolicyTransaction>

createAndShare

• createAndShare(__namedParameters): Promise<void>

• A function to create a new transfer policy. Checks if there's already an existing transfer policy to prevent double transfer polciy mistakes. There's an optional skipCheck flag that will just create the policy without checking

  Parameters

  • __namedParameters: TransferPolicyBaseParams & {
        address: string;
    }

  Returns Promise<void>

getPolicy

• getPolicy(): ObjectArgument

• Returns ObjectArgument

getPolicyCap

• getPolicyCap(): ObjectArgument

• Returns ObjectArgument

removeFloorPriceRule

• removeFloorPriceRule(): TransferPolicyTransaction

• Returns TransferPolicyTransaction

removeLockRule

• removeLockRule(): TransferPolicyTransaction

• Removes the lock rule.

  Returns TransferPolicyTransaction

removePersonalKioskRule

• removePersonalKioskRule(): TransferPolicyTransaction

• Returns TransferPolicyTransaction

removeRoyaltyRule

• removeRoyaltyRule(): TransferPolicyTransaction

• Removes the Royalty rule

  Returns TransferPolicyTransaction

removeRule

• removeRule(__namedParameters): void

• Generic helper to remove a rule, not from the SDK's base ruleset.

  Parameters

  • __namedParameters: {
        configType: string;
        ruleType: string;
    }

    • configType: string

    • ruleType: string

  Returns void

setCap

• setCap(policyCapId): TransferPolicyTransaction

• Setup the TransferPolicy by passing a cap returned from kioskClient.getOwnedTransferPolicies or kioskClient.getOwnedTransferPoliciesByType.

  Parameters

  • policyCapId: TransferPolicyCap

    The TransferPolicyCap

  Returns TransferPolicyTransaction

shareAndTransferCap

• shareAndTransferCap(address): void

• This can be called after calling the create function to share the TransferPolicy, and transfer the TransferPolicyCap to the specified address

  Parameters

  • address: string

    The address to transfer the TransferPolicyCap

  Returns void

withdraw

• withdraw(address, amount?): TransferPolicyTransaction

• Withdraw from the transfer policy's profits.

  Parameters

  • address: string

    Address to transfer the profits to.
  • Optionalamount: string | bigint

    (Optional) amount parameter. Will withdraw all profits if the amount is not specified.

  Returns TransferPolicyTransaction