Class Premia`Alpha`

The SDK class is the main entry point for interacting with the Premia V3 protocol. It provides access to all the protocol's functionality, including, but not limited to:

Querying on-chain and indexed data using various APIs and services
Interacting with the main exchange contracts, including trading options and minting/burning LP tokens.
Interacting with the orderbook contract and indexing API, including placing/cancelling orders.
Interacting with various DeFi APIs, including fetching market data and user balances.
Utilizing token lists and pair lists for interacting with the protocol.

Hierarchy

Premia

Constructors

`Private` constructor

new Premia(config): Premia
Creates a new Premia V3 SDK instance.

Remarks
The SDK needs to be initialized before it can be used with non-default parameters.
Parameters
- config: PremiaConfigWithDefaults
Returns Premia
- Defined in src/premia.ts:398

Properties

analytics

analytics: AnalyticsAPI = ...

The API used to interact with the Analytics data on Premia V3.

Default Value

AnalyticsAPI

chainId

chainId: number

Inherit Doc

chainId

coingecko

coingecko: Coingecko

The service used to interact with the Coingecko v3 API.

See

https://www.coingecko.com/api/documentations/v3

contracts

contracts: ContractAPI = ...

The API used to interact with the Contracts on Premia V3.

Default Value

ContractAPI

disableCache

disableCache: boolean

Inherit Doc

disableCache

`Optional` multicallProvider

multicallProvider?: MulticallProvider

The ethers.js multicall provider instance used for batched contract calls.

See

https://github.com/0xsequence/sequence.js/tree/master/packages/multicall

`Optional` novaProvider

novaProvider?: Provider

The ethers.js provider instance used for interacting with the orderbook contract.

Default Value

JsonRpcProvider

See

https://docs.ethers.org/v6/api/providers/#Provider

`Optional` novaProviderCredentials

novaProviderCredentials?: {
provider?: Provider;
rpcUrl?: string;
}

The SetProviderParams field used to instantiate the SDK.

Type declaration

Optional provider?: Provider
Optional rpcUrl?: string

`Optional` novaSigner

novaSigner?: Signer

The ethers.js signer instance used for transacting with the orderbook contract.

Default Value

Wallet

See

https://docs.ethers.org/v6/api/providers/#Signer

`Optional` novaSignerCredentials

novaSignerCredentials?: {
phrase?: string;
privateKey?: string;
}

The SetSignerParams field used to instantiate the SDK.

Type declaration

Optional phrase?: string
Optional privateKey?: string

options

options: OptionAPI = ...

The API used to interact with Options on Premia V3.

Default Value

OptionAPI

orderbook

orderbook: OrderbookV1

The service used to interact with the Premia Orderbook API.

Default Value

OrderbookV1

See

https://docs.premia.finance/api/orderbook

orders

orders: OrdersAPI = ...

The API used to interact with the RFQ Messaging Network for Premia V3.

Default Value

OrderbookAPI

pairs

pairs: TokenPairAPI = ...

The API used to interact with Token Pairs on Premia V3.

Default Value

TokenPairAPI

pools

pools: PoolAPI = ...

The API used to interact with Pools on Premia V3.

Default Value

PoolAPI

pricing

pricing: PricingAPI = ...

The API used to determine best pricing between quotes on Premia V3.

Default Value

PricingAPI

provider

provider: Provider

The ethers.js provider instance used for interacting with the main exchange contracts.

Default Value

JsonRpcProvider

See

https://docs.ethers.org/v6/api/providers/#Provider

providerCredentials

providerCredentials: {
provider?: Provider;
rpcUrl?: string;
}

The SetProviderParams field used to instantiate the SDK.

Type declaration

Optional provider?: Provider
Optional rpcUrl?: string

`Optional` signer

signer?: Signer

The ethers.js signer instance used for transacting with the main exchange contracts.

Default Value

Wallet

See

https://docs.ethers.org/v6/api/providers/#Signer

`Optional` signerCredentials

signerCredentials?: {
phrase?: string;
privateKey?: string;
}

The SetSignerParams field used to instantiate the SDK.

Type declaration

Optional phrase?: string
Optional privateKey?: string

skipSubgraph

skipSubgraph: boolean

Inherit Doc

skipSubgraph

subgraph

subgraph: PremiaSubgraph

The Premia subgraph object which handles all interactions with the subgraph

tokens

tokens: TokenAPI = ...

The API used to interact with the Tokens on Premia V3.

Default Value

TokenAPI

transactions

transactions: TransactionAPI = ...

The API used to interact with the Transactions on Premia V3.

Default Value

TransactionAPI

useTestnet

useTestnet: boolean

Inherit Doc

useTestnet

users

users: UserAPI = ...

The API used to interact with the Users on Premia V3.

Default Value

UserAPI

vaults

vaults: VaultAPI = ...

The API used to interact with the Vaults on Premia V3.

Default Value

VaultAPI

vxPremia

vxPremia: VxPremiaAPI = ...

The API used to interact with VxPremia for Premia V3.

Default Value

VxPremiaAPI

`Static` entities

entities: __module = _entities

The static types used to interact with the Premia V3 protocol.

Default Value

_entities

Accessors

apiBaseUri

get apiBaseUri(): string
Returns string
- Defined in src/premia.ts:542
set apiBaseUri(uri?): void
Parameters
- Optional uri: string
  
  apiBaseUri
Returns void
- Defined in src/premia.ts:549

apiKey

get apiKey(): string
Returns string
- Defined in src/premia.ts:531
set apiKey(apiKey?): void
Parameters
- Optional apiKey: string
  
  apiKey
Returns void
- Defined in src/premia.ts:538

apiWsUri

get apiWsUri(): string
Returns string
- Defined in src/premia.ts:553
set apiWsUri(wsUri?): void
Parameters
- Optional wsUri: string
  
  apiWsUri
Returns void
- Defined in src/premia.ts:560

coingeckoBaseUri

get coingeckoBaseUri(): string
Returns string
- Defined in src/premia.ts:564
set coingeckoBaseUri(uri?): void
Parameters
- Optional uri: string
  
  coingeckoBaseUri
Returns void
- Defined in src/premia.ts:571

coingeckoProApiKey

get coingeckoProApiKey(): undefined | string
Returns undefined | string
- Defined in src/premia.ts:575
set coingeckoProApiKey(apiKey?): void
Parameters
- Optional apiKey: string
  
  coingeckoProApiKey
Returns void
- Defined in src/premia.ts:582

Methods

cancelAllEventStreams

cancelAllEventStreams(): Promise<void>
Cancel all contract event listeners.

Returns Promise<void>
- Defined in src/premia.ts:749

cancelAllStreams

cancelAllStreams(): Promise<void>
Cancel all open quote streams.

Returns Promise<void>
- Defined in src/premia.ts:741

setDisableCache

setDisableCache(disableCache?): void
Parameters
- Optional disableCache: boolean
  
  disableCache
Returns void
- Defined in src/premia.ts:526

setPoolFactoryAddress

setPoolFactoryAddress(factoryAddress): void
Parameters
- factoryAddress: string
  
  poolFactoryAddress
Returns void
- Defined in src/premia.ts:713

setProvider

setProvider(params?): void
Parameters
- Optional params: SetProviderParams
  
  SetProviderParams
Returns void
- Defined in src/premia.ts:596

setSigner

setSigner(params?): Promise<void>
Parameters
- Optional params: SetSignerParams
  
  SetSignerParams
Returns Promise<void>
- Defined in src/premia.ts:621

setSignerSync

setSignerSync(params?): void
Remarks
This method is synchronous and will not initialize via this.provider.getSigner(). If this behavior is required, use async setSigner().
Parameters
- Optional params: SetSignerParams
  
  SetSignerParams
Returns void
- Defined in src/premia.ts:673

setSkipSubgraph

setSkipSubgraph(skipSubgraph?): void
Parameters
- Optional skipSubgraph: boolean
  
  skipSubgraph
Returns void
- Defined in src/premia.ts:589

setUserSettingsAddress

setUserSettingsAddress(settingsAddress): void
Parameters
- settingsAddress: string
  
  vaultRegistryAddress
Returns void
- Defined in src/premia.ts:727

setVaultRegistryAddress

setVaultRegistryAddress(registryAddress): void
Parameters
- registryAddress: string
  
  vaultRegistryAddress
Returns void
- Defined in src/premia.ts:720

setVxPremiaAddress

setVxPremiaAddress(vxPremiaAddress): void
Parameters
- vxPremiaAddress: string
  
  vxPremiaAddress
Returns void
- Defined in src/premia.ts:734

toParams

toParams(): PremiaConfig
Return the serialialized SDK constructor params used to instantiate the SDK.

Returns PremiaConfig
PremiaConfig
- Defined in src/premia.ts:758

`Static` `Private` getDefaultConfig

getDefaultConfig(config?): PremiaConfigWithDefaults
Parameters
- config: Partial<PremiaConfig> = {}
Returns PremiaConfigWithDefaults
- Defined in src/premia.ts:481

`Static` initialize

initialize(config?): Promise<Premia>
Builds the SDK with the provided parameters.

Remarks
Default parameters will be used for any values not passed.
Parameters
- config: PremiaConfig = {}
Returns Promise<Premia>
A promise that resolves when the SDK has been initialized.
- Defined in src/premia.ts:453

`Static` initializeSync

initializeSync(config?): Premia
Builds the SDK with the provided parameters, synchronously.

Remarks
Async signers are not supported, use async initialize if necessary. Default parameters will be used for any values not passed.
Parameters
- config: PremiaConfig = {}
Returns Premia
The synchronously initialized SDK.
- Defined in src/premia.ts:472

Class PremiaAlpha

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Remarks

Parameters

config: PremiaConfigWithDefaults

Returns Premia

Properties

analytics

Default Value

chainId

Inherit Doc

coingecko

See

contracts

Default Value

disableCache

Inherit Doc

Optional multicallProvider

See

Optional novaProvider

Default Value

See

Optional novaProviderCredentials

Type declaration

Optional provider?: Provider

Optional rpcUrl?: string

Optional novaSigner

Default Value

See

Optional novaSignerCredentials

Type declaration

Optional phrase?: string

Optional privateKey?: string

options

Default Value

orderbook

Default Value

See

orders

Default Value

pairs

Default Value

pools

Default Value

pricing

Default Value

provider

Default Value

See

providerCredentials

Type declaration

Optional provider?: Provider

Optional rpcUrl?: string

Optional signer

Default Value

See

Optional signerCredentials

Type declaration

Optional phrase?: string

Optional privateKey?: string

skipSubgraph

Inherit Doc

subgraph

tokens

Default Value

transactions

Default Value

useTestnet

Inherit Doc

users

Default Value

vaults

Default Value

Class Premia`Alpha`

`Private` constructor

`Optional` multicallProvider

`Optional` novaProvider

`Optional` novaProviderCredentials

`Optional` provider?: Provider

`Optional` rpcUrl?: string

`Optional` novaSigner

`Optional` novaSignerCredentials

`Optional` phrase?: string

`Optional` privateKey?: string

`Optional` provider?: Provider

`Optional` rpcUrl?: string

`Optional` signer

`Optional` signerCredentials

`Optional` phrase?: string

`Optional` privateKey?: string

`Static` entities

`Optional` uri: string

`Optional` apiKey: string

`Optional` wsUri: string

`Optional` uri: string

`Optional` apiKey: string

`Optional` disableCache: boolean

`Optional` params: SetProviderParams

`Optional` params: SetSignerParams

`Optional` params: SetSignerParams

`Optional` skipSubgraph: boolean