Class Transaction

A wrapper for a TransactionV1 or Deploy.

Hierarchy

Transaction

Index

Constructors

constructor

new Transaction(hash: TransactionHash, chainName: string, timestamp: Timestamp, ttl: Duration, initiatorAddr: InitiatorAddr, pricingMode: PricingMode, args: Args, target: TransactionTarget, entryPoint: TransactionEntryPoint, scheduling: TransactionScheduling, approvals: Approval[], originTransactionV1?: TransactionV1, originDeployV1?: Deploy): Transaction
Creates a new Transaction instance with the specified values.
Parameters
- hash: TransactionHash
  
  The hash of the transaction.
- chainName: string
  
  The blockchain chain name associated with this transaction.
- timestamp: Timestamp
  
  The timestamp of transaction creation.
- ttl: Duration
  
  The time-to-live duration of the transaction.
- initiatorAddr: InitiatorAddr
  
  The address of the transaction initiator.
- pricingMode: PricingMode
  
  The pricing mode for this transaction.
- args: Args
  
  The arguments for the transaction.
- target: TransactionTarget
  
  The target of the transaction.
- entryPoint: TransactionEntryPoint
  
  The entry point of the transaction.
- scheduling: TransactionScheduling
  
  The scheduling information for the transaction.
- approvals: Approval[]
  
  The list of approvals for this transaction.
- Optional originTransactionV1: TransactionV1
  
  The original TransactionV1, if applicable.
- Optional originDeployV1: Deploy
  
  The original deploy, if applicable.
Returns Transaction
- Defined in src/types/Transaction.ts:557

Properties

approvals

approvals: Approval[]

The list of approvals for this transaction.

args

args: Args

The arguments for the transaction, which can be a map of values required by the entry point.

chainName

chainName: string

The name of the blockchain chain associated with this transaction.

entryPoint

entryPoint: TransactionEntryPoint

The entry point of the transaction, specifying the method or action to be executed.

hash

hash: TransactionHash

The hash of the transaction.

initiatorAddr

initiatorAddr: InitiatorAddr

The address of the initiator of the transaction.

`Private` `Optional` originDeployV1

originDeployV1?: Deploy

The original deployment associated with this transaction, if applicable. This is optional and only populated if the transaction originated from a deploy.

`Private` `Optional` originTransactionV1

originTransactionV1?: TransactionV1

The original TransactionV1 associated with this transaction, if applicable. This is optional and only populated if the transaction is based on a TransactionV1.

pricingMode

pricingMode: PricingMode

The pricing mode used for the transaction, which may involve different cost mechanisms.

scheduling

scheduling: TransactionScheduling

The scheduling information for when the transaction should be executed.

target

target: TransactionTarget

The target of the transaction, which specifies where the transaction is directed (e.g., a contract or account).

timestamp

timestamp: Timestamp

The timestamp when the transaction was created.

ttl

ttl: Duration

The time-to-live (TTL) duration of the transaction. It defines the expiration time for the transaction.

Methods

getDeploy

getDeploy(): undefined | Deploy
Gets the original deployment associated with this transaction, if available.

Returns
The original deploy or undefined if not available.

Returns undefined | Deploy
- Defined in src/types/Transaction.ts:604

getTransactionV1

getTransactionV1(): undefined | TransactionV1
Gets the original TransactionV1 associated with this transaction, if available.

Returns
The original TransactionV1 or undefined if not available.

Returns undefined | TransactionV1
- Defined in src/types/Transaction.ts:612

getTransactionWrapper

getTransactionWrapper(): TransactionWrapper
Returns TransactionWrapper
- Defined in src/types/Transaction.ts:616

setSignature

setSignature(signature: Uint8Array, publicKey: PublicKey): void
Sets an already generated signature to the transaction.
Parameters
- signature: Uint8Array
  
  The Ed25519 or Secp256K1 signature.
- publicKey: PublicKey
  
  The public key used to generate the signature.
Returns void
- Defined in src/types/Transaction.ts:651

sign

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

toBytes

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

Returns
A Uint8Array representing the Transaction instance in byte format.

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

toJSON

toJSON(): JsonTypes
Returns JsonTypes
- Defined in src/types/Transaction.ts:726

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:627

`Static` fromDeploy

fromDeploy(deploy: Deploy): Transaction
Converts a TransactionV1 to a Transaction object.

Returns
A new Transaction instance created from the given Deploy.
Parameters
- deploy: Deploy
  
  The Deploy to convert.
Returns Transaction
- Defined in src/types/Transaction.ts:706

`Static` fromJSON

fromJSON(json: any): Transaction
Parameters
- json: any
Returns Transaction
- Defined in src/types/Transaction.ts:710

`Static` fromTransactionV1

fromTransactionV1(v1: TransactionV1): Transaction
Converts a TransactionV1 to a Transaction object.

Returns
A new Transaction instance created from the given TransactionV1.
Parameters
- v1: TransactionV1
  
  The TransactionV1 to convert.
Returns Transaction
- Defined in src/types/Transaction.ts:683

Class Transaction

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

hash: TransactionHash

chainName: string

timestamp: Timestamp

ttl: Duration

initiatorAddr: InitiatorAddr

pricingMode: PricingMode

args: Args

target: TransactionTarget

entryPoint: TransactionEntryPoint

scheduling: TransactionScheduling

approvals: Approval[]

Optional originTransactionV1: TransactionV1

Optional originDeployV1: Deploy

Returns Transaction

Properties

approvals

args

chainName

entryPoint

hash

initiatorAddr

Private Optional originDeployV1

Private Optional originTransactionV1

pricingMode

scheduling

target

timestamp

ttl

Methods

getDeploy

Returns

Returns undefined | Deploy

getTransactionV1

Returns

Returns undefined | TransactionV1

getTransactionWrapper

Returns TransactionWrapper

setSignature

Parameters

signature: Uint8Array

publicKey: PublicKey

Returns void

sign

Parameters

key: PrivateKey

Returns void

toBytes

Returns

Returns Uint8Array

toJSON

Returns JsonTypes

validate

Throws

Returns boolean

Static fromDeploy

Returns

Parameters

deploy: Deploy

Returns Transaction

Static fromJSON

Parameters

json: any

Returns Transaction

Static fromTransactionV1

Returns

Parameters

v1: TransactionV1

Returns Transaction

Settings

Member Visibility

Theme

`Optional` originTransactionV1: TransactionV1

`Optional` originDeployV1: Deploy

`Private` `Optional` originDeployV1

`Private` `Optional` originTransactionV1

`Static` fromDeploy

`Static` fromJSON

`Static` fromTransactionV1