@nimiq/core / TransactionBuilder
Class: TransactionBuilder
Defined in: @nimiq/core/types/wasm/web.d.ts:2123
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
Defined in: @nimiq/core/types/wasm/web.d.ts:2125
Returns
void
newAddStake()
staticnewAddStake(sender,staker_address,value,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2161
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.
Parameters
sender
staker_address
value
bigint
fee
bigint
validity_start_height
number
network_id
number
Returns
newBasic()
staticnewBasic(sender,recipient,value,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2134
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.
Parameters
sender
recipient
value
bigint
fee
bigint
validity_start_height
number
network_id
number
Returns
newBasicWithData()
staticnewBasicWithData(sender,recipient,data,value,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2143
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.
Parameters
sender
recipient
data
Uint8Array
value
bigint
fee
bigint
validity_start_height
number
network_id
number
Returns
newCreateStaker()
staticnewCreateStaker(sender,delegation,value,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2152
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.
Parameters
sender
delegation
value
bigint
fee
bigint
validity_start_height
number
network_id
number
Returns
newCreateValidator()
staticnewCreateValidator(sender,reward_address,signing_key,voting_key_pair,signal_data,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2205
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.
Parameters
sender
reward_address
signing_key
voting_key_pair
signal_data
string
fee
bigint
validity_start_height
number
network_id
number
Returns
newDeactivateValidator()
staticnewDeactivateValidator(sender,validator,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2221
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.
Parameters
sender
validator
fee
bigint
validity_start_height
number
network_id
number
Returns
newDeleteValidator()
staticnewDeleteValidator(sender,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2229
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.
Parameters
sender
fee
bigint
validity_start_height
number
network_id
number
Returns
newRemoveStake()
staticnewRemoveStake(recipient,value,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2197
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.
Parameters
recipient
value
bigint
fee
bigint
validity_start_height
number
network_id
number
Returns
newRetireStake()
staticnewRetireStake(sender,retire_stake,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2188
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.
Parameters
sender
retire_stake
bigint
fee
bigint
validity_start_height
number
network_id
number
Returns
newRetireValidator()
staticnewRetireValidator(sender,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2237
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.
Parameters
sender
fee
bigint
validity_start_height
number
network_id
number
Returns
newSetActiveStake()
staticnewSetActiveStake(sender,new_active_balance,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2179
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.
Parameters
sender
new_active_balance
bigint
fee
bigint
validity_start_height
number
network_id
number
Returns
newUpdateStaker()
staticnewUpdateStaker(sender,new_delegation,reactivate_all_stake,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2170
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.
Parameters
sender
new_delegation
reactivate_all_stake
boolean
fee
bigint
validity_start_height
number
network_id
number
Returns
newUpdateValidator()
staticnewUpdateValidator(sender,reward_address,signing_key,voting_key_pair,signal_data,fee,validity_start_height,network_id):Transaction
Defined in: @nimiq/core/types/wasm/web.d.ts:2213
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.
Parameters
sender
reward_address
signing_key
voting_key_pair
signal_data
string
fee
bigint
validity_start_height
number
network_id
number