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.
The address of the OrderbookStreamer contract (on Arbitrum Nova).
Premia.orderbookAddress
A string representing a wallet's secret phrase for use with the orderbookProvider,
to instantiate the orderbookSigner. Ignored if orderbookPrivateKey or orderbookSigner is provided.
A string representing a wallet's private key for use with the orderbookProvider,
to instantiate the orderbookSigner. Ignored if orderbookSigner 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 orderbookSigner,
orderbookPrivateKey, or orderbookPhrase is provided, the orderbookProvider's default signer will be used.
Premia.orderbookProvider.getSigner
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 PremiaDiamond contract (on Arbitrum).
Premia.poolDiamondAddress
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 voidnode, and instead use smart contract data where available.
The address of the UserSettings contract (on Arbitrum).
Premia.userSettingsAddress
The address of the VaultMining contract (on Arbitrum).
Premia.vaultMiningAddress
The address of the VaultRegistry contract (on Arbitrum).
Premia.vaultRegistryAddress
Optional voidnodeThe voidnode URL to use for fetching indexed contract data.
Premia.voidnode.uri
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