Class PremiaVoidnode`Alpha`

The PremiaVoidnode class is the entry point for interacting with the Premia V3 voidnode server to query on-chain and indexed data using various APIs and services.

Hierarchy

PremiaVoidnode

Index

Constructors

constructor

new PremiaVoidnode(uri, authentication?): PremiaVoidnode
Creates a new Premia V3 SDK instance.

Remarks
The SDK needs to be initialized before it can be used with non-default parameters.
Parameters
- uri: string
- Optional authentication: VoidnodeAuthentication
Returns PremiaVoidnode
- Defined in src/services/voidnode/index.ts:108

Properties

client

client: ApolloClient<NormalizedCacheObject>

The apollo voidnode client used to fetch data from the Premia voidnode server.

Default Value

ApolloClient

`Optional` queryParams

queryParams?: QueryParams

The voidnode-specific parameters to be used for upcoming voidnode queries.

Default Value

{} (empty object)

uri

uri: string

The voidnode URL to use for fetching indexed contract data.

Methods

_parsePair

_parsePair(pair): {
    base: string;
    priceOracleAddress: string;
    quote: string;
}
Parameters
- pair: TokenPairOrId
Returns {
    base: string;
    priceOracleAddress: string;
    quote: string;
}
- base: string
- priceOracleAddress: string
- quote: string
- Defined in src/services/voidnode/index.ts:173

_parsePairId

_parsePairId(pair): string
Parameters
- pair: TokenPairOrId
Returns string
- Defined in src/services/voidnode/index.ts:158

_parseTokenAddress

_parseTokenAddress(token): string
Parses a token input to return a token address string.
Parameters
- token: TokenOrAddress
  
  The token input which can be either a Token object or a string representing the address.
Returns string
- The token address as a string.
- Defined in src/services/voidnode/index.ts:148

getAllLastVaultVotes

getAllLastVaultVotes(orderBy, order, limit?, skip?): Promise<VaultVote[]>
Parameters
- orderBy: string
- order: string
- limit: number = 100
- skip: number = 0
Returns Promise<VaultVote[]>
- Defined in src/services/voidnode/index.ts:1025

getAllPairs

getAllPairs(): Promise<TokenPair[]>
Returns Promise<TokenPair[]>
- Defined in src/services/voidnode/index.ts:600

getAllPairsExtended

getAllPairsExtended(): Promise<TokenPairExtended[]>
Returns Promise<TokenPairExtended[]>
- Defined in src/services/voidnode/index.ts:608

getAllPools

getAllPools(): Promise<Pool[]>
Returns Promise<Pool[]>
- Defined in src/services/voidnode/index.ts:311

getAllPoolsExtended

getAllPoolsExtended(): Promise<PoolExtended[]>
Returns Promise<PoolExtended[]>
- Defined in src/services/voidnode/index.ts:326

getAllTokens

getAllTokens(): Promise<Token[]>
Returns Promise<Token[]>
- Defined in src/services/voidnode/index.ts:520

getAllTokensExtended

getAllTokensExtended(): Promise<TokenExtended[]>
Returns Promise<TokenExtended[]>
- Defined in src/services/voidnode/index.ts:528

getAllVaultsExtended

getAllVaultsExtended(): Promise<VaultExtended[]>
Returns Promise<VaultExtended[]>
- Defined in src/services/voidnode/index.ts:901

getLastUserStakeFromTimestamp

getLastUserStakeFromTimestamp(timestamp, user): Promise<UserStake[]>
Parameters
- timestamp: number
- user: string
Returns Promise<UserStake[]>
- Defined in src/services/voidnode/index.ts:1073

getLastUserStakes

getLastUserStakes(): Promise<UserStake[]>
Returns Promise<UserStake[]>
- Defined in src/services/voidnode/index.ts:1052

getLiquidityPositionsExtendedForUser

getLiquidityPositionsExtendedForUser(owner, orderType?, isOpen?): Promise<LiquidityPositionExtended[]>
Parameters
- owner: string
- Optional orderType: OrderType
- Optional isOpen: boolean
Returns Promise<LiquidityPositionExtended[]>
- Defined in src/services/voidnode/index.ts:1146

getOptionPSTransaction

getOptionPSTransaction(hash): Promise<OptionPSTransaction>
Parameters
- hash: string
Returns Promise<OptionPSTransaction>
- Defined in src/services/voidnode/index.ts:704

getOptionPSTransactions

getOptionPSTransactions(search, orderBy?, order?, limit?, skip?, account?, startTime?, endTime?, searchInput?): Promise<OptionPSTransaction[]>
Parameters
- search: string
- orderBy: string = 'timestamp'
- order: string = 'ASC'
- limit: number = 100
- skip: number = 0
- Optional account: string
- Optional startTime: number
- Optional endTime: number
- Optional searchInput: string
Returns Promise<OptionPSTransaction[]>
- Defined in src/services/voidnode/index.ts:715

getOptionPositionsExtendedForUser

getOptionPositionsExtendedForUser(owner, isOpen?): Promise<OptionPositionExtended[]>
Parameters
- owner: string
- Optional isOpen: boolean
Returns Promise<OptionPositionExtended[]>
- Defined in src/services/voidnode/index.ts:1104

getPair

getPair(pair): Promise<TokenPair>
Parameters
- pair: TokenPairOrId
Returns Promise<TokenPair>
- Defined in src/services/voidnode/index.ts:552

getPairExtended

getPairExtended(pair): Promise<TokenPairExtended>
Parameters
- pair: TokenPairOrId
Returns Promise<TokenPairExtended>
- Defined in src/services/voidnode/index.ts:567

getPairs

getPairs(pairs): Promise<TokenPair[]>
Parameters
- pairs: TokenPairOrId[]
Returns Promise<TokenPair[]>
- Defined in src/services/voidnode/index.ts:581

getPairsExtended

getPairsExtended(pairs): Promise<TokenPairExtended[]>
Parameters
- pairs: TokenPairOrId[]
Returns Promise<TokenPairExtended[]>
- Defined in src/services/voidnode/index.ts:590

getPool

getPool(address): Promise<Pool>
Parameters
- address: string
Returns Promise<Pool>
- Defined in src/services/voidnode/index.ts:246

getPoolExtended

getPoolExtended(address): Promise<PoolExtended>
Parameters
- address: string
Returns Promise<PoolExtended>
- Defined in src/services/voidnode/index.ts:261

getPoolMinimal

getPoolMinimal(address): Promise<PoolMinimal>
Parameters
- address: string
Returns Promise<PoolMinimal>
- Defined in src/services/voidnode/index.ts:231

getPools

getPools(baseAddress, isExpired?): Promise<Pool[]>
Parameters
- baseAddress: string
- Optional isExpired: boolean
Returns Promise<Pool[]>
- Defined in src/services/voidnode/index.ts:276

getPoolsExtended

getPoolsExtended(baseAddress, isExpired?): Promise<PoolExtended[]>
Parameters
- baseAddress: string
- Optional isExpired: boolean
Returns Promise<PoolExtended[]>
- Defined in src/services/voidnode/index.ts:291

getPoolsExtendedForPair

getPoolsExtendedForPair(pair, options?): Promise<PoolExtended[]>
Parameters
- pair: TokenPairOrId
- Optional options: {
      isExpired?: boolean;
      maturity?: BigNumberish;
      strike?: BigNumberish;
  }
  - Optional isExpired?: boolean
  - Optional maturity?: BigNumberish
  - Optional strike?: BigNumberish
Returns Promise<PoolExtended[]>
- Defined in src/services/voidnode/index.ts:409

getPoolsExtendedForToken

getPoolsExtendedForToken(token, isQuote?): Promise<PoolExtended[]>
Parameters
- token: Token
- isQuote: boolean = false
Returns Promise<PoolExtended[]>
- Defined in src/services/voidnode/index.ts:363

getPoolsForPair

getPoolsForPair(pair, isExpired?): Promise<Pool[]>
Parameters
- pair: TokenPairOrId
- Optional isExpired: boolean
Returns Promise<Pool[]>
- Defined in src/services/voidnode/index.ts:391

getPoolsForPairId

getPoolsForPairId(id): Promise<Pool[]>
Parameters
- id: string
Returns Promise<Pool[]>
- Defined in src/services/voidnode/index.ts:383

getPoolsForToken

getPoolsForToken(token, isQuote?): Promise<Pool[]>
Parameters
- token: Token
- isQuote: boolean = false
Returns Promise<Pool[]>
- Defined in src/services/voidnode/index.ts:343

getPoolsOrderbookData

getPoolsOrderbookData(addresses): Promise<PoolDayData[]>
Parameters
- addresses: string[]
Returns Promise<PoolDayData[]>
- Defined in src/services/voidnode/index.ts:223

getQuotePools

getQuotePools(tokenAddress, strike, maturity, isCall): Promise<PoolMinimal[]>
Parameters
- tokenAddress: string
- strike: BigNumberish
- maturity: BigNumberish
- isCall: boolean
Returns Promise<PoolMinimal[]>
- Defined in src/services/voidnode/index.ts:445

getRewardOptionPositionsExtendedForUser

getRewardOptionPositionsExtendedForUser(owner, timestamp?, isOpen?): Promise<OptionPositionExtended[]>
Parameters
- owner: string
- Optional timestamp: number
- Optional isOpen: boolean
Returns Promise<OptionPositionExtended[]>
- Defined in src/services/voidnode/index.ts:1124

getStakeHistories

getStakeHistories(startTime, limit?, skip?): Promise<StakeHistory[]>
Parameters
- startTime: number
- limit: number = 100
- skip: number = 0
Returns Promise<StakeHistory[]>
- Defined in src/services/voidnode/index.ts:1092

getStakeHistory

getStakeHistory(id): Promise<StakeHistory>
Parameters
- id: string
Returns Promise<StakeHistory>
- Defined in src/services/voidnode/index.ts:1084

getTick

getTick(normalizedPrice, poolAddress): Promise<Tick>
Parameters
- normalizedPrice: BigNumberish
- poolAddress: string
Returns Promise<Tick>
- Defined in src/services/voidnode/index.ts:464

getTicksForPool

getTicksForPool(poolAddress): Promise<Tick[]>
Parameters
- poolAddress: string
Returns Promise<Tick[]>
- Defined in src/services/voidnode/index.ts:431

getToken

getToken(address): Promise<Token>
Parameters
- address: string
Returns Promise<Token>
- Defined in src/services/voidnode/index.ts:488

getTokenExtended

getTokenExtended(address): Promise<TokenExtended>
Parameters
- address: string
Returns Promise<TokenExtended>
- Defined in src/services/voidnode/index.ts:496

getTokenList

getTokenList(tokenList): Promise<Token[]>
Parameters
- tokenList: TokenInfo[]
Returns Promise<Token[]>
- Defined in src/services/voidnode/index.ts:536

getTokenListExtended

getTokenListExtended(tokenList): Promise<TokenExtended[]>
Parameters
- tokenList: TokenInfo[]
Returns Promise<TokenExtended[]>
- Defined in src/services/voidnode/index.ts:544

getTokens

getTokens(tokens): Promise<Token[]>
Parameters
- tokens: string[]
Returns Promise<Token[]>
- Defined in src/services/voidnode/index.ts:504

getTokensExtended

getTokensExtended(tokens): Promise<TokenExtended[]>
Parameters
- tokens: string[]
Returns Promise<TokenExtended[]>
- Defined in src/services/voidnode/index.ts:512

getTradingCompetitionUser

getTradingCompetitionUser(address): Promise<TradingCompetitionUser>
Parameters
- address: string
Returns Promise<TradingCompetitionUser>
- Defined in src/services/voidnode/index.ts:747

getTransaction

getTransaction(hash): Promise<Transaction>
Parameters
- hash: string
Returns Promise<Transaction>
- Defined in src/services/voidnode/index.ts:617

getTransactions

getTransactions(filter, search, orderBy?, order?, limit?, skip?, type?, poolAddress?, account?, startTime?, endTime?, searchInput?): Promise<Transaction[]>
Parameters
- filter: string
- search: string
- orderBy: string = 'timestamp'
- order: string = 'ASC'
- limit: number = 100
- skip: number = 0
- Optional type: string
- Optional poolAddress: string
- Optional account: string
- Optional startTime: number
- Optional endTime: number
- Optional searchInput: string
Returns Promise<Transaction[]>
- Defined in src/services/voidnode/index.ts:625

getUser

getUser(address): Promise<User>
Parameters
- address: string
Returns Promise<User>
- Defined in src/services/voidnode/index.ts:760

getUserExtended

getUserExtended(address): Promise<UserExtended>
Parameters
- address: string
Returns Promise<UserExtended>
- Defined in src/services/voidnode/index.ts:768

getUserPortfolio

getUserPortfolio(address): Promise<UserPortfolio>
Parameters
- address: string
Returns Promise<UserPortfolio>
- Defined in src/services/voidnode/index.ts:867

getUserPortfolioExtended

getUserPortfolioExtended(address): Promise<UserPortfolioExtended>
Parameters
- address: string
Returns Promise<UserPortfolioExtended>
- Defined in src/services/voidnode/index.ts:875

getUserReferrals

getUserReferrals(user, limit?, skip?): Promise<Referral[]>
Parameters
- user: string
- limit: number = 1000
- skip: number = 0
Returns Promise<Referral[]>
- Defined in src/services/voidnode/index.ts:1166

getUserSnapshot

getUserSnapshot(address, timestamp): Promise<UserSnapshot>
Parameters
- address: string
- timestamp: BigNumberish
Returns Promise<UserSnapshot>
- Defined in src/services/voidnode/index.ts:792

getUserSnapshotExtended

getUserSnapshotExtended(address, timestamp): Promise<UserSnapshotExtended>
Parameters
- address: string
- timestamp: BigNumberish
Returns Promise<UserSnapshotExtended>
- Defined in src/services/voidnode/index.ts:803

getUserSnapshots

getUserSnapshots(address, startTime, endTime, orderBy?, order?, limit?, skip?): Promise<UserSnapshot[]>
Parameters
- address: string
- startTime: BigNumberish
- endTime: BigNumberish
- orderBy: string = 'timestamp'
- order: string = 'ASC'
- limit: number = 100
- skip: number = 0
Returns Promise<UserSnapshot[]>
- Defined in src/services/voidnode/index.ts:814

getUserSnapshotsExtended

getUserSnapshotsExtended(address, startTime, endTime, orderBy?, order?, limit?, skip?): Promise<UserSnapshotExtended[]>
Parameters
- address: string
- startTime: BigNumberish
- endTime: BigNumberish
- orderBy: string = 'timestamp'
- order: string = 'ASC'
- limit: number = 100
- skip: number = 0
Returns Promise<UserSnapshotExtended[]>
- Defined in src/services/voidnode/index.ts:839

getUserStakes

getUserStakes(startTime, user, limit?, skip?): Promise<UserStake[]>
Parameters
- startTime: number
- user: string
- limit: number = 100
- skip: number = 0
Returns Promise<UserStake[]>
- Defined in src/services/voidnode/index.ts:1060

getUserVaultVotesFromTimestamp

getUserVaultVotesFromTimestamp(user, timestampFrom, timestampTo, limit?, skip?): Promise<VaultVote[]>
Parameters
- user: string
- timestampFrom: number
- timestampTo: number
- limit: number = 100
- skip: number = 0
Returns Promise<VaultVote[]>
- Defined in src/services/voidnode/index.ts:1004

getUsers

getUsers(addresses): Promise<User[]>
Parameters
- addresses: string[]
Returns Promise<User[]>
- Defined in src/services/voidnode/index.ts:776

getUsersExtended

getUsersExtended(addresses): Promise<UserExtended[]>
Parameters
- addresses: string[]
Returns Promise<UserExtended[]>
- Defined in src/services/voidnode/index.ts:784

getVault

getVault(address): Promise<Vault>
Parameters
- address: string
Returns Promise<Vault>
- Defined in src/services/voidnode/index.ts:885

getVaultDayData

getVaultDayData(vaultAddress, startTime?, limit?, skip?): Promise<VaultDayData[]>
Parameters
- vaultAddress: string
- startTime: number = 0
- limit: number = 1000
- skip: number = 0
Returns Promise<VaultDayData[]>
- Defined in src/services/voidnode/index.ts:204

getVaultExtended

getVaultExtended(address): Promise<VaultExtended>
Parameters
- address: string
Returns Promise<VaultExtended>
- Defined in src/services/voidnode/index.ts:893

getVaultPosition

getVaultPosition(owner, vaultAddress): Promise<VaultPosition>
Parameters
- owner: string
- vaultAddress: string
Returns Promise<VaultPosition>
- Defined in src/services/voidnode/index.ts:961

getVaultPositionExtended

getVaultPositionExtended(owner, vaultAddress): Promise<VaultPositionExtended>
Parameters
- owner: string
- vaultAddress: string
Returns Promise<VaultPositionExtended>
- Defined in src/services/voidnode/index.ts:973

getVaultPositionsExtendedForUser

getVaultPositionsExtendedForUser(owner): Promise<VaultPositionExtended[]>
Parameters
- owner: string
Returns Promise<VaultPositionExtended[]>
- Defined in src/services/voidnode/index.ts:947

getVaultTransaction

getVaultTransaction(hash): Promise<VaultTransaction>
Parameters
- hash: string
Returns Promise<VaultTransaction>
- Defined in src/services/voidnode/index.ts:661

getVaultTransactions

getVaultTransactions(filter, search, orderBy?, order?, limit?, skip?, type?, vaultAddress?, account?, startTime?, endTime?, searchInput?): Promise<VaultTransaction[]>
Parameters
- filter: string
- search: string
- orderBy: string = 'timestamp'
- order: string = 'ASC'
- limit: number = 100
- skip: number = 0
- Optional type: string
- Optional vaultAddress: string
- Optional account: string
- Optional startTime: number
- Optional endTime: number
- Optional searchInput: string
Returns Promise<VaultTransaction[]>
- Defined in src/services/voidnode/index.ts:669

getVaultVotes

getVaultVotes(user, limit?, skip?): Promise<VaultVote[]>
Parameters
- user: string
- limit: number = 100
- skip: number = 0
Returns Promise<VaultVote[]>
- Defined in src/services/voidnode/index.ts:992

getVaults

getVaults(baseAddress): Promise<Vault[]>
Parameters
- baseAddress: string
Returns Promise<Vault[]>
- Defined in src/services/voidnode/index.ts:909

getVaultsExtended

getVaultsExtended(baseAddress): Promise<VaultExtended[]>
Parameters
- baseAddress: string
Returns Promise<VaultExtended[]>
- Defined in src/services/voidnode/index.ts:917

getVaultsExtendedForToken

getVaultsExtendedForToken(token, isQuote?): Promise<VaultExtended[]>
Parameters
- token: TokenOrAddress
- isQuote: boolean = false
Returns Promise<VaultExtended[]>
- Defined in src/services/voidnode/index.ts:936

getVaultsForToken

getVaultsForToken(token, isQuote?): Promise<Vault[]>
Parameters
- token: TokenOrAddress
- isQuote: boolean = false
Returns Promise<Vault[]>
- Defined in src/services/voidnode/index.ts:925

getVoteHistory

getVoteHistory(id): Promise<VoteHistory>
Parameters
- id: string
Returns Promise<VoteHistory>
- Defined in src/services/voidnode/index.ts:1044

optionType

optionType(isCall): bigint
Parameters
- isCall: boolean
Returns bigint
- Defined in src/services/voidnode/index.ts:200

setQueryParams

setQueryParams(queryParams): void
Parameters
- queryParams: QueryParams
Returns void
- Defined in src/services/voidnode/index.ts:133

spotPrice

spotPrice(address): Promise<bigint>
Parameters
- address: string
Returns Promise<bigint>
- Defined in src/services/voidnode/index.ts:478

tradeSide

tradeSide(isBuy): bigint
Parameters
- isBuy: boolean
Returns bigint
- Defined in src/services/voidnode/index.ts:196

Class PremiaVoidnodeAlpha

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Remarks

Parameters

uri: string

Optional authentication: VoidnodeAuthentication

Returns PremiaVoidnode

Properties

client

Default Value

Optional queryParams

Default Value

uri

Methods

_parsePair

Parameters

pair: TokenPairOrId

Returns { base: string; priceOracleAddress: string; quote: string; }

base: string

priceOracleAddress: string

quote: string

_parsePairId

Parameters

pair: TokenPairOrId

Returns string

_parseTokenAddress

Parameters

token: TokenOrAddress

Returns string

getAllLastVaultVotes

Parameters

orderBy: string

order: string

limit: number = 100

skip: number = 0

Returns Promise<VaultVote[]>

getAllPairs

Returns Promise<TokenPair[]>

getAllPairsExtended

Returns Promise<TokenPairExtended[]>

getAllPools

Returns Promise<Pool[]>

getAllPoolsExtended

Returns Promise<PoolExtended[]>

getAllTokens

Returns Promise<Token[]>

getAllTokensExtended

Returns Promise<TokenExtended[]>

getAllVaultsExtended

Returns Promise<VaultExtended[]>

getLastUserStakeFromTimestamp

Parameters

timestamp: number

user: string

Returns Promise<UserStake[]>

getLastUserStakes

Returns Promise<UserStake[]>

getLiquidityPositionsExtendedForUser

Parameters

owner: string

Optional orderType: OrderType

Optional isOpen: boolean

Returns Promise<LiquidityPositionExtended[]>

getOptionPSTransaction

Parameters

hash: string

Returns Promise<OptionPSTransaction>

getOptionPSTransactions

Parameters

search: string

orderBy: string = 'timestamp'

order: string = 'ASC'

limit: number = 100

skip: number = 0

Class PremiaVoidnode`Alpha`

`Optional` authentication: VoidnodeAuthentication

`Optional` queryParams

Returns {
base: string;
priceOracleAddress: string;
quote: string;
}

`Optional` orderType: OrderType

`Optional` isOpen: boolean

`Optional` account: string

`Optional` startTime: number

`Optional` endTime: number

`Optional` searchInput: string

`Optional` isOpen: boolean

`Optional` isExpired: boolean

`Optional` isExpired: boolean

`Optional` options: {
isExpired?: boolean;
maturity?: BigNumberish;
strike?: BigNumberish;
}

`Optional` isExpired?: boolean

`Optional` maturity?: BigNumberish

`Optional` strike?: BigNumberish

`Optional` isExpired: boolean