Readonly premiaThe Premia SDK instance.
Protected streamThe current index of quote streams. Used to cancel stale streams.
Encodes a transaction to set the authorized actions for an operator.
The operator to (un)authorize actions for.
The actions to (un)authorize.
The authorization status of the actions.
Optional provider: ProviderThe custom provider to use for this call.
A promise that resolves to an encoded ContractTransaction object.
Encodes a transaction to set the authorized actions for an operator.
The operator to (un)authorize actions for.
The actions to (un)authorize.
The authorization status of the actions.
Optional provider: ProviderThe custom provider to use for this call.
The encoded transaction data.
Encodes a transaction to set the authorized cost of a User.
encodeSetAuthorizedCost
The authorized cost to set.
Optional provider: ProviderThe custom provider to use for this call.
A promise that resolves to an encoded ContractTransaction object.
Encodes a transaction to set the authorized cost of a User.
encodeSetAuthorizedCost
The authorized cost to set.
Optional provider: ProviderThe custom provider to use for this call.
The encoded transaction data.
Fetches a user's authorized actions for a specific operator.
The address of the User to fetch settings for.
The address of the Operator to fetch authorizations for.
Optional provider: ProviderThe custom provider to use for this call.
A promise that resolves to a user's authorized actions for a specific operator.
Fetches a user's authorized cost setting for automatic settlement.
The address of the User to fetch settings for.
Optional provider: ProviderThe custom provider to use for this call.
A promise that resolves to a user's authorized cost setting.
Retrieves extended liquidity positions for a given user.
The address of the user for whom to retrieve liquidity positions.
Optional orderType: OrderTypeOptional parameter to filter the positions by order type. If omitted, returns all liquidity positions for the given user.
A promise that resolves to an array of extended liquidity positions for the given user.
Retrieves extended option positions for a given user.
The address of the user for whom to retrieve option positions.
Optional isOpen: booleanOptional parameter that if set to true, only returns open option positions. If set to false, returns closed option positions. If omitted, returns all option positions.
A promise that resolves to an array of extended option positions for the given user.
Retrieves extended reward option positions for a given user.
The address of the user for whom to retrieve option positions.
Optional timestamp: numberTimestamp to check maturity of the option.
Optional isOpen: booleanOptional parameter that if set to true, only returns open option positions. If set to false, returns closed option positions. If omitted, returns all option positions.
A promise that resolves to an array of extended option positions for the given user.
Fetches an extended User based on the provided address.
The address of the User to fetch.
A promise that resolves to a UserExtended object.
Fetches a portfolio of a User.
The address of the User to fetch.
A promise that resolves to a UserPortfolio object.
Fetches an extended portfolio of a User.
The address of the User to fetch.
A promise that resolves to a UserPortfolioExtended object.
Fetches a UserSnapshot for a specific User at a specific timestamp.
The address of the User to fetch the snapshot for.
The timestamp for the snapshot.
A promise that resolves to a UserSnapshot object.
Fetches an extended snapshot of a User at a specified timestamp.
The address of the User to fetch.
The timestamp of the User snapshot.
A promise that resolves to a UserSnapshotExtended object.
Fetches multiple snapshots of a User within a specified time frame.
getUserSnapshots
The address of the User to fetch.
The start time of the time frame.
The end time of the time frame.
Optional orderBy: string = 'timestamp'The field to order the snapshots by. Default is 'timestamp'.
Optional order: string = 'ASC'The order of the snapshots. Default is 'ASC'.
Optional limit: number = 100The number of snapshots to fetch. Default is 100.
Optional skip: number = 0The number of snapshots to skip. Default is 0.
A promise that resolves to an array of UserSnapshot objects.
Fetches multiple extended snapshots of a User within a specified time frame.
The address of the User to fetch.
The start time of the time frame.
The end time of the time frame.
Optional orderBy: string = 'timestamp'The field to order the snapshots by. Default is 'timestamp'.
Optional order: string = 'ASC'The order of the snapshots. Default is 'ASC'.
Optional limit: number = 100The number of snapshots to fetch. Default is 100.
Optional skip: number = 0The number of snapshots to skip. Default is 0.
A promise that resolves to an array of UserSnapshotExtended objects.
Fetches multiple extended Users based on the provided addresses.
An array of addresses of Users to fetch.
A promise that resolves to an array of UserExtended objects.
Sets the authorized actions for an operator.
The operator to (un)authorize actions for.
The actions to (un)authorize.
The authorization status of the actions.
Optional provider: ProviderThe custom provider to use for this call.
A promise that resolves to an encoded ContractTransactionResponse object.
Sets the authorized cost of a User.
setAuthorizedCost
The authorized cost to set.
Optional provider: ProviderThe custom provider to use for this call.
A promise that resolves to a ContractTransactionResponse object after the transaction is complete.
Sets the authorized cost and actions for an operator using multicall.
The operator to (un)authorize actions for.
The actions to (un)authorize.
The authorization status of the actions.
The authorized cost to set.
Optional provider: ProviderThe custom provider to use for this call.
A promise that resolves to an encoded ContractTransactionResponse object.
Generated using TypeDoc
Construct a new BaseAPI object.