Class PremiaSubgraphAlpha

constructor

• new PremiaSubgraph(uri): PremiaSubgraph

• 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

  Returns PremiaSubgraph

client

Optional queryParams

uri

_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

_parsePairId

• _parsePairId(pair): string

• Parameters

  • pair: TokenPairOrId

  Returns string

getAllLastVaultVotes

• getAllLastVaultVotes(orderBy, order, first?, skip?): Promise<VaultVote[]>

• Parameters

  • orderBy: string

  • order: string

  • first: number = 100

  • skip: number = 0

  Returns Promise<VaultVote[]>

getAllVaultsExtended

• getAllVaultsExtended(): Promise<VaultExtended[]>

• Returns Promise<VaultExtended[]>

getLastUserStakeFromTimestamp

• getLastUserStakeFromTimestamp(timestamp, user): Promise<UserStake[]>

• Parameters

  • timestamp: number

  • user: string

  Returns Promise<UserStake[]>

getLastUserStakes

• getLastUserStakes(): Promise<UserStake[]>

• Returns Promise<UserStake[]>

getLiquidityPositionsExtendedForUser

• getLiquidityPositionsExtendedForUser(owner, orderType?): Promise<LiquidityPositionExtended[]>

• Parameters

  • owner: string

  • Optional orderType: OrderType

  Returns Promise<LiquidityPositionExtended[]>

getOptionPositionsExtendedForUser

• getOptionPositionsExtendedForUser(owner, isOpen?): Promise<OptionPositionExtended[]>

• Parameters

  • owner: string

  • Optional isOpen: boolean

  Returns Promise<OptionPositionExtended[]>

getPair

• getPair(pair): Promise<TokenPair>

• Parameters

  • pair: TokenPairOrInfo

  Returns Promise<TokenPair>

getPairExtended

• getPairExtended(pair): Promise<TokenPairExtended>

• Parameters

  • pair: TokenPairOrId

  Returns Promise<TokenPairExtended>

getPairs

• getPairs(pairs): Promise<TokenPair[]>

• Parameters

  • pairs: TokenPairOrId[]

  Returns Promise<TokenPair[]>

getPairsExtended

• getPairsExtended(pairs): Promise<TokenPairExtended[]>

• Parameters

  • pairs: TokenPairOrId[]

  Returns Promise<TokenPairExtended[]>

getPool

• getPool(address): Promise<Pool>

• Parameters

  • address: string

  Returns Promise<Pool>

getPoolExtended

• getPoolExtended(address): Promise<PoolExtended>

• Parameters

  • address: string

  Returns Promise<PoolExtended>

getPoolMinimal

• getPoolMinimal(address): Promise<PoolMinimal>

• Parameters

  • address: string

  Returns Promise<PoolMinimal>

getPools

• getPools(baseAddress): Promise<Pool[]>

• Parameters

  • baseAddress: string

  Returns Promise<Pool[]>

getPoolsExtended

• getPoolsExtended(baseAddress): Promise<PoolExtended[]>

• Parameters

  • baseAddress: string

  Returns Promise<PoolExtended[]>

getPoolsExtendedForPair

• getPoolsExtendedForPair(pair, options?): Promise<PoolExtended[]>

• Parameters

  • pair: TokenPairMinimal

  • Optional options: {
        maturity?: BigNumberish;
        strike?: BigNumberish;
    }

    • Optional maturity?: BigNumberish

    • Optional strike?: BigNumberish

  Returns Promise<PoolExtended[]>

getPoolsExtendedForToken

• getPoolsExtendedForToken(token, isQuote?): Promise<PoolExtended[]>

• Parameters

  • token: Token

  • isQuote: boolean = false

  Returns Promise<PoolExtended[]>

getPoolsForPair

• getPoolsForPair(pair): Promise<Pool[]>

• Parameters

  • pair: TokenPairMinimal

  Returns Promise<Pool[]>

getPoolsForPairId

• getPoolsForPairId(id): Promise<Pool[]>

• Parameters

  • id: string

  Returns Promise<Pool[]>

getPoolsForToken

• getPoolsForToken(token, isQuote?): Promise<Pool[]>

• Parameters

  • token: Token

  • isQuote: boolean = false

  Returns Promise<Pool[]>

getPoolsOrderbookData

• getPoolsOrderbookData(addresses): Promise<PoolDayData[]>

• Parameters

  • addresses: string[]

  Returns Promise<PoolDayData[]>

getQuotePools

• getQuotePools(tokenAddress, strike, maturity, isCall): Promise<PoolMinimal[]>

• Parameters

  • tokenAddress: string

  • strike: BigNumberish

  • maturity: BigNumberish

  • isCall: boolean

  Returns Promise<PoolMinimal[]>

getStakeHistories

• getStakeHistories(startTime, first?, skip?): Promise<StakeHistory[]>

• Parameters

  • startTime: number

  • first: number = 100

  • skip: number = 0

  Returns Promise<StakeHistory[]>

getStakeHistory

• getStakeHistory(id): Promise<StakeHistory>

• Parameters

  • id: string

  Returns Promise<StakeHistory>

getTick

• getTick(normalizedPrice, poolAddress): Promise<Tick>

• Parameters

  • normalizedPrice: BigNumberish

  • poolAddress: string

  Returns Promise<Tick>

getTicksForPool

• getTicksForPool(poolAddress): Promise<Tick[]>

• Parameters

  • poolAddress: string

  Returns Promise<Tick[]>

getToken

• getToken(address): Promise<Token>

• Parameters

  • address: string

  Returns Promise<Token>

getTokenExtended

• getTokenExtended(address): Promise<TokenExtended>

• Parameters

  • address: string

  Returns Promise<TokenExtended>

getTokenList

• getTokenList(tokenList): Promise<Token[]>

• Parameters

  • tokenList: TokenInfo[]

  Returns Promise<Token[]>

getTokenListExtended

• getTokenListExtended(tokenList): Promise<TokenExtended[]>

• Parameters

  • tokenList: TokenInfo[]

  Returns Promise<TokenExtended[]>

getTokens

• getTokens(tokens): Promise<Token[]>

• Parameters

  • tokens: string[]

  Returns Promise<Token[]>

getTokensExtended

• getTokensExtended(tokens): Promise<TokenExtended[]>

• Parameters

  • tokens: string[]

  Returns Promise<TokenExtended[]>

getTransaction

• getTransaction(hash): Promise<Transaction>

• Parameters

  • hash: string

  Returns Promise<Transaction>

getTransactions

• getTransactions(filter, search, orderBy?, order?, first?, skip?, type?, poolAddress?, account?, startTime?, endTime?, searchInput?): Promise<Transaction[]>

• Parameters

  • filter: string

  • search: string

  • orderBy: string = 'timestamp'

  • order: string = 'asc'

  • first: 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[]>

getUser

• getUser(address): Promise<User>

• Parameters

  • address: string

  Returns Promise<User>

getUserExtended

• getUserExtended(address): Promise<UserExtended>

• Parameters

  • address: string

  Returns Promise<UserExtended>

getUserPortfolio

• getUserPortfolio(address): Promise<UserPortfolio>

• Parameters

  • address: string

  Returns Promise<UserPortfolio>

getUserPortfolioExtended

• getUserPortfolioExtended(address): Promise<UserPortfolioExtended>

• Parameters

  • address: string

  Returns Promise<UserPortfolioExtended>

getUserSnapshot

• getUserSnapshot(address, timestamp): Promise<UserSnapshot>

• Parameters

  • address: string

  • timestamp: BigNumberish

  Returns Promise<UserSnapshot>

getUserSnapshotExtended

• getUserSnapshotExtended(address, timestamp): Promise<UserSnapshotExtended>

• Parameters

  • address: string

  • timestamp: BigNumberish

  Returns Promise<UserSnapshotExtended>

getUserSnapshots

• getUserSnapshots(address, startTime, endTime, orderBy?, order?, first?, skip?): Promise<UserSnapshot[]>

• Parameters

  • address: string

  • startTime: BigNumberish

  • endTime: BigNumberish

  • orderBy: string = 'timestamp'

  • order: string = 'asc'

  • first: number = 100

  • skip: number = 0

  Returns Promise<UserSnapshot[]>

getUserSnapshotsExtended

• getUserSnapshotsExtended(address, startTime, endTime, orderBy?, order?, first?, skip?): Promise<UserSnapshotExtended[]>

• Parameters

  • address: string

  • startTime: BigNumberish

  • endTime: BigNumberish

  • orderBy: string = 'timestamp'

  • order: string = 'asc'

  • first: number = 100

  • skip: number = 0

  Returns Promise<UserSnapshotExtended[]>

getUserStakes

• getUserStakes(startTime, user, first?, skip?): Promise<UserStake[]>

• Parameters

  • startTime: number

  • user: string

  • first: number = 100

  • skip: number = 0

  Returns Promise<UserStake[]>

getUserVaultVotesFromTimestamp

• getUserVaultVotesFromTimestamp(user, timestampFrom, timestampTo, first?, skip?): Promise<VaultVote[]>

• Parameters

  • user: string

  • timestampFrom: number

  • timestampTo: number

  • first: number = 100

  • skip: number = 0

  Returns Promise<VaultVote[]>

getUsers

• getUsers(addresses): Promise<User[]>

• Parameters

  • addresses: string[]

  Returns Promise<User[]>

getUsersExtended

• getUsersExtended(addresses): Promise<UserExtended[]>

• Parameters

  • addresses: string[]

  Returns Promise<UserExtended[]>

getVault

• getVault(address): Promise<Vault>

• Parameters

  • address: string

  Returns Promise<Vault>

getVaultDayData

• getVaultDayData(vaultAddress, startTime?, first?, skip?): Promise<VaultDayData[]>

• Parameters

  • vaultAddress: string

  • startTime: number = 0

  • first: number = 1000

  • skip: number = 0

  Returns Promise<VaultDayData[]>

getVaultExtended

• getVaultExtended(address): Promise<VaultExtended>

• Parameters

  • address: string

  Returns Promise<VaultExtended>

getVaultPosition

• getVaultPosition(owner, vaultAddress): Promise<VaultPosition>

• Parameters

  • owner: string

  • vaultAddress: string

  Returns Promise<VaultPosition>

getVaultPositionExtended

• getVaultPositionExtended(owner, vaultAddress): Promise<VaultPositionExtended>

• Parameters

  • owner: string

  • vaultAddress: string

  Returns Promise<VaultPositionExtended>

getVaultPositionsExtendedForUser

• getVaultPositionsExtendedForUser(owner): Promise<VaultPositionExtended[]>

• Parameters

  • owner: string

  Returns Promise<VaultPositionExtended[]>

getVaultTransaction

• getVaultTransaction(hash): Promise<VaultTransaction>

• Parameters

  • hash: string

  Returns Promise<VaultTransaction>

getVaultTransactions

• getVaultTransactions(filter, search, orderBy?, order?, first?, skip?, type?, vaultAddress?, account?, startTime?, endTime?, searchInput?): Promise<VaultTransaction[]>

• Parameters

  • filter: string

  • search: string

  • orderBy: string = 'timestamp'

  • order: string = 'asc'

  • first: 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[]>

getVaultVotes

• getVaultVotes(user, first?, skip?): Promise<VaultVote[]>

• Parameters

  • user: string

  • first: number = 100

  • skip: number = 0

  Returns Promise<VaultVote[]>

getVaults

• getVaults(baseAddress): Promise<Vault[]>

• Parameters

  • baseAddress: string

  Returns Promise<Vault[]>

getVaultsExtended

• getVaultsExtended(baseAddress): Promise<VaultExtended[]>

• Parameters

  • baseAddress: string

  Returns Promise<VaultExtended[]>

getVaultsExtendedForToken

• getVaultsExtendedForToken(token, isQuote?): Promise<VaultExtended[]>

• Parameters

  • token: Token

  • isQuote: boolean = false

  Returns Promise<VaultExtended[]>

getVaultsForToken

• getVaultsForToken(token, isQuote?): Promise<Vault[]>

• Parameters

  • token: Token

  • isQuote: boolean = false

  Returns Promise<Vault[]>

getVoteHistory

• getVoteHistory(id): Promise<VoteHistory>

• Parameters

  • id: string

  Returns Promise<VoteHistory>

optionType

• optionType(isCall): bigint

• Parameters

  • isCall: boolean

  Returns bigint

setQueryParams

• setQueryParams(queryParams): void

• Parameters

  • queryParams: QueryParams

  Returns void

spotPrice

• spotPrice(address): Promise<bigint>

• Parameters

  • address: string

  Returns Promise<bigint>

tradeSide

• tradeSide(isBuy): bigint

• Parameters

  • isBuy: boolean

  Returns bigint