Class SubaccountQueryAPI

Hierarchy (View Summary)

BaseNadoAPI
- SubaccountQueryAPI

Index

Constructors

Properties

Methods

getSubaccountSummary getEngineEstimatedSubaccountSummary getIsolatedPositions getSubaccountFeeRates getSubaccountLinkedSignerWithRateLimit getReferralCode

Constructors

constructor

new SubaccountQueryAPI(context: NadoClientContext): SubaccountQueryAPI
Parameters
- context: NadoClientContext
Returns SubaccountQueryAPI
Inherited from BaseNadoAPI.constructor
- Defined in apis/base.ts:8

Properties

`Readonly`context

context: NadoClientContext

Methods

getSubaccountSummary

getSubaccountSummary(
params: Subaccount,
): Promise<GetEngineSubaccountSummaryResponse>
Gets the subaccount state according to the offchain engine
Parameters
- params: Subaccount
Returns Promise<GetEngineSubaccountSummaryResponse>
- Defined in apis/subaccount/SubaccountQueryAPI.ts:18

getEngineEstimatedSubaccountSummary

getEngineEstimatedSubaccountSummary(
params: GetEngineEstimatedSubaccountSummaryParams,
): Promise<GetEngineSubaccountSummaryResponse>
Gets the estimated subaccount state from offchain engine after a series of proposed txs
Parameters
- params: GetEngineEstimatedSubaccountSummaryParams
Returns Promise<GetEngineSubaccountSummaryResponse>
- Defined in apis/subaccount/SubaccountQueryAPI.ts:26

getIsolatedPositions

getIsolatedPositions(
params: Subaccount,
): Promise<GetEngineIsolatedPositionsResponse>
Gets the isolated positions for a subaccount
Parameters
- params: Subaccount
Returns Promise<GetEngineIsolatedPositionsResponse>
- Defined in apis/subaccount/SubaccountQueryAPI.ts:36

getSubaccountFeeRates

getSubaccountFeeRates(
params: Subaccount,
): Promise<GetEngineSubaccountFeeRatesResponse>
Queries engine to get subaccount fee rates
Parameters
- params: Subaccount
Returns Promise<GetEngineSubaccountFeeRatesResponse>
- Defined in apis/subaccount/SubaccountQueryAPI.ts:44

getSubaccountLinkedSignerWithRateLimit

getSubaccountLinkedSignerWithRateLimit(
params: GetIndexerLinkedSignerParams,
): Promise<GetIndexerLinkedSignerResponse>
Retrieves the current signer and link signer rate limit from the indexer
Parameters
- params: GetIndexerLinkedSignerParams
Returns Promise<GetIndexerLinkedSignerResponse>
- Defined in apis/subaccount/SubaccountQueryAPI.ts:52

getReferralCode

getReferralCode(
params: GetIndexerReferralCodeParams,
): Promise<GetIndexerReferralCodeResponse>
Retrieves referral code for an address
Parameters
- params: GetIndexerReferralCodeParams
Returns Promise<GetIndexerReferralCodeResponse>
- Defined in apis/subaccount/SubaccountQueryAPI.ts:62