Class TransactionAPI

TransactionAPI is a class extending the BaseAPI class, providing methods for interacting with transactions and vault transactions. It includes methods for getting a single transaction or vault transaction and for getting multiple transactions or vault transactions with optional parameters for more specific queries.

Hierarchy

BaseAPI
- TransactionAPI

Index

Constructors

constructor

new TransactionAPI(premia): TransactionAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns TransactionAPI
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

getOptionPSTransaction

getOptionPSTransaction(hash): Promise<OptionPSTransaction>
Get a single optionPS transaction given its hash.

Remark
Uses caching with a one-minute time-to-live.
Parameters
- hash: string
  
  The hash of the optionPS transaction to retrieve.
Returns Promise<OptionPSTransaction>
A promise that resolves to the requested optionPS transaction.
- Defined in src/api/transactionAPI.ts:146

getOptionPSTransactions

getOptionPSTransactions(search, orderBy?, order?, limit?, skip?, account?, startTime?, endTime?, searchInput?): Promise<OptionPSTransaction[]>
Get a list of optionPS transactions with optional filter, search, order, and pagination parameters.

Remark
Uses caching with a one-minute time-to-live.
Parameters
- search: string
  
  The search query.
- Optional orderBy: string = 'timestamp'
  
  The attribute by which to order the optionPS transactions.
- Optional order: string = 'ASC'
  
  The order in which to return the vault transactions (ASC, DESC).
- Optional limit: number = 100
  
  The maximum number of optionPS transactions to return.
- Optional skip: number = 0
  
  The number of optionPS transactions to skip.
- Optional account: string
  
  The account associated with the optionPS transactions to return.
- Optional startTime: number
  
  The start time for the optionPS transactions to return.
- Optional endTime: number
  
  The end time for the optionPS transactions to return.
- Optional searchInput: string
  
  An additional search input.
Returns Promise<OptionPSTransaction[]>
A promise that resolves to a list of optionPS transactions.
- Defined in src/api/transactionAPI.ts:167

getTransaction

getTransaction(hash): Promise<Transaction>
Get a single transaction given its hash.

Remark
Uses caching with a one-minute time-to-live.
Parameters
- hash: string
  
  The hash of the transaction to retrieve.
Returns Promise<Transaction>
A promise that resolves to the requested transaction.
- Defined in src/api/transactionAPI.ts:21

getTransactions

getTransactions(filter, search, orderBy?, order?, limit?, skip?, type?, poolAddress?, account?, startTime?, endTime?, searchInput?): Promise<Transaction[]>
Get a list of transactions with optional filter, search, order, and pagination parameters.

Remark
Uses caching with a one-minute time-to-live.
Parameters
- filter: string
  
  The filter for the transaction search. (all, add, remove)
- search: string
  
  The search query.
- Optional orderBy: string = 'timestamp'
  
  The attribute by which to order the transactions.
- Optional order: string = 'ASC'
  
  The order in which to return the transactions (ASC, DESC).
- Optional limit: number = 100
  
  The maximum number of transactions to return.
- Optional skip: number = 0
  
  The number of transactions to skip.
- Optional type: string
  
  The type of transactions to return. (token, vault)
- Optional poolAddress: string
- Optional account: string
  
  The account associated with the transactions to return.
- Optional startTime: number
  
  The start time for the transactions to return.
- Optional endTime: number
  
  The end time for the transactions to return.
- Optional searchInput: string
  
  An additional search input.
Returns Promise<Transaction[]>
A promise that resolves to a list of transactions.
- Defined in src/api/transactionAPI.ts:44

getVaultTransaction

getVaultTransaction(hash): Promise<VaultTransaction>
Get a single vault transaction given its hash.

Remark
Uses caching with a one-minute time-to-live.
Parameters
- hash: string
  
  The hash of the vault transaction to retrieve.
Returns Promise<VaultTransaction>
A promise that resolves to the requested vault transaction.
- Defined in src/api/transactionAPI.ts:83

getVaultTransactions

getVaultTransactions(filter, search, orderBy?, order?, limit?, skip?, type?, vaultAddress?, account?, startTime?, endTime?, searchInput?): Promise<VaultTransaction[]>
Get a list of vault transactions with optional filter, search, order, and pagination parameters.

Remark
Uses caching with a one-minute time-to-live.
Parameters
- filter: string
  
  The filter for the vault transaction search. (all, add, remove)
- search: string
  
  The search query.
- Optional orderBy: string = 'timestamp'
  
  The attribute by which to order the vault transactions.
- Optional order: string = 'ASC'
  
  The order in which to return the vault transactions (ASC, DESC).
- Optional limit: number = 100
  
  The maximum number of vault transactions to return.
- Optional skip: number = 0
  
  The number of vault transactions to skip.
- Optional type: string
  
  The type of vault transactions to return.
- Optional vaultAddress: string
  
  The address of the vault associated with the vault transactions to return.
- Optional account: string
  
  The account associated with the vault transactions to return.
- Optional startTime: number
  
  The start time for the vault transactions to return.
- Optional endTime: number
  
  The end time for the vault transactions to return.
- Optional searchInput: string
  
  An additional search input.
Returns Promise<VaultTransaction[]>
A promise that resolves to a list of vault transactions.
- Defined in src/api/transactionAPI.ts:107

Class TransactionAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

premia: Premia

Returns TransactionAPI

Properties

Readonly premia

Protected streamIndex

Methods

cancelAllStreams

Returns Promise<void>

getOptionPSTransaction

Remark

Parameters

hash: string

Returns Promise<OptionPSTransaction>

getOptionPSTransactions

Remark

Parameters

search: string

Optional orderBy: string = 'timestamp'

Optional order: string = 'ASC'

Optional limit: number = 100

Optional skip: number = 0

Optional account: string

Optional startTime: number

Optional endTime: number

Optional searchInput: string

Returns Promise<OptionPSTransaction[]>

getTransaction

Remark

Parameters

hash: string

Returns Promise<Transaction>

getTransactions

Remark

Parameters

filter: string

search: string

Optional orderBy: string = 'timestamp'

Optional order: string = 'ASC'

Optional limit: number = 100

Optional skip: number = 0

Optional type: string

Optional poolAddress: string

Optional account: string

Optional startTime: number

Optional endTime: number

Optional searchInput: string

Returns Promise<Transaction[]>

getVaultTransaction

Remark

Parameters

hash: string

Returns Promise<VaultTransaction>

getVaultTransactions

Remark

Parameters

filter: string

search: string

Optional orderBy: string = 'timestamp'

Optional order: string = 'ASC'

Optional limit: number = 100

Optional skip: number = 0

Optional type: string

Optional vaultAddress: string

Optional account: string

Optional startTime: number

Optional endTime: number

Optional searchInput: string

Returns Promise<VaultTransaction[]>

Settings

Member Visibility

Theme

`Readonly` premia

`Protected` streamIndex

`Optional` orderBy: string = 'timestamp'

`Optional` order: string = 'ASC'

`Optional` limit: number = 100

`Optional` skip: number = 0

`Optional` account: string

`Optional` startTime: number

`Optional` endTime: number

`Optional` searchInput: string

`Optional` orderBy: string = 'timestamp'

`Optional` order: string = 'ASC'

`Optional` limit: number = 100

`Optional` skip: number = 0

`Optional` type: string

`Optional` poolAddress: string

`Optional` account: string

`Optional` startTime: number

`Optional` endTime: number

`Optional` searchInput: string

`Optional` orderBy: string = 'timestamp'

`Optional` order: string = 'ASC'

`Optional` limit: number = 100

`Optional` skip: number = 0

`Optional` type: string

`Optional` vaultAddress: string

`Optional` account: string

`Optional` startTime: number

`Optional` endTime: number

`Optional` searchInput: string