Class: TransactionBuilder
The TransactionBuilder class provides helper methods to easily create standard types of transactions. It can only be instantiated from a Client with client.transactionBuilder()
.
Constructors
new TransactionBuilder()
new TransactionBuilder():
TransactionBuilder
Returns
Methods
free()
free():
void
Returns
void
Defined in
web.d.ts:2035
newAddStake()
static
newAddStake(sender
,staker_address
,value
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• staker_address: Address
• value: bigint
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2100
newBasic()
static
newBasic(sender
,recipient
,value
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• recipient: Address
• value: bigint
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2051
newBasicWithData()
static
newBasicWithData(sender
,recipient
,data
,value
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• recipient: Address
• data: Uint8Array
• value: bigint
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2068
newCreateStaker()
static
newCreateStaker(sender
,delegation
,value
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• delegation: Address
• value: bigint
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2084
newCreateValidator()
static
newCreateValidator(sender
,reward_address
,signing_key
,voting_key_pair
,signal_data
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• reward_address: Address
• signing_key: PublicKey
• voting_key_pair: BLSKeyPair
• signal_data: string
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2178
newDeactivateValidator()
static
newDeactivateValidator(sender
,validator
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• validator: Address
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2209
newDeleteValidator()
static
newDeleteValidator(sender
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2222
newRemoveStake()
static
newRemoveStake(recipient
,value
,fee
,validity_start_height
,network_id
):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.
Parameters
• recipient: Address
• value: bigint
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2161
newRetireStake()
static
newRetireStake(sender
,retire_stake
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• retire_stake: bigint
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2146
newRetireValidator()
static
newRetireValidator(sender
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2235
newSetActiveStake()
static
newSetActiveStake(sender
,new_active_balance
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• new_active_balance: bigint
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2131
newUpdateStaker()
static
newUpdateStaker(sender
,new_delegation
,reactivate_all_stake
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• new_delegation: Address
• reactivate_all_stake: boolean
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2116
newUpdateValidator()
static
newUpdateValidator(sender
,reward_address
,signing_key
,voting_key_pair
,signal_data
,fee
,validity_start_height
,network_id
):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.
Parameters
• sender: Address
• reward_address: Address
• signing_key: PublicKey
• voting_key_pair: BLSKeyPair
• signal_data: string
• fee: bigint
• validity_start_height: number
• network_id: number
Returns
Defined in
web.d.ts:2195