Skip to content

Class: Transaction

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

Accessors

attemptCount

Get Signature

get attemptCount(): number

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

Returns

number


lastAttempt

Get Signature

get lastAttempt(): undefined | Attempt

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

Returns

undefined | Attempt

Constructors

new Transaction()

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

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

Parameters

__namedParameters

TransactionConstructorConfig & { attempts: Attempt[]; chainId: number; 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:164

Parameters

attempt

Attempt

Returns

void


changeStatus()

changeStatus(status: TransactionStatus): void

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

Parameters

status

TransactionStatus

Returns

void


getInAirAttempts()

getInAirAttempts(): Attempt[]

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

Returns

Attempt[]


isExpired()

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

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

Parameters

block

LatestBlock

blockTime

bigint

Returns

boolean


markFlushed()

markFlushed(): void

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

Returns

void


removeAttempt()

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

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

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;
 } & {
  deadline: number;
  metadata: string;
}

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

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; } & { deadline: number; metadata: string; }


fromDbRow()

static fromDbRow(row: {
  address: `0x${string}`;
  args: string;
  attempts: string;
  chainId: 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:237

Parameters

row
address

`0x${string}`

args

string

attempts

string

chainId

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


args

readonly args: readonly unknown[];

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


attempts

readonly attempts: Attempt[];

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


chainId

readonly chainId: number;

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


contractName

readonly contractName: string;

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


createdAt

createdAt: Date;

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


deadline

readonly deadline: undefined | number;

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


from

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

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


functionName

readonly functionName: string;

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


intentId

readonly intentId: UUID;

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


metadata

readonly metadata: Record<string, unknown>;

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

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


pendingFlush

pendingFlush: boolean;

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


status

status: TransactionStatus;

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


updatedAt

updatedAt: Date;

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