Class TransactionV1

Represents a TransactionV1 object, including its hash, payload, and approvals.

Hierarchy

TransactionV1

Index

Constructors

Properties

approvals hash payload APPROVALS_FIELD_INDEX HASH_FIELD_INDEX PAYLOAD_FIELD_INDEX

Methods

sign toBytes validate fromJSON makeTransactionV1 newTransactionV1 setSignature toJSON

Constructors

constructor

new TransactionV1(hash: Hash, payload: TransactionV1Payload, approvals: Approval[]): TransactionV1
Parameters
- hash: Hash
- payload: TransactionV1Payload
- approvals: Approval[]
Returns TransactionV1
- Defined in src/types/Transaction.ts:279

Properties

approvals

approvals: Approval[]

The approvals for the transaction.

hash

hash: Hash

The hash of the transaction.

payload

payload: TransactionV1Payload

The payload of the transaction. A merge of header and body concepts from before.

`Static` `Private` `Readonly` APPROVALS_FIELD_INDEX

APPROVALS_FIELD_INDEX: 2 = 2

`Static` `Private` `Readonly` HASH_FIELD_INDEX

HASH_FIELD_INDEX: 0 = 0

`Static` `Private` `Readonly` PAYLOAD_FIELD_INDEX

PAYLOAD_FIELD_INDEX: 1 = 1

Methods

sign

sign(keys: PrivateKey): void
Signs the transaction using the provided private key.
Parameters
- keys: PrivateKey
  
  The private key to sign the transaction.
Returns void
- Defined in src/types/Transaction.ts:317

toBytes

toBytes(): Uint8Array
Converts the TransactionV1 to a byte array for transmission or storage.

Returns
A Uint8Array representing the TransactionV1 instance in byte format.

Returns Uint8Array
- Defined in src/types/Transaction.ts:336

validate

validate(): boolean
Validates the transaction by checking the transaction hash and the approval signatures.

Throws
Throws errors if validation fails.

Returns boolean
- Defined in src/types/Transaction.ts:293

`Static` fromJSON

fromJSON(json: any): TransactionV1
Converts a JSON representation of a TransactionV1 to a TransactionV1 object.

Returns
A TransactionV1 object.

Throws
If parsing fails.
Parameters
- json: any
  
  A JSON representation of a TransactionV1.
Returns TransactionV1
- Defined in src/types/Transaction.ts:397

`Static` makeTransactionV1

makeTransactionV1(payload: TransactionV1Payload): TransactionV1
Creates a new TransactionV1 instance with a header and body.

Returns
A new TransactionV1 instance.
Parameters
- payload: TransactionV1Payload
  
  The payload of the transaction. A merge of header and body concepts from before.
Returns TransactionV1
- Defined in src/types/Transaction.ts:385

`Static` newTransactionV1

newTransactionV1(hash: Hash, payload: TransactionV1Payload, approvals: Approval[]): TransactionV1
Creates a new TransactionV1 instance.

Returns
A new TransactionV1 instance.
Parameters
- hash: Hash
  
  The hash of the transaction.
- payload: TransactionV1Payload
  
  The payload of the transaction. A merge of header and body concepts from before.
- approvals: Approval[]
  
  The approvals for the transaction.
Returns TransactionV1
- Defined in src/types/Transaction.ts:372

`Static` setSignature

setSignature(transaction: TransactionV1, signature: Uint8Array, publicKey: PublicKey): TransactionV1
Sets an already generated signature to the transaction.

Returns
The updated TransactionV1.
Parameters
- transaction: TransactionV1
  
  The TransactionV1 instance.
- signature: Uint8Array
  
  The Ed25519 or Secp256K1 signature.
- publicKey: PublicKey
  
  The public key used to generate the signature.
Returns TransactionV1
- Defined in src/types/Transaction.ts:354

`Static` toJSON

toJSON(transaction: TransactionV1): JsonTypes
Converts the TransactionV1 object to a JSON representation.

Returns
A JSON version of the TransactionV1.
Parameters
- transaction: TransactionV1
  
  The TransactionV1 object.
Returns JsonTypes
- Defined in src/types/Transaction.ts:430

Generated using TypeDoc