Class: TransactionBuilder

TransactionBuilder

A convenience class for building transaction template objects.


new TransactionBuilder()

constructor - return a new object used for constructing a transaction.

Members


actions :Array

List of actions to send to the build-transaction API.

Type:
  • Array

transactionTags :Object

Key-value tags for the transaction.

Type:
  • Object

Methods


issue(params)

Add an action that issues tokens.

Parameters:
Name Type Description
params Object

Action parameters.

Properties
Name Type Description
flavorId String

ID of flavor to be issued.

amount Number | String | BigNumber

Amount of the flavor to be issued.

destinationAccountId String

Account ID specifying the account controlling the flavor.

tokenTags Object

Tags to add to the receiving tokens.

actionTags Object

Tags to add to the action.


retire(params)

Add an action that retires tokens.

Parameters:
Name Type Description
params Object

Action parameters.

Properties
Name Type Description
sourceAccountId String

Account ID specifying the account controlling the flavor.

flavorId String

ID of flavor to be retired.

amount Number | String | BigNumber

Amount of the flavor to be retired.

filter String

Token filter string, see https://dashboard.seq.com/docs/filters.

filterParams Array.<(String|Number)>

Parameter values for filter string (if needed).

actionTags Object

Tags to add to the action.


transfer(params)

Add an action that moves tokens from a source account to a destination account.

Parameters:
Name Type Description
params Object

Action parameters

Properties
Name Type Description
sourceAccountId String

Account ID specifying the account controlling the flavor.

flavorId String

ID of flavor to be transferred.

amount Number | String | BigNumber

Amount of the flavor to be transferred.

destinationAccountId String

Account ID specifying the account controlling the flavor.

filter String

Token filter string, see https://dashboard.seq.com/docs/filters.

filterParams Array.<(String|Number)>

Parameter values for filter string (if needed).

tokenTags Object

Tags to add to the receiving tokens.

actionTags Object

Tags to add to the action.