Interface SendSameAmountToMultipleRecipientsArgs

The argument object for TransactionApi.sendSameAmountToMultipleRecipients

Param: recipientIds

The list of recipient Ids

Param: amountPlanck

The amount to be sent to all recipients

Param: dedupe

Automatically removes duplicate recipient ids. Default is false, which will throw an error then.

interface SendSameAmountToMultipleRecipientsArgs {
    amountPlanck: string;
    attachment?: Attachment;
    deadline?: number;
    dedupe?: boolean;
    feePlanck: string;
    recipientIds: string[];
    referencedTransactionFullHash?: string;
    senderPrivateKey?: string;
    senderPublicKey: string;
    skipAdditionalSecurityCheck?: boolean;
}

Hierarchy

  • DefaultSendArgs
    • SendSameAmountToMultipleRecipientsArgs

Properties

amountPlanck attachment? deadline? dedupe? feePlanck recipientIds referencedTransactionFullHash? senderPrivateKey? senderPublicKey skipAdditionalSecurityCheck?

Properties

amountPlanck

amountPlanck: string

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

Optionaldedupe

dedupe?: boolean

feePlanck

feePlanck: string

The fee expressed in Planck

It's recommended to use util.Amount

recipientIds

recipientIds: string[]

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.

Settings

Member Visibility

On This Page

Properties