Class TransferAsset

Hierarchy

Transaction
- TransferAsset

Implements

AssetTransaction

Index

Constructors

constructor

Methods

Constructors

constructor

new TransferAsset(input: object): TransferAsset

- Defined in core/transaction/TransferAsset.ts:51
Parameters
- input: object
  - approvals: string[]
  - burns: AssetTransferInput[]
  - expiration: number | null
  - inputs: AssetTransferInput[]
  - metadata: string | object
  - networkId: NetworkId
  - orders: OrderOnTransfer[]
  - outputs: AssetTransferOutput[]
Returns TransferAsset

Methods

addApproval

addApproval(approval: string): void

Implementation of AssetTransaction.addApproval
- Defined in core/transaction/TransferAsset.ts:86
Add an approval to transaction.

Parameters
- approval: string
  
  An approval
Returns void

addBurns

addBurns(burns: AssetTransferInput | Asset | Array<AssetTransferInput | Asset>, ...rest: Array<AssetTransferInput | Asset>): TransferAsset

- Defined in core/transaction/TransferAsset.ts:95
Add an AssetTransferInput to burn.

Parameters
- burns: AssetTransferInput | Asset | Array<AssetTransferInput | Asset>
  
  An array of either an AssetTransferInput or an Asset.
- Rest ...rest: Array<AssetTransferInput | Asset>
Returns TransferAsset

The TransferAsset, which is modified by adding them.

addInputs

addInputs(inputs: AssetTransferInput | Asset | Array<AssetTransferInput | Asset>, ...rest: Array<AssetTransferInput | Asset>): TransferAsset

- Defined in core/transaction/TransferAsset.ts:132
Add an AssetTransferInput to spend.

Parameters
- inputs: AssetTransferInput | Asset | Array<AssetTransferInput | Asset>
  
  An array of either an AssetTransferInput or an Asset.
- Rest ...rest: Array<AssetTransferInput | Asset>
Returns TransferAsset

The TransferAsset, which is modified by adding them.

addOrder

addOrder(params: object): this

- Defined in core/transaction/TransferAsset.ts:215
Add an Order to create.

Parameters
- params: object
  - inputIndices: number[]
    
    The indices of inputs affected by the order
  - order: Order
    
    An order to apply to the transfer transaction.
  - outputIndices: number[]
    
    The indices of outputs affected by the order
  - spentQuantity: U64Value
    
    A spent quantity of the asset to give(from) while transferring.
Returns this

addOutputs

addOutputs(outputs: AssetTransferOutputValue | Array<AssetTransferOutputValue>, ...rest: Array<AssetTransferOutputValue>): TransferAsset

- Defined in core/transaction/TransferAsset.ts:172
Add an AssetTransferOutput to create.

Parameters
- outputs: AssetTransferOutputValue | Array<AssetTransferOutputValue>
  
  An array of either an AssetTransferOutput or an object that has quantity, assetType and recipient values.
- Rest ...rest: Array<AssetTransferOutputValue>
Returns TransferAsset

burn

burn(index: number): AssetTransferInput | null

- Defined in core/transaction/TransferAsset.ts:120
Parameters
- index: number
Returns AssetTransferInput | null

burns

burns(): AssetTransferInput[]

- Defined in core/transaction/TransferAsset.ts:116
Returns AssetTransferInput[]

fee

fee(): U64 | null

Inherited from Transaction.fee
- Defined in core/Transaction.ts:78
Returns U64 | null

getTransferredAsset

getTransferredAsset(index: number): Asset

- Defined in core/transaction/TransferAsset.ts:262
Get the output of the given index, of this transaction.

Parameters
- index: number
  
  An index indicating an output.
Returns Asset

An Asset.

getTransferredAssets

getTransferredAssets(): Asset[]

- Defined in core/transaction/TransferAsset.ts:289
Get the outputs of this transaction.

Returns Asset[]

An array of an Asset.

hashWithoutScript

hashWithoutScript(params?: undefined | object): H256

- Defined in core/transaction/TransferAsset.ts:300
Get a hash of the transaction that doesn't contain the scripts. The hash is used as a message to create a signature for a transaction.

Parameters
- Optional params: undefined | object
Returns H256

A hash.

input

input(index: number): AssetTransferInput | null

- Defined in core/transaction/TransferAsset.ts:157
Parameters
- index: number
Returns AssetTransferInput | null

inputs

inputs(): AssetTransferInput[]

- Defined in core/transaction/TransferAsset.ts:153
Returns AssetTransferInput[]

networkId

networkId(): NetworkId

Inherited from Transaction.networkId
- Defined in core/Transaction.ts:90
Returns NetworkId

orders

orders(): OrderOnTransfer[]

- Defined in core/transaction/TransferAsset.ts:253
Returns OrderOnTransfer[]

output

output(index: number): AssetTransferOutput | null

- Defined in core/transaction/TransferAsset.ts:201
Parameters
- index: number
Returns AssetTransferOutput | null

outputs

outputs(): AssetTransferOutput[]

- Defined in core/transaction/TransferAsset.ts:197
Returns AssetTransferOutput[]

rlpBytes

rlpBytes(): Buffer

Inherited from Transaction.rlpBytes
- Defined in core/Transaction.ts:107
Returns Buffer

seq

seq(): number | null

Inherited from Transaction.seq
- Defined in core/Transaction.ts:74
Returns number | null

setFee

setFee(fee: U64Value): void

Inherited from Transaction.setFee
- Defined in core/Transaction.ts:86
Parameters
- fee: U64Value
Returns void

setSeq

setSeq(seq: number): void

Inherited from Transaction.setSeq
- Defined in core/Transaction.ts:82
Parameters
- seq: number
Returns void

sign

sign(params: object): SignedTransaction

Inherited from Transaction.sign
- Defined in core/Transaction.ts:115
Parameters
- params: object
  - fee: U64Value
  - secret: H256Value
  - seq: number
Returns SignedTransaction

toEncodeObject

toEncodeObject(): any[]

Inherited from Transaction.toEncodeObject
- Defined in core/Transaction.ts:94
Returns any[]

toJSON

toJSON(): TransactionJSON

Inherited from Transaction.toJSON
- Defined in core/Transaction.ts:135
Returns TransactionJSON

tracker

tracker(): H256

Implementation of AssetTransaction.tracker
- Defined in core/transaction/TransferAsset.ts:78
Get the tracker of an AssetDecomposeTransaction.

Returns H256

A transaction tracker.

type

type(): string

Overrides Transaction.type
- Defined in core/transaction/TransferAsset.ts:366
Returns string

unsignedHash

unsignedHash(): H256

Inherited from Transaction.unsignedHash
- Defined in core/Transaction.ts:111
Returns H256

Generated using TypeDoc