@premia/v3-sdk

References

ERC20Mock__factory IERC1155__factory IERC20Router__factory IERC4626__factory IOracleAdapter__factory IOwnable__factory IPoolFactory__factory IPool__factory IPremiaStaking__factory IUserSettings__factory IVaultRegistry__factory IVault__factory IVolatilityOracle__factory IVxPremia__factory OrderbookStream__factory PoolFactory__factory SolidStateERC20__factory

Namespaces

IPoolFactory IPremiaStaking IVaultRegistry OrderbookStream factories

Enumerations

AdapterType CacheTTL ChainId CoingeckoTokenId InvalidQuoteError OptionType OrderType SupportedChainId TokenType TokenTypeString TransactionType VaultTradeSide VaultTransactionType VoteVersion

Classes

AnalyticsAPI AnalyticsQuery BlockQuery Coingecko ContractAPI FactoryQuery LiquidityPositionQuery OptionAPI OptionPositionQuery OrderbookV1 OrdersAPI PoolAPI PoolQuery Premia PremiaSubgraph PricingAPI TickQuery TokenAPI TokenPairAPI TokenPairQuery TokenQuery TransactionAPI TransactionQuery UserAPI UserQuery VaultAPI VaultPositionQuery VaultQuery VaultRegistryQuery VaultTransactionQuery VolatilitySurfaceQuery VxPremiaAPI VxPremiaQuery

Interfaces

ActionAuthorization AddressMap AuthMessage Domain ERC20Mock Factory FactoryExtended FactoryMinimal FillableQuote IERC1155 IERC20Router IERC4626 IOracleAdapter IOwnable IPool IPoolFactory IPremiaStaking IUserSettings IVault IVaultRegistry IVolatilityOracle IVxPremia JSONArray JSONObject JSONReference LiquidityPosition LiquidityPositionExtended OptionPosition OptionPositionExtended OrderbookQuote OrderbookStream PairInfo PairList PairVote Pool PoolDayData PoolExtended PoolFactory PoolHourData PoolKey PoolMinimal PositionKey PremiaConfig PremiaConfigWithDefaults QueryParams Quote QuoteOB QuoteOBMessage QuoteSaltOptional QuoteWithSignature QuoteWithoutSalt SerializedIndexedQuote SerializedQuote SerializedQuoteSaltOptional SerializedQuoteWithSignature SerializedQuoteWithoutSalt SetProviderParams SetSignerParams Signature SignatureDomain SolidStateERC20 StakeHistory StakeReward SubgraphParams Tags Tick TickMinimal Token TokenExtended TokenIdParams TokenInfo TokenMinimal TokenPair TokenPairExtended TokenPairMinimal TokenPriceNode Transaction User UserExtended UserPortfolio UserPortfolioExtended UserPortfolioHistory UserSnapshot UserSnapshotExtended UserStake ValidQuoteResponse Vault VaultDayData VaultExtended VaultMinimal VaultPosition VaultPositionExtended VaultRegistry VaultRegistryExtended VaultTransaction VaultVote Version VolatilitySurface Vote VoteHistory WSDeleteQuoteMessage WSErrorMessage WSFilterMessage WSInfoMessage WSPostQuoteMessage WSRFQMessage WSRFQRequest WSUnsubscribeMessage

Type Aliases

ChannelType JSONContainer JSONValue PromiseOrValue QuoteOrFillableQuoteT QuoteSaltOptionalT QuoteT QuoteWithSignatureT TokenOrAddress TokenPairOrId TokenPairOrInfo Web3Window

Properties

ERC20MockAbi IERC20RouterAbi IOracleAdapterAbi IPoolAbi IPoolFactoryAbi IPremiaStakingAbi IUserSettingsAbi IVaultAbi IVaultRegistryAbi IVxPremiaAbi OrderbookStreamAbi SolidStateERC20Abi

Variables

Addresses CHAINLINK_BTC CHAINLINK_ETH CHAINLINK_USD CoingeckoChainKey DefaultApolloClientOptions EIP712Domain ETH_DECIMALS FRIDAY FactoryExtendedFragment FactoryFragment FactoryMinimalFragment LiquidityPositionExtendedFragment LiquidityPositionFragment MAX_TICK_PRICE MIN_TICK_DISTANCE MIN_TICK_PRICE ONE_BI ONE_YEAR_MS OptionPositionExtendedFragment OptionPositionFragment PairVoteFragment PoolDayDataFragment PoolDayOrderbookDataFragment PoolExtendedFragment PoolFragment PoolHourDataFragment PoolMinimalFragment StakeHistoryFragment TickFragment TokenExtendedFragment TokenFragment TokenMinimalFragment TokenPairExtendedFragment TokenPairFragment TokenPairMinimalFragment TokenPriceNodeFieldsFragment TokenPriceNodeFragment TransactionFragment USD_DECIMALS UserExtendedFragment UserFragment UserPortfolioExtendedFragment UserPortfolioFragment UserSnapshotExtendedFragment UserSnapshotFragment UserStakeFragment VaultDayDataFragment VaultExtendedFragment VaultFragment VaultMinimalFragment VaultPositionExtendedFragment VaultPositionFragment VaultRegistryExtendedFragment VaultRegistryFragment VaultTransactionFragment VaultVoteFragment VolatilitySurfaceFragment VoteHistoryFragment WAD_BI WAD_DECIMALS ZERO_BI baseTokenList baseTokens blackScholes defaultPairs quoteTokenList quoteTokens

Functions

addFields addFieldsToQuery convertDecimals formatBigInt formatCompact formatNumber formatTokenId nextYearOfMaturities parseBigInt parseDate parseNumber precisionForNumber removeLeadingZeros resolveReferences send sendTransaction signData stringListToJson

References

ERC20Mock__factory

Re-exports ERC20Mock__factory

IERC1155__factory

Re-exports IERC1155__factory

IERC20Router__factory

Re-exports IERC20Router__factory

IERC4626__factory

Re-exports IERC4626__factory

IOracleAdapter__factory

Re-exports IOracleAdapter__factory

IOwnable__factory

Re-exports IOwnable__factory

IPoolFactory__factory

Re-exports IPoolFactory__factory

IPool__factory

Re-exports IPool__factory

IPremiaStaking__factory

Re-exports IPremiaStaking__factory

IUserSettings__factory

Re-exports IUserSettings__factory

IVaultRegistry__factory

Re-exports IVaultRegistry__factory

IVault__factory

Re-exports IVault__factory

IVolatilityOracle__factory

Re-exports IVolatilityOracle__factory

IVxPremia__factory

Re-exports IVxPremia__factory

OrderbookStream__factory

Re-exports OrderbookStream__factory

PoolFactory__factory

Re-exports PoolFactory__factory

SolidStateERC20__factory

Re-exports SolidStateERC20__factory

Properties

ERC20MockAbi

ERC20MockAbi: ({
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name?: undefined;
    outputs?: undefined;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[]

IERC20RouterAbi

IERC20RouterAbi: ({
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: never[];
    stateMutability: string;
    type: string;
})[]

IOracleAdapterAbi

IOracleAdapterAbi: ({
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[]

IPoolAbi

IPoolAbi: ({
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: ({
        components?: undefined;
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    } | {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: ({
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    } | {
        components?: undefined;
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs: ({
        components?: undefined;
        internalType: string;
        name: string;
        type: string;
    } | {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    })[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs: {
        components: ({
            components: {
                internalType: string;
                name: string;
                type: string;
            }[];
            internalType: string;
            name: string;
            type: string;
        } | {
            components?: undefined;
            internalType: string;
            name: string;
            type: string;
        })[];
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[]

IPoolFactoryAbi

IPoolFactoryAbi: ({
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[]

IPremiaStakingAbi

IPremiaStakingAbi: ({
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: ({
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    } | {
        components?: undefined;
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs: never[];
    stateMutability: string;
    type: string;
})[]

IUserSettingsAbi

IUserSettingsAbi: ({
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[]

IVaultAbi

IVaultAbi: ({
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: ({
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    } | {
        components?: undefined;
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[]

IVaultRegistryAbi

IVaultRegistryAbi: ({
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: ({
        components?: undefined;
        internalType: string;
        name: string;
        type: string;
    } | {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs: never[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[]

IVxPremiaAbi

IVxPremiaAbi: ({
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: ({
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    } | {
        components?: undefined;
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs: never[];
    stateMutability: string;
    type: string;
})[]

OrderbookStreamAbi

OrderbookStreamAbi: ({
    anonymous: boolean;
    inputs: ({
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    } | {
        components?: undefined;
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        components: ({
            components: {
                internalType: string;
                name: string;
                type: string;
            }[];
            internalType: string;
            name: string;
            type: string;
        } | {
            components?: undefined;
            internalType: string;
            name: string;
            type: string;
        })[];
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: never[];
    stateMutability: string;
    type: string;
})[]

SolidStateERC20Abi

SolidStateERC20Abi: ({
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc