Skip to content

Class: Transaction

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

Accessors

attemptCount

Get Signature

get attemptCount(): number;

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

Returns

number


lastAttempt

Get Signature

get lastAttempt(): undefined | Attempt;

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

Returns

undefined | Attempt

Constructors

Constructor

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

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

Parameters

config

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

abiManager

ABIManager

Returns

Transaction

Methods

addAttempt()

addAttempt(attempt: Attempt): void;

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

Parameters

attempt

Attempt

Returns

void


addCollectionBlock()

addCollectionBlock(blockNumber: bigint): void;

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

Parameters

blockNumber

bigint

Returns

void


changeStatus()

changeStatus(status: TransactionStatus): void;

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

Parameters

status

TransactionStatus

Returns

void


getInAirAttempts()

getInAirAttempts(): Attempt[];

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

Returns

Attempt[]


isExpired()

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

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

Parameters

block

LatestBlock

blockTime

bigint

Returns

boolean


markFlushed()

markFlushed(): void;

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

Returns

void


removeAttempt()

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

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

Parameters

hash

`0x${string}`

Returns

void


toDbRow()

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

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

Returns

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


toJson()

toJson(): string;

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

Returns

string


fromDbRow()

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

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

Parameters

row
address

`0x${string}`

args

undefined | string

attempts

string

calldata

`0x${string}`

chainId

number

collectionBlock

undefined | number

contractName

undefined | string

createdAt

number

deadline

undefined | number

from

`0x${string}`

functionName

undefined | string

intentId

UUID

metadata

undefined | string

status

TransactionStatus

updatedAt

number

value

string

abiManager

ABIManager

Returns

Transaction

Properties

address

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

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


args?

readonly optional args: readonly unknown[];

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


attempts

readonly attempts: Attempt[];

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


calldata

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

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


chainId

readonly chainId: number;

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


collectionBlock

collectionBlock: undefined | bigint;

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


contractName?

readonly optional contractName: string;

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


createdAt

createdAt: Date;

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


deadline

readonly deadline: undefined | number;

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


from

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

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


functionName?

readonly optional functionName: string;

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


intentId

readonly intentId: UUID;

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


metadata

readonly metadata: Record<string, unknown>;

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

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


pendingFlush

pendingFlush: boolean;

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


status

status: TransactionStatus;

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


updatedAt

updatedAt: Date;

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


value

readonly value: bigint;

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