Class Transaction

A representation of an onchain Transaction.

Index

Constructors

constructor

new Transaction(model): Transaction
Transactions should be constructed via higher level abstractions like Trade or Transfer.
Parameters
- model: Transaction
  The underlying Transaction object.
Returns Transaction
- Defined in src/coinbase/transaction.ts:19

Properties

`Private` model

model: Transaction

`Private` `Optional` raw

raw?: Transaction

Methods

blockHash

blockHash(): undefined | string
Returns the Block Hash where the Transaction is recorded.

Returns undefined | string
The Block Hash
- Defined in src/coinbase/transaction.ts:118

blockHeight

blockHeight(): undefined | string
Returns the Block Height where the Transaction is recorded.

Returns undefined | string
The Block Height
- Defined in src/coinbase/transaction.ts:109

content

content(): undefined | EthereumTransaction
Returns the Content of the Transaction.

Returns undefined | EthereumTransaction
The transaction content
- Defined in src/coinbase/transaction.ts:127

fromAddressId

fromAddressId(): string
Returns the From Address ID for the Transaction.

Returns string
The From Address ID
- Defined in src/coinbase/transaction.ts:91

getNetworkId

getNetworkId(): string
Returns the Network ID of the Transaction.

Returns string
The Network ID.
- Defined in src/coinbase/transaction.ts:145

getSignature

getSignature(): undefined | string
Returns the Signed Payload of the Transaction.

Returns undefined | string
The Signed Payload
- Defined in src/coinbase/transaction.ts:193

getSignedPayload

getSignedPayload(): undefined | string
Returns the Signed Payload of the Transaction.

Returns undefined | string
The Signed Payload
- Defined in src/coinbase/transaction.ts:40

getStatus

getStatus(): TransactionStatus
Returns the Status of the Transaction.

Returns TransactionStatus
The Status
- Defined in src/coinbase/transaction.ts:58

getTransactionHash

getTransactionHash(): undefined | string
Returns the Transaction Hash of the Transaction.

Returns undefined | string
The Transaction Hash
- Defined in src/coinbase/transaction.ts:49

getTransactionLink

getTransactionLink(): string
Returns the link to the Transaction on the blockchain explorer.

Returns string
The link to the Transaction on the blockchain explorer
- Defined in src/coinbase/transaction.ts:136

getUnsignedPayload

getUnsignedPayload(): string
Returns the Unsigned Payload of the Transaction.

Returns string
The Unsigned Payload
- Defined in src/coinbase/transaction.ts:31

isSigned

isSigned(): boolean
Returns whether the transaction has been signed.

Returns boolean
if the transaction has been signed.
- Defined in src/coinbase/transaction.ts:202

isTerminalState

isTerminalState(): boolean
Returns whether the Transaction is in a terminal State.

Returns boolean
Whether the Transaction is in a terminal State
- Defined in src/coinbase/transaction.ts:80

rawTransaction

rawTransaction(): Transaction
Returns the underlying raw transaction.

Returns Transaction
The ethers.js Transaction object

Throws
If the Unsigned Payload is invalid.
- Defined in src/coinbase/transaction.ts:155

sign

sign(key): Promise<string>
Signs the Transaction with the provided key and returns the hex signing payload.
Parameters
- key: Wallet
  The key to sign the transaction with
Returns Promise<string>
The hex-encoded signed payload
- Defined in src/coinbase/transaction.ts:181

toAddressId

toAddressId(): undefined | string
Returns the To Address ID for the Transaction if it's available.

Returns undefined | string
The To Address ID
- Defined in src/coinbase/transaction.ts:100

toString

toString(): string
Returns a string representation of the Transaction.

Returns string
A string representation of the Transaction.
- Defined in src/coinbase/transaction.ts:211