Class GasAPI

Represents a class for managing gas in transactions.

Hierarchy

BaseAPI
- GasAPI

Index

Constructors

Properties

premia streamIndex

Methods

cancelAllStreams getGasPrice

Constructors

constructor

new GasAPI(premia): GasAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns GasAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:25

Properties

`Readonly` premia

premia: Premia

The Premia SDK instance.

`Protected` streamIndex

streamIndex: number = 0

The current index of quote streams. Used to cancel stale streams.

Methods

cancelAllStreams

cancelAllStreams(): Promise<void>
Cancels all ongoing streams.

Returns Promise<void>
Inherited from BaseAPI.cancelAllStreams
- Defined in src/api/baseAPI.ts:34

getGasPrice

getGasPrice(provider?): Promise<bigint>
Returns a promise containing the gas price.
Parameters
- Optional provider: JsonRpcProvider
Returns Promise<bigint>
Promise containing the gas price.
- Defined in src/api/gasAPI.ts:15

Generated using TypeDoc