Class UserAPI

Hierarchy

BaseAPI
- UserAPI

Constructors

constructor

new UserAPI(premia): UserAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns UserAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:17

Properties

`Readonly` premia

premia: Premia

Methods

encodeSetActionAuthorization

encodeSetActionAuthorization(operator, actions, authorization): Promise<ContractTransaction>
Encodes a transaction to set the authorized actions for an operator.
Parameters
- operator: string
  
  The operator to (un)authorize actions for.
- actions: bigint[]
  
  The actions to (un)authorize.
- authorization: boolean[]
  
  The authorization status of the actions.
Returns Promise<ContractTransaction>
A promise that resolves to an encoded ContractTransaction object.
- Defined in src/api/userAPI.ts:299

encodeSetAuthorizedCost

encodeSetAuthorizedCost(authorizedCost): Promise<ContractTransaction>
Encodes a transaction to set the authorized cost of a User.

Method
encodeSetAuthorizedCost
Parameters
- authorizedCost: BigNumberish
  
  The authorized cost to set.
Returns Promise<ContractTransaction>
A promise that resolves to an encoded ContractTransaction object.
- Defined in src/api/userAPI.ts:252

getActionAuthorization

getActionAuthorization(user, operator): Promise<ActionAuthorization>
Fetches a user's authorized actions for a specific operator.
Parameters
- user: string
  
  The address of the User to fetch settings for.
- operator: string
  
  The address of the Operator to fetch authorizations for.
Returns Promise<ActionAuthorization>
A promise that resolves to a user's authorized actions for a specific operator.
- Defined in src/api/userAPI.ts:282

getAuthorizedCost

getAuthorizedCost(address): Promise<bigint>
Fetches a user's authorized cost setting for automatic settlement.
Parameters
- address: string
  
  The address of the User to fetch settings for.
Returns Promise<bigint>
A promise that resolves to a user's authorized cost setting.
- Defined in src/api/userAPI.ts:239

getLiquidityPositionsExtendedForUser

getLiquidityPositionsExtendedForUser(owner, orderType?): Promise<LiquidityPositionExtended[]>
Retrieves extended liquidity positions for a given user.
Parameters
- owner: string
  
  The address of the user for whom to retrieve liquidity positions.
- Optional orderType: OrderType
  
  Optional parameter to filter the positions by order type. If omitted, returns all liquidity positions for the given user.
Returns Promise<LiquidityPositionExtended[]>
A promise that resolves to an array of extended liquidity positions for the given user.
- Defined in src/api/userAPI.ts:223

getOptionPositionsExtendedForUser

getOptionPositionsExtendedForUser(owner, isOpen?): Promise<OptionPositionExtended[]>
Retrieves extended option positions for a given user.
Parameters
- owner: string
  
  The address of the user for whom to retrieve option positions.
- Optional isOpen: boolean
  
  Optional 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.
Returns Promise<OptionPositionExtended[]>
A promise that resolves to an array of extended option positions for the given user.
- Defined in src/api/userAPI.ts:207

getUser

getUser(address): Promise<User>
Fetches a User based on the provided address and caches the result for a day.
Parameters
- address: string
  
  The address of the User to fetch.
Returns Promise<User>
A promise that resolves to a User object.
- Defined in src/api/userAPI.ts:39

getUserExtended

getUserExtended(address): Promise<UserExtended>
Fetches an extended User based on the provided address and caches the result for a minute.
Parameters
- address: string
  
  The address of the User to fetch.
Returns Promise<UserExtended>
A promise that resolves to a UserExtended object.
- Defined in src/api/userAPI.ts:50

getUserPortfolio

getUserPortfolio(address): Promise<UserPortfolio>
Fetches a portfolio of a User and caches the result for a day.
Parameters
- address: string
  
  The address of the User to fetch.
Returns Promise<UserPortfolio>
A promise that resolves to a UserPortfolio object.
- Defined in src/api/userAPI.ts:180

getUserPortfolioExtended

getUserPortfolioExtended(address): Promise<UserPortfolioExtended>
Fetches an extended portfolio of a User and caches the result for a minute.
Parameters
- address: string
  
  The address of the User to fetch.
Returns Promise<UserPortfolioExtended>
A promise that resolves to a UserPortfolioExtended object.
- Defined in src/api/userAPI.ts:191

getUserSnapshot

getUserSnapshot(address, timestamp): Promise<UserSnapshot>
Fetches a UserSnapshot for a specific User at a specific timestamp and caches the result for a day.
Parameters
- address: string
  
  The address of the User to fetch the snapshot for.
- timestamp: BigNumberish
  
  The timestamp for the snapshot.
Returns Promise<UserSnapshot>
A promise that resolves to a UserSnapshot object.
- Defined in src/api/userAPI.ts:84

getUserSnapshotExtended

getUserSnapshotExtended(address, timestamp): Promise<UserSnapshotExtended>
Fetches an extended snapshot of a User at a specified timestamp and caches the result for a minute.
Parameters
- address: string
  
  The address of the User to fetch.
- timestamp: BigNumberish
  
  The timestamp of the User snapshot.
Returns Promise<UserSnapshotExtended>
A promise that resolves to a UserSnapshotExtended object.
- Defined in src/api/userAPI.ts:99

getUserSnapshots

getUserSnapshots(address, startTime, endTime, orderBy?, order?, first?, skip?): Promise<UserSnapshot[]>
Fetches multiple snapshots of a User within a specified time frame and caches the result for a day.

Method
getUserSnapshots
Parameters
- address: string
  
  The address of the User to fetch.
- startTime: BigNumberish
  
  The start time of the time frame.
- endTime: BigNumberish
  
  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 first: number = 100
  
  The number of snapshots to fetch. Default is 100.
- Optional skip: number = 0
  
  The number of snapshots to skip. Default is 0.
Returns Promise<UserSnapshot[]>
A promise that resolves to an array of UserSnapshot objects.
- Defined in src/api/userAPI.ts:120

getUserSnapshotsExtended

getUserSnapshotsExtended(address, startTime, endTime, orderBy?, order?, first?, skip?): Promise<UserSnapshotExtended[]>
Fetches multiple extended snapshots of a User within a specified time frame and caches the result for a minute.
Parameters
- address: string
  
  The address of the User to fetch.
- startTime: BigNumberish
  
  The start time of the time frame.
- endTime: BigNumberish
  
  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 first: number = 100
  
  The number of snapshots to fetch. Default is 100.
- Optional skip: number = 0
  
  The number of snapshots to skip. Default is 0.
Returns Promise<UserSnapshotExtended[]>
A promise that resolves to an array of UserSnapshotExtended objects.
- Defined in src/api/userAPI.ts:153

getUsers

getUsers(addresses): Promise<User[]>
Fetches multiple Users based on the provided addresses and caches the result for a day.
Parameters
- addresses: string[]
  
  An array of addresses of Users to fetch.
Returns Promise<User[]>
A promise that resolves to an array of User objects.
- Defined in src/api/userAPI.ts:61

getUsersExtended

getUsersExtended(addresses): Promise<UserExtended[]>
Fetches multiple extended Users based on the provided addresses and caches the result for a minute.
Parameters
- addresses: string[]
  
  An array of addresses of Users to fetch.
Returns Promise<UserExtended[]>
A promise that resolves to an array of UserExtended objects.
- Defined in src/api/userAPI.ts:72

setActionAuthorization

setActionAuthorization(operator, actions, authorization): Promise<ContractTransactionResponse>
Sets the authorized actions for an operator.
Parameters
- operator: string
  
  The operator to (un)authorize actions for.
- actions: bigint[]
  
  The actions to (un)authorize.
- authorization: boolean[]
  
  The authorization status of the actions.
Returns Promise<ContractTransactionResponse>
A promise that resolves to an encoded ContractTransactionResponse object.
- Defined in src/api/userAPI.ts:320

setAuthorizedCost

setAuthorizedCost(authorizedCost): Promise<ContractTransactionResponse>
Sets the authorized cost of a User.

Method
setAuthorizedCost
Parameters
- authorizedCost: BigNumberish
  
  The authorized cost to set.
Returns Promise<ContractTransactionResponse>
A promise that resolves to a ContractTransactionResponse object after the transaction is complete.
- Defined in src/api/userAPI.ts:268

updateUserSettings

updateUserSettings(operator, actions, authorization, authorizedCost): Promise<ContractTransactionResponse>
Sets the authorized cost and actions for an operator using multicall.
Parameters
- operator: string
  
  The operator to (un)authorize actions for.
- actions: bigint[]
  
  The actions to (un)authorize.
- authorization: boolean[]
  
  The authorization status of the actions.
- authorizedCost: BigNumberish
  
  The authorized cost to set.
Returns Promise<ContractTransactionResponse>
A promise that resolves to an encoded ContractTransactionResponse object.
- Defined in src/api/userAPI.ts:342

Class UserAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

premia: Premia

Returns UserAPI

Properties

Readonly premia

Methods

encodeSetActionAuthorization

Parameters

operator: string

actions: bigint[]

authorization: boolean[]

Returns Promise<ContractTransaction>

encodeSetAuthorizedCost

Method

Parameters

authorizedCost: BigNumberish

Returns Promise<ContractTransaction>

getActionAuthorization

Parameters

user: string

operator: string

Returns Promise<ActionAuthorization>

getAuthorizedCost

Parameters

address: string

Returns Promise<bigint>

getLiquidityPositionsExtendedForUser

Parameters

owner: string

Optional orderType: OrderType

Returns Promise<LiquidityPositionExtended[]>

getOptionPositionsExtendedForUser

Parameters

owner: string

Optional isOpen: boolean

Returns Promise<OptionPositionExtended[]>

getUser

Parameters

address: string

Returns Promise<User>

getUserExtended

Parameters

address: string

Returns Promise<UserExtended>

getUserPortfolio

Parameters

address: string

Returns Promise<UserPortfolio>

getUserPortfolioExtended

Parameters

address: string

Returns Promise<UserPortfolioExtended>

getUserSnapshot

Parameters

address: string

timestamp: BigNumberish

Returns Promise<UserSnapshot>

getUserSnapshotExtended

Parameters

address: string

timestamp: BigNumberish

Returns Promise<UserSnapshotExtended>

getUserSnapshots

Method

Parameters

address: string

startTime: BigNumberish

endTime: BigNumberish

Optional orderBy: string = 'timestamp'

Optional order: string = 'asc'

Optional first: number = 100

Optional skip: number = 0

`Readonly` premia

`Optional` orderType: OrderType

`Optional` isOpen: boolean

`Optional` orderBy: string = 'timestamp'

`Optional` order: string = 'asc'

`Optional` first: number = 100

`Optional` skip: number = 0

`Optional` orderBy: string = 'timestamp'

`Optional` order: string = 'asc'

`Optional` first: number = 100

`Optional` skip: number = 0