ContractPlatformFee class

Handle platform fees and recipients

Example

const contract = await sdk.getContract("{{contract_address}}");
const feeInfo = await contract.platformFee.get();
await contract.platformFee.set({
  platform_fee_basis_points: 100, // 1% fee
  platform_fee_recipient: "0x...", // the fee recipient
});

Constructors

Constructor	Modifiers	Description
(constructor)(contractWrapper)		Constructs a new instance of the ContractPlatformFee class

Properties

Property	Modifiers	Type	Description
featureName		"PlatformFee"

Methods

Method	Modifiers	Description
get()		Get the platform fee recipient and basis points *
set(platformFeeInfo)		Set the platform fee recipient and basis points

Signature:

export declare class ContractPlatformFee<TContract extends IPlatformFee> implements DetectableFeature

Implements: DetectableFeature

Remarks

Configure platform fees for a contract, which can be applied on certain paid transactions