Optional apiOptional apiThe API key to use for fetching data from the Premia API.
Optional apiThe base websocket URL to use for streaming data from the Premia API.
Optional chainOptional coingeckoThe base URL to use for fetching data from the Coingecko API.
Optional coingeckoThe API Key to use for fetching data from the Coingecko Pro API.
Optional disableOptional novaA string representing a wallet's secret phrase for use with the novaProvider,
to instantiate the novaSigner. Ignored if novaPrivateKey or novaSigner is provided.
Optional novaA string representing a wallet's private key for use with the novaProvider,
to instantiate the novaSigner. Ignored if novaSigner is provided.
Optional novaAn ethers.js provider instance or a string representing a JSON-RPC URL. This provider is used for interacting with the orderbook contract. If not provided, a default connection string will be used.
Optional novaAn ethers.js signer instance for transacting with the orderbook contract. If no novaSigner,
novaPrivateKey, or novaPhrase is provided, the novaProvider's default signer will be used.
Premia.novaProvider.getSigner
Optional orderbookThe address of the OrderbookStreamer contract (on Arbitrum Nova).
Premia.orderbookAddress
Optional phraseA string representing a wallet's secret phrase for use with the provider,
to instantiate the signer. Ignored if privateKey or signer is provided.
Optional poolThe address of the PoolFactory contract (on Arbitrum).
Premia.poolFactoryAddress
Optional privateA string representing a wallet's private key for use with the provider,
to instantiate the signer. Ignored if signer is provided.
Optional providerAn ethers.js provider instance or a string representing a JSON-RPC URL. This provider is used for interacting with the main exchange contracts. If not provided, a default connection string will be used.
Optional signerAn ethers.js signer instance for transacting with the main exchange contracts. If no signer,
privateKey, or phrase is provided, the provider's default signer will be used.
Premia.provider.getSigner
Optional skipA flag to disable usage of the subgraph, and instead use smart contract data where available.
Optional subgraphThe subgraph URL to use for fetching indexed contract data.
Premia.subgraph.uri
Optional useOptional userThe address of the UserSettings contract (on Arbitrum).
Premia.userSettingsAddress
Optional vaultThe address of the VaultRegistry contract (on Arbitrum).
Premia.vaultRegistryAddress
Optional vxThe address of the VxPremia contract (on Arbitrum).
Premia.vxPremiaAddress
Generated using TypeDoc
The base URL to use for fetching data from the Premia API.
Default Value
apiBaseUri
See
https://docs.premia.finance/api