AssetTransferTransaction | CodeChain JavaScript SDK

Spends the existing asset and creates a new asset. Ownership can be transferred during this process.

An AssetTransferTransaction consists of:

A list of AssetTransferInput to burn.
A list of AssetTransferInput to spend.
A list of AssetTransferOutput to create.
A network ID. This must be identical to the network ID of which the transaction is being sent to.

All inputs must be valid for the transaction to be valid. When each asset types' amount have been summed, the sum of inputs and the sum of outputs must be identical. If an identical transaction hash already exists, then the change fails. In this situation, a transaction can be created again by arbitrarily changing the nonce.

Hierarchy

AssetTransferTransaction

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AssetTransferTransaction(params: AssetTransferTransactionData): AssetTransferTransaction

- Defined in core/transaction/AssetTransferTransaction.ts:82
Parameters
- params: AssetTransferTransactionData
Returns AssetTransferTransaction

Properties

burns

burns: AssetTransferInput[]

inputs

inputs: AssetTransferInput[]

networkId

networkId: NetworkId

nonce

nonce: number

outputs

outputs: AssetTransferOutput[]

type

type: "assetTransfer" = "assetTransfer"

Methods

addBurns

addBurns(...burns: Array<AssetTransferInput | Asset>): AssetTransferTransaction

- Defined in core/transaction/AssetTransferTransaction.ts:134
Add an AssetTransferInput to burn.

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

The AssetTransferTransaction, which is modified by adding them.

addInputs

addInputs(...inputs: Array<AssetTransferInput | Asset>): AssetTransferTransaction

- Defined in core/transaction/AssetTransferTransaction.ts:152
Add an AssetTransferInput to spend.

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

The AssetTransferTransaction, which is modified by adding them.

addOutputs

addOutputs(...outputs: Array<AssetTransferOutput | object>): AssetTransferTransaction

- Defined in core/transaction/AssetTransferTransaction.ts:173
Add an AssetTransferOutput to create.

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

getAssetAddress

getAssetAddress(index: number): H256

- Defined in core/transaction/AssetTransferTransaction.ts:294
Get the asset address of an output.

Parameters
- index: number
  
  An index indicating the output.
Returns H256

An asset address which is H256.

getTransferredAsset

getTransferredAsset(index: number): Asset

- Defined in core/transaction/AssetTransferTransaction.ts:207
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/AssetTransferTransaction.ts:227
Get the outputs of this transaction.

Returns Asset[]

An array of an Asset.

hash

hash(): H256

- Defined in core/transaction/AssetTransferTransaction.ts:125
Get the hash of an AssetTransferTransaction.

Returns H256

A transaction hash.

hashWithoutScript

hashWithoutScript(): H256

- Defined in core/transaction/AssetTransferTransaction.ts:238
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.

Returns H256

A hash.

rlpBytes

rlpBytes(): Buffer

- Defined in core/transaction/AssetTransferTransaction.ts:117
Convert to RLP bytes.

Returns Buffer

signBurn

signBurn(index: number, params: object): Promise<void>

- Defined in core/transaction/AssetTransferTransaction.ts:260
Set a burn's lock script and an input's unlock script so that the burn become burnable.

Parameters
- index: number
  
  An index indicating the burn to sign.
- params: object
  - Optional passphrase?: undefined | string
  - signer: TransactionBurnSigner
    
    A TransactionSigner. Currently, P2PKH is available.
Returns Promise<void>

A promise that resolves when setting is done.

signInput

signInput(index: number, params: object): Promise<void>

- Defined in core/transaction/AssetTransferTransaction.ts:278
Set an input's lock script and an input's unlock script so that the input become spendable.

Parameters
- index: number
  
  An index indicating the input to sign.
- params: object
  - Optional passphrase?: undefined | string
  - signer: TransactionInputSigner
    
    A TransactionSigner. Currently, P2PKH is available.
Returns Promise<void>

A promise that resolves when setting is done.

toEncodeObject

toEncodeObject(): (string | number | (Buffer | (string | number)[])[][] | (string | number | Buffer[])[][])[]

- Defined in core/transaction/AssetTransferTransaction.ts:103
Convert to an object for RLP encoding.

Returns (string | number | (Buffer | (string | number)[])[][] | (string | number | Buffer[])[][])[]

toJSON

toJSON(): object

- Defined in core/transaction/AssetTransferTransaction.ts:328
Convert to an AssetTransferTransaction JSON object.

Returns object

An AssetTransferTransaction JSON object.
- type: string
- data: object
  - burns: object[]
  - inputs: object[]
  - networkId: string
  - nonce: number
  - outputs: object[]

Static fromJSON

fromJSON(obj: any): AssetTransferTransaction

- Defined in core/transaction/AssetTransferTransaction.ts:59
Create an AssetTransferTransaction from an AssetTransferTransaction JSON object.

Parameters
- obj: any
  
  An AssetTransferTransaction JSON object.
Returns AssetTransferTransaction

An AssetTransferTransaction.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: AssetTransferTransactionData

Returns AssetTransferTransaction

Properties

burns

inputs

networkId

nonce

outputs

type

Methods

addBurns

Parameters

Rest ...burns: Array<AssetTransferInput | Asset>

Returns AssetTransferTransaction

addInputs

Parameters

Rest ...inputs: Array<AssetTransferInput | Asset>

Returns AssetTransferTransaction

addOutputs

Parameters

Rest ...outputs: Array<AssetTransferOutput | object>

Returns AssetTransferTransaction

getAssetAddress

Parameters

index: number

Returns H256

getTransferredAsset

Parameters

index: number

Returns Asset

getTransferredAssets

Returns Asset[]

hash

Returns H256

hashWithoutScript

Returns H256

rlpBytes

Returns Buffer

signBurn

Parameters

index: number

params: object

Optional passphrase?: undefined | string

signer: TransactionBurnSigner

Returns Promise<void>

signInput

Parameters

index: number

params: object

Optional passphrase?: undefined | string

signer: TransactionInputSigner

Returns Promise<void>

toEncodeObject

Returns (string | number | (Buffer | (string | number)[])[][] | (string | number | Buffer[])[][])[]

toJSON

Returns object

type: string

data: object

burns: object[]

inputs: object[]

networkId: string

nonce: number

outputs: object[]

Static fromJSON

Parameters

obj: any

Returns AssetTransferTransaction