Class TransferDeployItem

Represents a deploy item with a transfer of funds and associated arguments.

Hierarchy

TransferDeployItem

Index

Constructors

Properties

Methods

bytes newTransfer

Constructors

constructor

new TransferDeployItem(args: Args): TransferDeployItem
Constructs a TransferDeployItem instance with arguments.
Parameters
- args: Args
  
  The arguments for the transfer.
Returns TransferDeployItem
- Defined in src/types/ExecutableDeployItem.ts:343

Properties

args

args: Args

The arguments for the transfer.

Methods

bytes

bytes(): Uint8Array
Serializes the TransferDeployItem instance to a byte array.

Returns
The serialized byte array.

Returns Uint8Array
- Defined in src/types/ExecutableDeployItem.ts:391

`Static` newTransfer

newTransfer(amount: string | BigNumber, target: PublicKey | URef, sourcePurse?: null | URef, id?: BigNumberish): TransferDeployItem
Creates a new transfer deploy item with the specified amount, target, source purse, and transfer ID.

Returns
A new TransferDeployItem instance.

Throws
Error if the target is not specified or the transfer ID is missing.
Parameters
- amount: string | BigNumber
  
  The amount to transfer.
- target: PublicKey | URef
  
  The target address (either a URef or a PublicKey).
- sourcePurse: null | URef = null
  
  The source purse (optional).
- Optional id: BigNumberish
  
  The transfer ID.
Returns TransferDeployItem
- Defined in src/types/ExecutableDeployItem.ts:356

Generated using TypeDoc