Class GasPools

The GasPools class provides methods for interacting with shared gas pool endpoints on the Aftermath platform. This includes querying pool details and building transactions for creating, depositing into, withdrawing from, sponsoring, granting access to, and revoking access from gas pools.

Example

const gasPools = new GasPools({ network: "MAINNET" });

// Get gas pool details
const pool = await gasPools.getPool({
  walletAddress: "0x..."
});

// Build a deposit transaction
const { tx } = await gasPools.getDepositTx({
  walletAddress: "0x...",
  depositAmount: 100_000_000n
});

Hierarchy (View Summary)

Caller
- GasPools

Index

Constructors

constructor

new GasPools(config?: CallerConfig, api?: AftermathApi): GasPools
Creates a gas-pool facade.
Parameters
- Optionalconfig: CallerConfig
  Optional caller configuration, such as the network and access token.
- Optionalapi: AftermathApi
  Optional provider used to serialize transactions supplied to gas-pool endpoints.
Returns GasPools
Overrides Caller.constructor
- Defined in packages/gasPools/gasPools.ts:57

Properties

`Optional` `Readonly`api

api?: AftermathApi

Optional provider used to serialize transactions supplied to gas-pool endpoints.

config

config: CallerConfig

The mutable configuration used for subsequent requests.

Methods

getCreateTx

getCreateTx(
inputs: Omit<ApiGasPoolCreateBody, "txKind"> & { tx?: Transaction },
): Promise<Omit<ApiGasPoolCreateResponse, "txKind"> & { tx: Transaction }>
Builds a transaction to create a new gas pool for the given wallet.

When deferShare is true, the response includes gasPoolArg and sharePolicyArg so you can compose additional commands (e.g. deposit, grant) before calling getShareTx to finalize.
Parameters
- inputs: Omit<ApiGasPoolCreateBody, "txKind"> & { tx?: Transaction }
  - walletAddress
    
    Wallet address to create the gas pool for.
  - initialDepositAmount
    
    Optional initial deposit amount in MIST.
  - deferShare
    
    When true, returns args without sharing yet.
  - tx
    
    Optional transaction to extend.
  - Optionaltx?: Transaction
    
    Optional transaction to extend.
Returns Promise<Omit<ApiGasPoolCreateResponse, "txKind"> & { tx: Transaction }>
tx plus optional gasPoolArg and sharePolicyArg when deferred.
- Defined in packages/gasPools/gasPools.ts:95

getDepositTx

getDepositTx(
inputs: Omit<ApiGasPoolDepositBody, "txKind"> & { tx?: Transaction },
): Promise<SdkTransactionResponse>
Builds a transaction to deposit into the gas pool.

Supports SUI and non-SUI deposits. For non-SUI deposits, the input coin is swapped into SUI via the Aftermath router before depositing.
Parameters
- inputs: Omit<ApiGasPoolDepositBody, "txKind"> & { tx?: Transaction }
  - walletAddress
    
    Wallet address submitting the deposit.
  - isSponsoredTx
    
    Whether to build the transaction for sponsored gas. Defaults to false.
  - coinType
    
    Coin type to deposit. Defaults to SUI.
  - amount
    
    Amount to deposit (required when sourcing from wallet or for non-SUI).
  - coinArg
    
    PTB coin argument to use as input (if omitted, sourced from wallet).
  - slippage
    
    Slippage tolerance for non-SUI swaps (defaults to 0.01).
  - gasPoolArg
    
    Optional gas pool argument from a previously-built PTB command.
  - tx
    
    Optional transaction to extend.
  - Optionaltx?: Transaction
    
    Optional transaction to extend.
Returns Promise<SdkTransactionResponse>
SdkTransactionResponse with tx.
- Defined in packages/gasPools/gasPools.ts:129

getGrantTx

getGrantTx(
inputs: Omit<ApiGasPoolGrantBody, "txKind"> & { tx?: Transaction },
): Promise<SdkTransactionResponse>
Builds a transaction to grant another wallet access to the gas pool.
Parameters
- inputs: Omit<ApiGasPoolGrantBody, "txKind"> & { tx?: Transaction }
  - walletAddress
    
    Owner wallet address.
  - targetWalletAddress
    
    Wallet address to grant access to.
  - gasPoolArg
    
    Optional gas pool argument from a previously-built PTB command.
  - tx
    
    Optional transaction to extend.
  - Optionaltx?: Transaction
    
    Optional transaction to extend.
Returns Promise<SdkTransactionResponse>
SdkTransactionResponse with tx.
- Defined in packages/gasPools/gasPools.ts:212

getPool

getPool(inputs: ApiGasPoolBody): Promise<ApiGasPoolResponse>
Fetches the gas pool details for a given wallet address.
Parameters
- inputs: ApiGasPoolBody
  ApiGasPoolBody containing the wallet address.
Returns Promise<ApiGasPoolResponse>
ApiGasPoolResponse containing pool ID, balance, and whitelisted addresses.
- Defined in packages/gasPools/gasPools.ts:74

getRevokeTx

getRevokeTx(
inputs: Omit<ApiGasPoolRevokeBody, "txKind"> & { tx?: Transaction },
): Promise<SdkTransactionResponse>
Builds a transaction to revoke another wallet's access to the gas pool.
Parameters
- inputs: Omit<ApiGasPoolRevokeBody, "txKind"> & { tx?: Transaction }
  - walletAddress
    
    Owner wallet address.
  - targetWalletAddress
    
    Wallet address to revoke access from.
  - tx
    
    Optional transaction to extend.
  - Optionaltx?: Transaction
    
    Optional transaction to extend.
Returns Promise<SdkTransactionResponse>
SdkTransactionResponse with tx.
- Defined in packages/gasPools/gasPools.ts:235

getShareTx

getShareTx(
inputs: Omit<ApiGasPoolShareBody, "txKind"> & { tx?: Transaction },
): Promise<SdkTransactionResponse>
Builds a transaction to share a gas pool that was created with deferShare: true.

Use this after composing additional commands (deposit, grant, etc.) with the gasPoolArg returned by getCreateTx.
Parameters
- inputs: Omit<ApiGasPoolShareBody, "txKind"> & { tx?: Transaction }
  - gasPoolArg
    
    Gas pool argument from a deferred create.
  - sharePolicyArg
    
    Share policy argument from a deferred create.
  - tx
    
    Optional transaction to extend.
  - Optionaltx?: Transaction
    
    Optional transaction to extend.
Returns Promise<SdkTransactionResponse>
SdkTransactionResponse with tx.
- Defined in packages/gasPools/gasPools.ts:261

getSponsoredTransaction

getSponsoredTransaction(
inputs: Omit<ApiGasPoolSponsorBody, "txKind"> & { tx?: Transaction },
): Promise<ApiGasPoolSponsorResponse>
Requests a gas-pool-sponsored transaction. Returns a complete transaction with the gas payment and epoch bound attached, the sponsor's signature, and the digest both signatures commit to — the caller signs transaction as the sender and submits it together with sponsorSignature.
Parameters
- inputs: Omit<ApiGasPoolSponsorBody, "txKind"> & { tx?: Transaction }
  - walletAddress
    
    Wallet address requesting the sponsorship.
  - bytes
    
    Base64 of the signed SPONSOR_GAS auth message.
  - signature
    
    Signature over bytes.
  - tx
    
    Optional transaction to sponsor (appended as a tx kind).
  - Optionaltx?: Transaction
    
    Optional transaction to sponsor (appended as a tx kind).
Returns Promise<ApiGasPoolSponsorResponse>
ApiGasPoolSponsorResponse.
- Defined in packages/gasPools/gasPools.ts:188

getWithdrawTx

getWithdrawTx(
inputs: Omit<ApiGasPoolWithdrawBody, "txKind"> & { tx?: Transaction },
): Promise<Omit<ApiGasPoolWithdrawResponse, "txKind"> & { tx: Transaction }>
Builds a transaction to withdraw SUI from the gas pool.

When deferTransfer is true, the withdrawn coin is not transferred. Instead, withdrawnCoinArg is returned for further PTB composition.
Parameters
- inputs: Omit<ApiGasPoolWithdrawBody, "txKind"> & { tx?: Transaction }
  - walletAddress
    
    Wallet address submitting the withdrawal.
  - amount
    
    Amount of SUI to withdraw in MIST.
  - recipientAddress
    
    Optional recipient (defaults to walletAddress).
  - deferTransfer
    
    When true, returns the withdrawn coin arg instead of transferring.
  - gasPoolArg
    
    Optional gas pool argument from a previously-built PTB command.
  - tx
    
    Optional transaction to extend.
  - Optionaltx?: Transaction
    
    Optional transaction to extend.
Returns Promise<Omit<ApiGasPoolWithdrawResponse, "txKind"> & { tx: Transaction }>
tx plus optional withdrawnCoinArg when deferred.
- Defined in packages/gasPools/gasPools.ts:158

`Static`apiBaseUrlForNetwork

apiBaseUrlForNetwork(network: SuiNetwork): string
Returns the canonical Aftermath API host for a Sui network.

To target a custom or local host, pass baseUrl in CallerConfig to the constructor instead.
Parameters
- network: SuiNetwork
  The Sui network whose host to return.
Returns string
The network's HTTPS or local HTTP API host.
Inherited from Caller.apiBaseUrlForNetwork
- Defined in general/utils/caller.ts:151

`Static`defaultFullnodeUrl

defaultFullnodeUrl(network: SuiNetwork | undefined): string
Returns the canonical Sui fullnode URL for a network.
Parameters
- network: SuiNetwork | undefined
  The network whose fullnode URL to return. undefined defaults to mainnet.
Returns string
The network's fullnode URL.
Inherited from Caller.defaultFullnodeUrl
- Defined in general/utils/caller.ts:162

Class GasPools

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GasPools

Properties

Optional Readonlyapi

config

Methods

getCreateTx

Parameters

walletAddress

initialDepositAmount

deferShare

tx

Optionaltx?: Transaction

Returns Promise<Omit<ApiGasPoolCreateResponse, "txKind"> & { tx: Transaction }>

getDepositTx

Parameters

walletAddress

isSponsoredTx

coinType

amount

coinArg

slippage

gasPoolArg

tx

Optionaltx?: Transaction

Returns Promise<SdkTransactionResponse>

getGrantTx

Parameters

walletAddress

targetWalletAddress

gasPoolArg

tx

Optionaltx?: Transaction

Returns Promise<SdkTransactionResponse>

getPool

Parameters

Returns Promise<ApiGasPoolResponse>

getRevokeTx

Parameters

walletAddress

targetWalletAddress

tx

Optionaltx?: Transaction

Returns Promise<SdkTransactionResponse>

getShareTx

Parameters

gasPoolArg

sharePolicyArg

tx

Optionaltx?: Transaction

Returns Promise<SdkTransactionResponse>

getSponsoredTransaction

Parameters

walletAddress

bytes

signature

tx

Optionaltx?: Transaction

Returns Promise<ApiGasPoolSponsorResponse>

getWithdrawTx

Parameters

walletAddress

amount

recipientAddress

deferTransfer

gasPoolArg

tx

Optionaltx?: Transaction

Returns Promise<Omit<ApiGasPoolWithdrawResponse, "txKind"> & { tx: Transaction }>

StaticapiBaseUrlForNetwork

Parameters

`Optional` `Readonly`api

`Optional`tx?: Transaction

`Optional`tx?: Transaction

`Optional`tx?: Transaction

`Optional`tx?: Transaction

`Optional`tx?: Transaction

`Optional`tx?: Transaction

`Optional`tx?: Transaction

`Static`apiBaseUrlForNetwork

`Static`defaultFullnodeUrl