Skip to content

Class: Transaction

Defined in: packages/txm/lib/Transaction.ts:85

Accessors

attemptCount

Get Signature

get attemptCount(): number

Defined in: packages/txm/lib/Transaction.ts:212

Returns

number


lastAttempt

Get Signature

get lastAttempt(): undefined | Attempt

Defined in: packages/txm/lib/Transaction.ts:216

Returns

undefined | Attempt

Constructors

new Transaction()

new Transaction(__namedParameters: TransactionConstructorConfig & {
  attempts: Attempt[];
  chainId: number;
  collectionBlock: bigint;
  createdAt: Date;
  from: `0x${string}`;
  intentId: UUID;
  notPersisted: boolean;
  pendingFlush: boolean;
  status: TransactionStatus;
  updatedAt: Date;
 }): Transaction

Defined in: packages/txm/lib/Transaction.ts:129

Parameters

__namedParameters

TransactionConstructorConfig & { attempts: Attempt[]; chainId: number; collectionBlock: bigint; createdAt: Date; from: `0x${string}`; intentId: UUID; notPersisted: boolean; pendingFlush: boolean; status: TransactionStatus; updatedAt: Date; }

Returns

Transaction

Methods

addAttempt()

addAttempt(attempt: Attempt): void

Defined in: packages/txm/lib/Transaction.ts:176

Parameters

attempt

Attempt

Returns

void


addCollectionBlock()

addCollectionBlock(blockNumber: bigint): void

Defined in: packages/txm/lib/Transaction.ts:181

Parameters

blockNumber

bigint

Returns

void


changeStatus()

changeStatus(status: TransactionStatus): void

Defined in: packages/txm/lib/Transaction.ts:204

Parameters

status

TransactionStatus

Returns

void


getInAirAttempts()

getInAirAttempts(): Attempt[]

Defined in: packages/txm/lib/Transaction.ts:194

Returns

Attempt[]


isExpired()

isExpired(block: LatestBlock, blockTime: bigint): boolean

Defined in: packages/txm/lib/Transaction.ts:200

Parameters

block

LatestBlock

blockTime

bigint

Returns

boolean


markFlushed()

markFlushed(): void

Defined in: packages/txm/lib/Transaction.ts:220

Returns

void


removeAttempt()

removeAttempt(hash: `0x${string}`): void

Defined in: packages/txm/lib/Transaction.ts:186

Parameters

hash

`0x${string}`

Returns

void


toDbRow()

toDbRow(): {
  address: `0x${string}`;
  args: string;
  attempts: string;
  chainId: number;
  contractName: string;
  createdAt: number;
  from: `0x${string}`;
  functionName: string;
  intentId: UUID;
  status: TransactionStatus;
  updatedAt: number;
 } & {
  collectionBlock: number;
  deadline: number;
  metadata: string;
}

Defined in: packages/txm/lib/Transaction.ts:236

Returns

{ address: `0x${string}`; args: string; attempts: string; chainId: number; contractName: string; createdAt: number; from: `0x${string}`; functionName: string; intentId: UUID; status: TransactionStatus; updatedAt: number; } & { collectionBlock: number; deadline: number; metadata: string; }


fromDbRow()

static fromDbRow(row: {
  address: `0x${string}`;
  args: string;
  attempts: string;
  chainId: number;
  collectionBlock: undefined | number;
  contractName: string;
  createdAt: number;
  deadline: undefined | number;
  from: `0x${string}`;
  functionName: string;
  intentId: UUID;
  metadata: undefined | string;
  status: TransactionStatus;
  updatedAt: number;
 }): Transaction

Defined in: packages/txm/lib/Transaction.ts:255

Parameters

row
address

`0x${string}`

args

string

attempts

string

chainId

number

collectionBlock

undefined | number

contractName

string

createdAt

number

deadline

undefined | number

from

`0x${string}`

functionName

string

intentId

UUID

metadata

undefined | string

status

TransactionStatus

updatedAt

number

Returns

Transaction

Properties

address

readonly address: `0x${string}`;

Defined in: packages/txm/lib/Transaction.ts:92


args

readonly args: readonly unknown[];

Defined in: packages/txm/lib/Transaction.ts:96


attempts

readonly attempts: Attempt[];

Defined in: packages/txm/lib/Transaction.ts:105


chainId

readonly chainId: number;

Defined in: packages/txm/lib/Transaction.ts:90


collectionBlock

collectionBlock: undefined | bigint;

Defined in: packages/txm/lib/Transaction.ts:109


contractName

readonly contractName: string;

Defined in: packages/txm/lib/Transaction.ts:99


createdAt

createdAt: Date;

Defined in: packages/txm/lib/Transaction.ts:119


deadline

readonly deadline: undefined | number;

Defined in: packages/txm/lib/Transaction.ts:101


from

readonly from: `0x${string}`;

Defined in: packages/txm/lib/Transaction.ts:88


functionName

readonly functionName: string;

Defined in: packages/txm/lib/Transaction.ts:94


intentId

readonly intentId: UUID;

Defined in: packages/txm/lib/Transaction.ts:86


metadata

readonly metadata: Record<string, unknown>;

Defined in: packages/txm/lib/Transaction.ts:127

Stores additional information for the transaction. Enables originators to provide extra details, such as gas limits, which can be leveraged by customizable services.


notPersisted

notPersisted: boolean;

Defined in: packages/txm/lib/Transaction.ts:117


pendingFlush

pendingFlush: boolean;

Defined in: packages/txm/lib/Transaction.ts:113


status

status: TransactionStatus;

Defined in: packages/txm/lib/Transaction.ts:103


updatedAt

updatedAt: Date;

Defined in: packages/txm/lib/Transaction.ts:121