Class TransactionManagement

Minimal EventEmitter interface that is molded against the Node.js EventEmitter interface.

Hierarchy (View Summary)

EventEmitter<TransactionWorkerEvents>
- TransactionManagement

Index

Implementation

constructor

new TransactionManagement(config: AptosConfig): TransactionManagement

Initializes a new instance of the Aptos client with the provided configuration settings. This allows you to interact with the Aptos blockchain using the specified network and options.

Parameters

config: AptosConfig
The configuration settings for the Aptos client.

Returns TransactionManagement

Example

import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";

async function runExample() {
    // Create a configuration for the Aptos client
    const config = new AptosConfig({
        network: Network.TESTNET, // specify the network to use
        nodeUrl: "https://testnet.aptos.dev" // replace with your node URL
    });

    // Initialize the Aptos client with the configuration
    const aptos = new Aptos(config);

    console.log("Aptos client initialized successfully.");
}
runExample().catch(console.error);

forSingleAccount

forSingleAccount(
    args: {
        data: InputGenerateTransactionPayloadData[];
        options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">;
        sender: Account;
    },
): void
Send batch transactions for a single account.

This function uses a transaction worker that receives payloads to be processed and submitted to chain. Note that this process is best for submitting multiple transactions that don't rely on each other, i.e. batch funds, batch token mints, etc.

If any worker failure, the functions throws an error.
Parameters
- args: {
      data: InputGenerateTransactionPayloadData[];
      options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">;
      sender: Account;
  }
  - data: InputGenerateTransactionPayloadData[]
    An array of transaction payloads
  - Optionaloptions?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">
    optional. Transaction generation configurations (excluding accountSequenceNumber)
  - sender: Account
    The sender account to sign and submit the transaction
Returns void
void. Throws if any error
- Defined in src/api/transactionSubmission/management.ts:197

Methods

addListener

addListener<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:45

emit

emit<T extends keyof TransactionWorkerEvents>(
    event: T,
    ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
        T,
        keyof TransactionWorkerEvents,
    >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
  T,
  keyof TransactionWorkerEvents,
  >]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof TransactionWorkerEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof TransactionWorkerEvents)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: keyof TransactionWorkerEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof TransactionWorkerEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends keyof TransactionWorkerEvents>(
    event: T,
): (
    (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
Returns (
    (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:20

off

off<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn?: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- Optionalfn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:69

on

on<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:40

once

once<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: keyof TransactionWorkerEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof TransactionWorkerEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn?: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- Optionalfn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:63

Properties

account

account: Account

`Readonly`config

config: AptosConfig

transactionWorker

transactionWorker: TransactionWorker

`Static`prefixed

prefixed: string | boolean

Class TransactionManagement

Hierarchy (View Summary)

Index

Implementation

Methods

Properties

Implementation

constructor

Parameters

Returns TransactionManagement

Example

forSingleAccount

Parameters

data: InputGenerateTransactionPayloadData[]

Optionaloptions?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">

sender: Account

Returns void

Methods

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof TransactionWorkerEvents)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract< T, keyof TransactionWorkerEvents, >], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

Properties

account

Readonlyconfig

transactionWorker

Staticprefixed

Settings

On This Page

`Optional`options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">

Returns (
(
...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
T,
keyof TransactionWorkerEvents,
>],
) => void
)[]

`Readonly`config

`Static`prefixed