Class SubaccountAPI

Hierarchy

SubaccountExecuteAPI<this> & SubaccountQueryAPI<this>
- SubaccountAPI

Index

Constructors

Properties

Methods

liquidateSubaccount linkSigner getSubaccountSummary getEngineSubaccountSummary getEngineEstimatedSubaccountSummary getIsolatedPositions getSubaccountFeeRates getSubaccountLinkedSignerWithRateLimit getReferralCode createStandardLinkedSigner

Constructors

constructor

new SubaccountAPI(context: NadoClientContext): SubaccountAPI
Parameters
- context: NadoClientContext
Returns SubaccountAPI
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).constructor
- Defined in packages/client/src/apis/base.ts:9

Properties

`Readonly`context

context: NadoClientContext

Methods

liquidateSubaccount

liquidateSubaccount(
params: LiquidateSubaccountParams,
): Promise<EngineServerExecuteSuccessResult<"liquidate_subaccount">>
Liquidates a subaccount
Parameters
- params: LiquidateSubaccountParams
Returns Promise<EngineServerExecuteSuccessResult<"liquidate_subaccount">>
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).liquidateSubaccount
- Defined in packages/client/src/apis/subaccount/SubaccountExecuteAPI.ts:10

linkSigner

linkSigner(
params: LinkSignerParams,
): Promise<EngineServerExecuteSuccessResult<"link_signer">>
Links a signer to a subaccount to allow them to sign transactions on behalf of the subaccount
Parameters
- params: LinkSignerParams
Returns Promise<EngineServerExecuteSuccessResult<"link_signer">>
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).linkSigner
- Defined in packages/client/src/apis/subaccount/SubaccountExecuteAPI.ts:24

getSubaccountSummary

getSubaccountSummary(params: Subaccount): Promise<SubaccountSummaryResponse>
Returns a comprehensive summary for a subaaccount, including its balances and health
Parameters
- params: Subaccount
Returns Promise<SubaccountSummaryResponse>
See
:CONTRACTS | getSubaccountSummary
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).getSubaccountSummary
- Defined in packages/client/src/apis/subaccount/SubaccountQueryAPI.ts:23

getEngineSubaccountSummary

getEngineSubaccountSummary(
params: Subaccount,
): Promise<SubaccountSummaryResponse>
Gets the subaccount state according to the offchain engine
Parameters
- params: Subaccount
Returns Promise<SubaccountSummaryResponse>
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).getEngineSubaccountSummary
- Defined in packages/client/src/apis/subaccount/SubaccountQueryAPI.ts:31

getEngineEstimatedSubaccountSummary

getEngineEstimatedSubaccountSummary(
params: GetEngineEstimatedSubaccountSummaryParams,
): Promise<SubaccountSummaryResponse>
Gets the estimated subaccount state from offchain engine after a series of proposed txs
Parameters
- params: GetEngineEstimatedSubaccountSummaryParams
Returns Promise<SubaccountSummaryResponse>
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).getEngineEstimatedSubaccountSummary
- Defined in packages/client/src/apis/subaccount/SubaccountQueryAPI.ts:39

getIsolatedPositions

getIsolatedPositions(
params: Subaccount,
): Promise<GetEngineIsolatedPositionsResponse>
Gets the isolated positions for a subaccount
Parameters
- params: Subaccount
Returns Promise<GetEngineIsolatedPositionsResponse>
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).getIsolatedPositions
- Defined in packages/client/src/apis/subaccount/SubaccountQueryAPI.ts:49

getSubaccountFeeRates

getSubaccountFeeRates(
params: Subaccount,
): Promise<GetEngineSubaccountFeeRatesResponse>
Queries engine to get subaccount fee rates
Parameters
- params: Subaccount
Returns Promise<GetEngineSubaccountFeeRatesResponse>
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).getSubaccountFeeRates
- Defined in packages/client/src/apis/subaccount/SubaccountQueryAPI.ts:57

getSubaccountLinkedSignerWithRateLimit

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

getReferralCode

getReferralCode(
params: GetIndexerReferralCodeParams,
): Promise<GetIndexerReferralCodeResponse>
Retrieves referral code for an address
Parameters
- params: GetIndexerReferralCodeParams
Returns Promise<GetIndexerReferralCodeResponse>
Inherited from Mixin( SubaccountExecuteAPI, SubaccountQueryAPI, ).getReferralCode
- Defined in packages/client/src/apis/subaccount/SubaccountQueryAPI.ts:75

createStandardLinkedSigner

createStandardLinkedSigner(
subaccountName: string,
): Promise<AccountWithPrivateKey>
Given the current context, create a "standard" link signer Account for the subaccount The "standard" linked signer private key is deterministically generated so that the frontend running on different clients can have a consistent private key for the subaccount linked signer.
Parameters
- subaccountName: string
Returns Promise<AccountWithPrivateKey>
- Defined in packages/client/src/apis/subaccount/index.ts:22

Class SubaccountAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SubaccountAPI

Properties

Readonlycontext

Methods

liquidateSubaccount

Parameters

Returns Promise<EngineServerExecuteSuccessResult<"liquidate_subaccount">>

linkSigner

Parameters

Returns Promise<EngineServerExecuteSuccessResult<"link_signer">>

getSubaccountSummary

Parameters

Returns Promise<SubaccountSummaryResponse>

See

getEngineSubaccountSummary

Parameters

Returns Promise<SubaccountSummaryResponse>

getEngineEstimatedSubaccountSummary

Parameters

Returns Promise<SubaccountSummaryResponse>

getIsolatedPositions

Parameters

Returns Promise<GetEngineIsolatedPositionsResponse>

getSubaccountFeeRates

Parameters

Returns Promise<GetEngineSubaccountFeeRatesResponse>

getSubaccountLinkedSignerWithRateLimit

Parameters

Returns Promise<GetIndexerLinkedSignerResponse>

getReferralCode

Parameters

Returns Promise<GetIndexerReferralCodeResponse>

createStandardLinkedSigner

Parameters

Returns Promise<AccountWithPrivateKey>

Settings

On This Page

`Readonly`context