Interface DistributeToAssetHoldersArgs

The argument object for AssetApi.distributeToAssetHolders

interface DistributeToAssetHoldersArgs {
    additionalAssetId?: string;
    additionalAssetQuantity?: string;
    assetId: string;
    attachment?: Attachment;
    deadline?: number;
    feePlanck: string;
    minimumHoldQuantity?: string;
    referencedTransactionFullHash?: string;
    senderPrivateKey?: string;
    senderPublicKey: string;
    skipAdditionalSecurityCheck?: boolean;
    totalAmountPlanck: string;
}

Hierarchy

  • DefaultSendArgs
    • DistributeToAssetHoldersArgs

Properties

additionalAssetId? additionalAssetQuantity? assetId attachment? deadline? feePlanck minimumHoldQuantity? referencedTransactionFullHash? senderPrivateKey? senderPublicKey skipAdditionalSecurityCheck? totalAmountPlanck

Properties

OptionaladditionalAssetId

additionalAssetId?: string

You may distribute an additional asset, i.e. as air drop, together with this pay out.

OptionaladditionalAssetQuantity

additionalAssetQuantity?: string

If given additionalAssetId, then you need to specify a quantity that's being distributed together.

assetId

assetId: string

The related asset

Optionalattachment

attachment?: Attachment

An optional attachment

Optionaldeadline

deadline?: number

The deadline when after how many minutes the transaction will be discarded, if it was not processed, e.g. due to very low fee

feePlanck

feePlanck: string

The fee expressed in Planck

It's recommended to use util.Amount

OptionalminimumHoldQuantity

minimumHoldQuantity?: string

Distributes only to those who have a minimum amount of that token/asset

OptionalreferencedTransactionFullHash

referencedTransactionFullHash?: string

Using this field allows to make a transaction dependent on other transactions.

OptionalsenderPrivateKey

senderPrivateKey?: string

The senders private key, i.e. the crypto.SignKeys.signPrivateKey If the private key is not given, then the transaction method will return the unsigned byte string. The transaction won't be processed until the unsigned bytes are being signed and broadcasted using TransactionApi.signAndBroadcastTransaction

senderPublicKey

senderPublicKey: string

The senders public key, i.e. the crypto.SignKeys.publicKey

OptionalskipAdditionalSecurityCheck

skipAdditionalSecurityCheck?: boolean

Setting this option to true, skips the additional security check, i.e. the verification of the unsigned transaction bytes, which detects tampered node responses. By default, the option is false. Usually, you won't use this option, but can be useful when a method cannot be verified, because the verification is not implemented yet.

totalAmountPlanck

totalAmountPlanck: string

Total Amount of Signa to be distributed, expressed in Planck

Settings

Member Visibility

On This Page

Properties