The API key to use for fetching data from the Premia API.
The base websocket URL to use for streaming data from the Premia API.
The base URL to use for fetching data from the Coingecko API.
The API Key to use for fetching data from the Coingecko Pro API.
A string representing a wallet's secret phrase for use with the novaProvider,
to instantiate the novaSigner. Ignored if novaPrivateKey or novaSigner is provided.
A string representing a wallet's private key for use with the novaProvider,
to instantiate the novaSigner. Ignored if novaSigner is provided.
An 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.
An 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
The address of the OrderbookStreamer contract (on Arbitrum Nova).
Premia.orderbookAddress
A string representing a wallet's secret phrase for use with the provider,
to instantiate the signer. Ignored if privateKey or signer is provided.
The address of the PoolFactory contract (on Arbitrum).
Premia.poolFactoryAddress
A string representing a wallet's private key for use with the provider,
to instantiate the signer. Ignored if signer is provided.
An 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.
An 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
A flag to disable usage of the subgraph, and instead use smart contract data where available.
The subgraph URL to use for fetching indexed contract data.
Premia.subgraph.uri
The address of the UserSettings contract (on Arbitrum).
Premia.userSettingsAddress
The address of the VaultRegistry contract (on Arbitrum).
Premia.vaultRegistryAddress
The 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