Class SubaccountExecuteAPI

Hierarchy (view full)

BaseVertexAPI
- SubaccountExecuteAPI

Index

Constructors

Properties

Methods

liquidateSubaccount linkSigner transferQuote createDeterministicLinkedSigner

Constructors

constructor

new SubaccountExecuteAPI(context): SubaccountExecuteAPI
Parameters
- context: VertexClientContext
Returns SubaccountExecuteAPI
Inherited from BaseVertexAPI.constructor
- Defined in apis/base.ts:12

Properties

`Readonly`context

context: VertexClientContext

Methods

liquidateSubaccount

liquidateSubaccount(params): Promise<EngineServerExecuteSuccessResult<"liquidate_subaccount">>
Liquidates a subaccount
Parameters
- params: LiquidateSubaccountParams
Returns Promise<EngineServerExecuteSuccessResult<"liquidate_subaccount">>
- Defined in apis/subaccount/SubaccountExecuteAPI.ts:20

linkSigner

linkSigner(params): 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">>
- Defined in apis/subaccount/SubaccountExecuteAPI.ts:34

transferQuote

transferQuote(params): Promise<EngineServerExecuteSuccessResult<"transfer_quote">>
Transfers quote between subaccounts under the same wallet.
Parameters
- params: TransferQuoteParams
Returns Promise<EngineServerExecuteSuccessResult<"transfer_quote">>
- Defined in apis/subaccount/SubaccountExecuteAPI.ts:48

createDeterministicLinkedSigner

createDeterministicLinkedSigner(params): Promise<Wallet>
Utility fn to get a deterministic private key for a chain signer
Parameters
- params: Pick<Subaccount, "subaccountName">
Returns Promise<Wallet>
- Defined in apis/subaccount/SubaccountExecuteAPI.ts:60