The TransactionBuilder class provides helper methods to easily create standard types of transactions. It can only be instantiated from a Client with client.transactionBuilder().

Methods

free()

free(): `void`

newAddStake()

`static` newAddStake(`sender`, `staker_address`, `value`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Adds stake to a staker in the staking contract and transfers value amount of luna (NIM's smallest unit) from the sender account to this staker.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the numbers given for value and fee do not fit within a u64 or the networkId is unknown.

newBasic()

`static` newBasic(`sender`, `recipient`, `value`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Creates a basic transaction that transfers value amount of luna (NIM's smallest unit) from the sender to the recipient.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the numbers given for value and fee do not fit within a u64 or the networkId is unknown.

newBasicWithData()

`static` newBasicWithData(`sender`, `recipient`, `data`, `value`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Creates a basic transaction that transfers value amount of luna (NIM's smallest unit) from the sender to the recipient. It can include arbitrary data, up to 64 bytes.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the numbers given for value and fee do not fit within a u64 or the networkId is unknown.

newCreateStaker()

`static` newCreateStaker(`sender`, `delegation`, `value`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Creates a new staker in the staking contract and transfers value amount of luna (NIM's smallest unit) from the sender account to this new staker.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the numbers given for value and fee do not fit within a u64 or the networkId is unknown.

newCreateValidator()

`static` newCreateValidator(`sender`, `reward_address`, `signing_key`, `voting_key_pair`, `signal_data`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Registers a new validator in the staking contract.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the fee does not fit within a u64 or the networkId is unknown.

newDeactivateValidator()

`static` newDeactivateValidator(`sender`, `validator`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Deactivates a validator in the staking contract.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the fee does not fit within a u64 or the networkId is unknown.

newDeleteValidator()

`static` newDeleteValidator(`sender`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Deleted a validator the staking contract. The deposit is returned to the Sender

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the fee does not fit within a u64 or the networkId is unknown.

newRemoveStake()

`static` newRemoveStake(`recipient`, `value`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Removes stake from the staking contract and transfers value amount of luna (NIM's smallest unit) from the staker to the recipient.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the numbers given for value and fee do not fit within a u64 or the networkId is unknown.

newRetireStake()

`static` newRetireStake(`sender`, `retire_stake`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Retires a portion of the inactive stake balance of the staker. This is a signaling transaction and as such does not transfer any value.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the numbers given for fee and retire_stake do not fit within a u64 or the networkId is unknown.

newRetireValidator()

`static` newRetireValidator(`sender`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Retires a validator in the staking contract.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the fee does not fit within a u64 or the networkId is unknown.

newSetActiveStake()

`static` newSetActiveStake(`sender`, `new_active_balance`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Sets the active stake balance of the staker. This is a signaling transaction and as such does not transfer any value.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the numbers given for fee and new_active_balance do not fit within a u64 or the networkId is unknown.

newUpdateStaker()

`static` newUpdateStaker(`sender`, `new_delegation`, `reactivate_all_stake`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Updates a staker in the staking contract to stake for a different validator. This is a signaling transaction and as such does not transfer any value.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the number given for fee does not fit within a u64 or the networkId is unknown.

newUpdateValidator()

`static` newUpdateValidator(`sender`, `reward_address`, `signing_key`, `voting_key_pair`, `signal_data`, `fee`, `validity_start_height`, `network_id`): [Transaction](Transaction)

Updates parameters of a validator in the staking contract.

The returned transaction is not yet signed. You can sign it e.g. with tx.sign(keyPair).

Throws when the fee does not fit within a u64 or the networkId is unknown.