Skip to content

Transaction (Tx)

@aeternity/aepp-sdk/es/tx

Tx module

Example 

import Tx from '@aeternity/aepp-sdk/es/tx'

@aeternity/aepp-sdk/es/tx.spendTx(options) ⇒ String

Create a spend_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - spend_tx transaction
Category: async
rtype: ({sender?: String, recipientId: String, amount: Number, fee?: Number, ttl?: Number, nonce?: Number, payload?: String}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.namePreclaimTx(options) ⇒ String

Create a name_preclaim_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - name_preclaim_tx transaction
Category: async
rtype: ({account?: String, commitment: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.nameClaimTx(options) ⇒ String

Create a name_claim_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - name_claim_tx transaction
Category: async
rtype: ({account?: String, name: String, nameSalt: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.nameTransferTx(options) ⇒ String

Create a name_transfer_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - name_transfer_tx transaction
Category: async
rtype: ({account?: String, nameId: String, recipientId: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.nameUpdateTx(options) ⇒ String

Create a name_update_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - name_update_tx transaction
Category: async
rtype: ({account?: String, nameId: String, pointers: Object, nameTtl: Number, clientTtl: Number, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.nameRevokeTx(options) ⇒ String

Create a name_revoke_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - name_revoke_tx transaction
Category: async
rtype: ({account?: String, nameId: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.contractCreateTx(options) ⇒ String

Create a contract_create_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - contract_create_tx transaction
Category: async
rtype: ({owner: String, code: String, callData: String, vmVersion: Number, deposit: Number, amount: Number, gas: Number, gasPrice: Number, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.contractCallTx(options) ⇒ String

Create a contract_call_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - contract_call_tx transaction
Category: async
rtype: ({callerId: String, contract: String, callData: String, vmVersion: Number, amount: Number, gas: Number, gasPrice: Number, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.oracleRegisterTx(options) ⇒ String

Create a oracle_register_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - oracle_register_tx transaction
Category: async
rtype: ({ accountId: String, queryFormat: String, responseFormat: String, queryFee: String|Number, oracleTtl: Object, vmVersion: Number = ORACLE_VM_VERSION, fee?: Number, ttl?: Number, nonce?: Number }) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.oracleExtendTx(options) ⇒ String

Create a oracle_extend_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - oracle_extend_tx transaction
Category: async
rtype: ({ oracleId: String, callerId: String, oracleTtl: Object, fee?: Number, ttl: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.oraclePostQuery(options) ⇒ String

Create a oracle_post_query_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - oracle_post_query_tx transaction
Category: async
rtype: ({ oracleId: String, responseTtl: Object, query: String, queryTtl: Object, queryFee: String|Number, senderId: String, fee?: Number, ttl: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.oracleRespondTx(options) ⇒ String

Create a oracle_respond_tx transaction

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: String - oracle_respond_tx transaction
Category: async
rtype: ({ oracleId: String, callerId: String, responseTtl: Object, queryId: String, response: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]

Param Type Description
options Object The object to extract properties from

@aeternity/aepp-sdk/es/tx.getAccountNonce(address) ⇒ Number

Get Account Nonce

Kind: instance abstract method of @aeternity/aepp-sdk/es/tx
Returns: Number - Result
Category: async
rtype: (address) => result: Number

Param Type Description
address String Account public key