@lifi/perps-sdk 18.1.0 → 19.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/client/PerpsClient.d.ts +13 -7
- package/dist/cjs/client/PerpsClient.d.ts.map +1 -1
- package/dist/cjs/client/PerpsClient.js +141 -52
- package/dist/cjs/client/PerpsClient.js.map +1 -1
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +2 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/types/api.d.ts +4 -2
- package/dist/cjs/types/api.d.ts.map +1 -1
- package/dist/cjs/types/provider.d.ts +4 -5
- package/dist/cjs/types/provider.d.ts.map +1 -1
- package/dist/cjs/utils/setupActions.d.ts +4 -2
- package/dist/cjs/utils/setupActions.d.ts.map +1 -1
- package/dist/cjs/utils/setupActions.js +9 -1
- package/dist/cjs/utils/setupActions.js.map +1 -1
- package/dist/cjs/utils/switchChain.js +1 -1
- package/dist/cjs/utils/switchChain.js.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/client/PerpsClient.d.ts +62 -54
- package/dist/esm/client/PerpsClient.d.ts.map +1 -1
- package/dist/esm/client/PerpsClient.js +204 -100
- package/dist/esm/client/PerpsClient.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/types/api.d.ts +31 -14
- package/dist/esm/types/api.d.ts.map +1 -1
- package/dist/esm/types/provider.d.ts +21 -27
- package/dist/esm/types/provider.d.ts.map +1 -1
- package/dist/esm/utils/setupActions.d.ts +17 -8
- package/dist/esm/utils/setupActions.d.ts.map +1 -1
- package/dist/esm/utils/setupActions.js +20 -7
- package/dist/esm/utils/setupActions.js.map +1 -1
- package/dist/esm/utils/switchChain.js +1 -1
- package/dist/esm/utils/switchChain.js.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/dist/types/client/PerpsClient.d.ts +62 -54
- package/dist/types/client/PerpsClient.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/types/api.d.ts +31 -14
- package/dist/types/types/api.d.ts.map +1 -1
- package/dist/types/types/provider.d.ts +21 -27
- package/dist/types/types/provider.d.ts.map +1 -1
- package/dist/types/utils/setupActions.d.ts +17 -8
- package/dist/types/utils/setupActions.d.ts.map +1 -1
- package/dist/types/version.d.ts +1 -1
- package/package.json +2 -2
- package/src/client/PerpsClient.ts +284 -129
- package/src/index.ts +4 -1
- package/src/types/api.ts +32 -14
- package/src/types/provider.ts +21 -29
- package/src/utils/setupActions.ts +27 -13
- package/src/utils/switchChain.ts +1 -1
- package/src/version.ts +1 -1
package/dist/cjs/types/api.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AccountConfigSetting, AccountResponse, CancelTwapOrderParams as ActionCancelTwapOrderParams, CreateReferralCodeParams as ActionCreateReferralCodeParams, ActionParamsMap, PlaceTwapOrderParams as ActionPlaceTwapOrderParams, ActionStep, ExecuteActionResponse, MarginMode, MarketRef, MetaActionType, ModifyOrderInput, OnboardParams, OrderSide, OrderType, PortfolioHistoryRange,
|
|
1
|
+
import type { AccountConfigSetting, AccountResponse, CancelTwapOrderParams as ActionCancelTwapOrderParams, CreateReferralCodeParams as ActionCreateReferralCodeParams, ActionParamsMap, PlaceTwapOrderParams as ActionPlaceTwapOrderParams, ActionStep, ExecuteActionResponse, MarginMode, MarketRef, MetaActionType, ModifyOrderInput, OnboardParams, OrderSide, OrderType, PortfolioHistoryRange, SetupAction, SetupOption, SignedActionStep, TimeInForce, TriggerOrderInput, WithdrawalParams } from '@lifi/perps-types';
|
|
2
2
|
import type { Account, Address, WalletClient } from 'viem';
|
|
3
3
|
import type { RetryConfig } from '../transport/retryPolicy.js';
|
|
4
4
|
import type { ProviderConfigs, RequestInterceptor, SwitchChainHook } from './config.js';
|
|
@@ -103,8 +103,10 @@ export interface GetPortfolioHistoryParams {
|
|
|
103
103
|
range: PortfolioHistoryRange;
|
|
104
104
|
}
|
|
105
105
|
export interface SetupChecklistItem {
|
|
106
|
-
descriptor:
|
|
106
|
+
descriptor: SetupAction;
|
|
107
107
|
satisfied: boolean;
|
|
108
|
+
selected: SetupOption | null;
|
|
109
|
+
currentValue: string | null;
|
|
108
110
|
}
|
|
109
111
|
export interface ProviderSetup {
|
|
110
112
|
accountExists: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/types/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,qBAAqB,IAAI,2BAA2B,EACpD,wBAAwB,IAAI,8BAA8B,EAC1D,eAAe,EACf,oBAAoB,IAAI,0BAA0B,EAClD,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,SAAS,EACT,qBAAqB,EACrB,
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/types/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,qBAAqB,IAAI,2BAA2B,EACpD,wBAAwB,IAAI,8BAA8B,EAC1D,eAAe,EACf,oBAAoB,IAAI,0BAA0B,EAClD,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,SAAS,EACT,qBAAqB,EACrB,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,eAAe,EAChB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAOxD,MAAM,WAAW,WAAW;IAM1B,UAAU,CAAC,EAAE,MAAM,CAAA;IAOnB,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IAevC,SAAS,CAAC,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAA;IAQnD,UAAU,CAAC,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;IAS5C,KAAK,CAAC,EAAE,WAAW,CAAA;IAMnB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAOD,MAAM,WAAW,kBAAkB;IAMjC,UAAU,CAAC,EAAE,MAAM,CAAA;IAOnB,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,MAAM,CAAC,EAAE,MAAM,CAAA;IAMf,SAAS,CAAC,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAA;IAMnD,WAAW,CAAC,EAAE,eAAe,CAAA;CAC9B;AAQD,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;IAExC,IAAI,EAAE,MAAM,CAAA;IAEZ,KAAK,EAAE,MAAM,CAAA;IAEb,QAAQ,CAAC,EAAE,MAAM,CAAA;IAMjB,UAAU,CAAC,EAAE,UAAU,CAAA;IAEvB,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAQD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAOD,MAAM,WAAW,oBAAqB,SAAQ,0BAA0B;IACtE,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,qBAAsB,SAAQ,2BAA2B;IACxE,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,UAAU,EAAE,gBAAgB,CAAA;CAC7B;AASD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,UAAU,EAAE,MAAM,CAAA;IAElB,SAAS,EAAE,MAAM,CAAA;IAEjB,cAAc,EAAE,MAAM,CAAA;IAEtB,MAAM,EAAE,MAAM,CAAA;CACf;AAOD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,GAAG,EAAE,MAAM,EAAE,CAAA;IAEb,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAOD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,aAAa,EAAE,gBAAgB,EAAE,CAAA;CAClC;AAOD,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,qBAAqB,CAAA;CAC7B;AAQD,MAAM,WAAW,kBAAkB;IAEjC,UAAU,EAAE,WAAW,CAAA;IAEvB,SAAS,EAAE,OAAO,CAAA;IAKlB,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAA;IAO5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAiBD,MAAM,WAAW,aAAa;IAO5B,aAAa,EAAE,OAAO,CAAA;IAEtB,KAAK,EAAE,UAAU,EAAE,CAAA;IAKnB,OAAO,EAAE,OAAO,CAAA;IAShB,SAAS,EAAE,kBAAkB,EAAE,CAAA;CAChC;AAKD,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,KAAK,EAAE,UAAU,EAAE,CAAA;IAEnB,aAAa,EAAE,gBAAgB,EAAE,CAAA;CAClC;AAKD,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,qBAAqB,CAAA;CAC/B;AAaD,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IAEvD,QAAQ,EAAE,oBAAoB,EAAE,CAAA;CACjC;AAOD,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IAC3D,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,8BACf,SAAQ,8BAA8B;IACtC,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,cAAc;IAC/D,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,CAAC,CAAA;IACT,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;CAC3B"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AccountConfig, AccountConfigSetting, AccountResponse, AccountSummary, ActionResult, ActionStep, ActionType, ActivitiesResponse, ActivityType, AvailableToTrade, FillsResponse, Market, MarketRef, MarketSettings, Order, OrderStatus, OrdersResponse, PerpsMarket, PerpsSigner, PortfolioHistoryRange, PortfolioHistoryResponse, Position, PositionsResponse,
|
|
1
|
+
import type { AccountConfig, AccountConfigSetting, AccountResponse, AccountSummary, ActionResult, ActionStep, ActionType, ActivitiesResponse, ActivityType, AvailableToTrade, FillsResponse, Market, MarketRef, MarketSettings, Order, OrderStatus, OrdersResponse, PerpsMarket, PerpsSigner, PortfolioHistoryRange, PortfolioHistoryResponse, Position, PositionsResponse, Quote, QuoteSide, SetupAction, SignedActionStep, SigningMethod, TradeType } from '@lifi/perps-types';
|
|
2
2
|
import type { Address } from 'viem';
|
|
3
3
|
import type { PerpsBaseConfig, PerpsClientSigner, SDKRequestOptions } from './config.js';
|
|
4
4
|
import type { DepositFlow } from './deposit.js';
|
|
@@ -20,7 +20,7 @@ export interface SignActionProgress {
|
|
|
20
20
|
}
|
|
21
21
|
export interface SignActionsContext {
|
|
22
22
|
userWallet?: PerpsClientSigner;
|
|
23
|
-
|
|
23
|
+
signer?: PerpsSigner;
|
|
24
24
|
switchToChain?: (chainId: number) => Promise<PerpsClientSigner>;
|
|
25
25
|
onProgress?: (progress: SignActionProgress) => void;
|
|
26
26
|
}
|
|
@@ -101,7 +101,6 @@ export interface ProviderGetQuoteParams {
|
|
|
101
101
|
export type QuoteListener = (quote: Quote) => void;
|
|
102
102
|
export interface PerpsProviderPlugin {
|
|
103
103
|
readonly type: string;
|
|
104
|
-
readonly internalSetupActions?: readonly ActionType[];
|
|
105
104
|
readonly conditionalSetupActions?: readonly ActionType[];
|
|
106
105
|
bind(client: PerpsSDKClient): void;
|
|
107
106
|
getAccount(params: ProviderGetAccountParams, options?: SDKRequestOptions): Promise<AccountResponse>;
|
|
@@ -123,9 +122,9 @@ export interface PerpsProviderPlugin {
|
|
|
123
122
|
formatOrderSize(market: Market, size: number): string;
|
|
124
123
|
estimateLiquidationPrice(market: PerpsMarket, params: LiquidationEstimateParams): number | undefined;
|
|
125
124
|
positionRemovableMargin(position: Position): string | undefined;
|
|
126
|
-
projectConfig(config: AccountConfig, setup:
|
|
125
|
+
projectConfig(config: AccountConfig, setup: SetupAction[]): AccountConfigSetting[];
|
|
127
126
|
resolveSetupParams?(action: ActionType, address: Address): Promise<Record<string, unknown>>;
|
|
128
|
-
resolveActionRequest?(action: ActionType, address: Address,
|
|
127
|
+
resolveActionRequest?(action: ActionType, address: Address, signer: PerpsSigner): Promise<ActionSignerContribution>;
|
|
129
128
|
signActions?(method: SigningMethod, steps: ActionStep[], address: Address, ctx?: SignActionsContext): Promise<SignedActionStep[]>;
|
|
130
129
|
onExecuteResults?(address: Address, results: ActionResult[]): Promise<void>;
|
|
131
130
|
resolveExplorerLink?(txHash: string): string | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/types/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,MAAM,EACN,SAAS,EACT,cAAc,EACd,KAAK,EACL,WAAW,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,EACR,iBAAiB,EACjB,
|
|
1
|
+
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/types/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,MAAM,EACN,SAAS,EACT,cAAc,EACd,KAAK,EACL,WAAW,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,SAAS,EACV,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACnC,OAAO,KAAK,EACV,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,KAAK,EAAE,2BAA2B,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAShF,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAEhC,QAAQ,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAEvC,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,CAAA;IAEnC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;CACpD;AAUD,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,UAAU,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IAEf,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IACjC,MAAM,EAAE,MAAM,CAAA;CACf;AAUD,MAAM,WAAW,kBAAkB;IAEjC,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAO9B,MAAM,CAAC,EAAE,WAAW,CAAA;IAWpB,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAO/D,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAA;CACpD;AAUD,MAAM,WAAW,wBAAwB;IAQvC,aAAa,CAAC,EAAE,OAAO,CAAA;IAMvB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AASD,MAAM,WAAW,yBAAyB;IAExC,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAEhB,MAAM,EAAE,OAAO,CAAA;CAChB;AAQD,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,qCAAqC;IACpD,OAAO,EAAE,OAAO,CAAA;CACjB;AAOD,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,OAAO,CAAA;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAOD,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,OAAO,CAAA;IAGhB,MAAM,EAAE,SAAS,CAAA;CAClB;AAOD,MAAM,WAAW,iCAAiC;IAChD,OAAO,EAAE,OAAO,CAAA;IAEhB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAOD,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IAExB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAOD,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAA;IAEhB,EAAE,EAAE,MAAM,CAAA;CACX;AAOD,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAA;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAOD,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,OAAO,CAAA;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,IAAI,CAAC,EAAE,YAAY,EAAE,CAAA;CACtB;AAOD,MAAM,WAAW,iCAAiC;IAChD,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,qBAAqB,CAAA;CAC7B;AAQD,MAAM,WAAW,sBAAsB;IAErC,MAAM,EAAE,MAAM,CAAA;IAEd,IAAI,EAAE,SAAS,CAAA;IAEf,IAAI,EAAE,MAAM,CAAA;IAEZ,IAAI,EAAE,SAAS,CAAA;CAChB;AAQD,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;AA6BlD,MAAM,WAAW,mBAAmB;IAMlC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAUrB,QAAQ,CAAC,uBAAuB,CAAC,EAAE,SAAS,UAAU,EAAE,CAAA;IASxD,IAAI,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAElC,UAAU,CACR,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,eAAe,CAAC,CAAA;IAS3B,aAAa,CACX,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,OAAO,CAAC,CAAA;IAWnB,cAAc,CAAC,CACb,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,WAAW,CAAC,CAAA;IAUvB,eAAe,CAAC,CACd,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,YAAY,CAAC,CAAA;IAYxB,uBAAuB,CAAC,CACtB,MAAM,EAAE,qCAAqC,EAC7C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAAA;IAEzC,YAAY,CACV,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAS7B,iBAAiB,CAAC,CAChB,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAA;IAUtC,mBAAmB,CAAC,CAClB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAA;IAExC,SAAS,CACP,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAAA;IAE1B,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAAA;IAEjB,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,aAAa,CAAC,CAAA;IAEzB,WAAW,CACT,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAM9B,mBAAmB,CAAC,CAClB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,CAAA;IASpC,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAAA;IAWjB,iBAAiB,CACf,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,QAAQ,EAAE,GACpB,cAAc,CAAA;IAcjB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IAWvD,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IAYrD,wBAAwB,CACtB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,yBAAyB,GAChC,MAAM,GAAG,SAAS,CAAA;IAarB,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;IAe/D,aAAa,CACX,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,WAAW,EAAE,GACnB,oBAAoB,EAAE,CAAA;IAWzB,kBAAkB,CAAC,CACjB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAkBnC,oBAAoB,CAAC,CACnB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,wBAAwB,CAAC,CAAA;IAmBpC,WAAW,CAAC,CACV,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,UAAU,EAAE,EACnB,OAAO,EAAE,OAAO,EAChB,GAAG,CAAC,EAAE,kBAAkB,GACvB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAO9B,gBAAgB,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAW3E,mBAAmB,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CACzD;AAYD,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA"}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
export declare function selectUserSetupActions(setup:
|
|
1
|
+
import type { ActionType, SetupAction, SetupOption } from '@lifi/perps-types';
|
|
2
|
+
export declare function selectUserSetupActions(setup: SetupAction[]): SetupAction[];
|
|
3
|
+
export declare function isUserFacingSetupStep(descriptor: SetupAction): boolean;
|
|
4
|
+
export declare function isSetupOptionFor<T extends ActionType>(option: SetupOption, type: T): option is SetupOption<T>;
|
|
3
5
|
//# sourceMappingURL=setupActions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"setupActions.d.ts","sourceRoot":"","sources":["../../../src/utils/setupActions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"setupActions.d.ts","sourceRoot":"","sources":["../../../src/utils/setupActions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAkB7E,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,WAAW,EAAE,CAE1E;AAGD,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAEtE;AAQD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,UAAU,EACnD,MAAM,EAAE,WAAW,EACnB,IAAI,EAAE,CAAC,GACN,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,CAE1B"}
|
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.selectUserSetupActions = selectUserSetupActions;
|
|
4
|
+
exports.isUserFacingSetupStep = isUserFacingSetupStep;
|
|
5
|
+
exports.isSetupOptionFor = isSetupOptionFor;
|
|
4
6
|
const perps_types_1 = require("@lifi/perps-types");
|
|
5
7
|
function selectUserSetupActions(setup) {
|
|
6
|
-
return setup.filter(
|
|
8
|
+
return setup.filter(isUserFacingSetupStep);
|
|
9
|
+
}
|
|
10
|
+
function isUserFacingSetupStep(descriptor) {
|
|
11
|
+
return descriptor.options !== null || descriptor.signer === perps_types_1.PerpsSigner.USER;
|
|
12
|
+
}
|
|
13
|
+
function isSetupOptionFor(option, type) {
|
|
14
|
+
return option.type === type;
|
|
7
15
|
}
|
|
8
16
|
//# sourceMappingURL=setupActions.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"setupActions.js","sourceRoot":"","sources":["../../../src/utils/setupActions.ts"],"names":[],"mappings":";;AAkBA,
|
|
1
|
+
{"version":3,"file":"setupActions.js","sourceRoot":"","sources":["../../../src/utils/setupActions.ts"],"names":[],"mappings":";;AAkBA,wDAEC;AAGD,sDAEC;AAQD,4CAKC;AArCD,mDAA+C;AAiB/C,SAAgB,sBAAsB,CAAC,KAAoB;IACzD,OAAO,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAA;AAC5C,CAAC;AAGD,SAAgB,qBAAqB,CAAC,UAAuB;IAC3D,OAAO,UAAU,CAAC,OAAO,KAAK,IAAI,IAAI,UAAU,CAAC,MAAM,KAAK,yBAAW,CAAC,IAAI,CAAA;AAC9E,CAAC;AAQD,SAAgB,gBAAgB,CAC9B,MAAmB,EACnB,IAAO;IAEP,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,CAAA;AAC7B,CAAC"}
|
|
@@ -17,7 +17,7 @@ function eip712DomainChainId(actions) {
|
|
|
17
17
|
}
|
|
18
18
|
function userEip712TargetChainId(descriptor, actions) {
|
|
19
19
|
if (descriptor.signingMethod !== perps_types_1.SigningMethod.EIP712 ||
|
|
20
|
-
|
|
20
|
+
descriptor.signer !== perps_types_1.PerpsSigner.USER) {
|
|
21
21
|
return undefined;
|
|
22
22
|
}
|
|
23
23
|
return eip712DomainChainId(actions);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"switchChain.js","sourceRoot":"","sources":["../../../src/utils/switchChain.ts"],"names":[],"mappings":";;AAeA,kDAQC;AAQD,0DAWC;AAWD,gDA2BC;AA3ED,mDAA8E;AAC9E,0CAAyC;AACzC,2DAAoD;AAQpD,SAAgB,mBAAmB,CAAC,OAAqB;IACvD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,OAAO,GAAI,IAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAA;QACrE,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,OAAO,OAAO,CAAA;QAChB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAQD,SAAgB,uBAAuB,CACrC,UAA0B,EAC1B,OAAqB;IAErB,IACE,UAAU,CAAC,aAAa,KAAK,2BAAa,CAAC,MAAM;QACjD,
|
|
1
|
+
{"version":3,"file":"switchChain.js","sourceRoot":"","sources":["../../../src/utils/switchChain.ts"],"names":[],"mappings":";;AAeA,kDAQC;AAQD,0DAWC;AAWD,gDA2BC;AA3ED,mDAA8E;AAC9E,0CAAyC;AACzC,2DAAoD;AAQpD,SAAgB,mBAAmB,CAAC,OAAqB;IACvD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,OAAO,GAAI,IAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAA;QACrE,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,OAAO,OAAO,CAAA;QAChB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAQD,SAAgB,uBAAuB,CACrC,UAA0B,EAC1B,OAAqB;IAErB,IACE,UAAU,CAAC,aAAa,KAAK,2BAAa,CAAC,MAAM;QACjD,UAAU,CAAC,MAAM,KAAK,yBAAW,CAAC,IAAI,EACtC,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAA;AACrC,CAAC;AAWM,KAAK,UAAU,kBAAkB,CACtC,MAAyB,EACzB,aAAqB,EACrB,WAA6B;IAE7B,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,MAAM,CAAA;IACf,CAAC;IACD,MAAM,cAAc,GAAG,MAAM,IAAA,oBAAU,EAAC,MAAM,CAAC,CAAA;IAC/C,IAAI,cAAc,KAAK,aAAa,EAAE,CAAC;QACrC,OAAO,MAAM,CAAA;IACf,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,aAAa,CAAC,CAAA;IACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,0BAAU,CAClB,4BAAc,CAAC,QAAQ,EACvB,0BAA0B,aAAa,qBAAqB,CAC7D,CAAA;IACH,CAAC;IACD,MAAM,eAAe,GAAG,MAAM,IAAA,oBAAU,EAAC,QAAQ,CAAC,CAAA;IAClD,IAAI,eAAe,KAAK,aAAa,EAAE,CAAC;QACtC,MAAM,IAAI,0BAAU,CAClB,4BAAc,CAAC,QAAQ,EACvB,sBAAsB,eAAe,cAAc,aAAa,uBAAuB,CACxF,CAAA;IACH,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC"}
|
package/dist/cjs/version.d.ts
CHANGED
package/dist/cjs/version.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import type { AccountResponse, AccountSummary, ActionParamsMap, ActionStep, AvailableToTrade, CreateActionResponse, ExecuteActionResponse, MarketRef, MarketSettings, MetaActionType, Order, OrdersResponse, PortfolioHistoryResponse, Position } from '@lifi/perps-types';
|
|
1
|
+
import type { AccountResponse, AccountSummary, ActionParamsMap, ActionStep, AvailableToTrade, CreateActionResponse, ExecuteActionResponse, MarketRef, MarketSettings, MetaActionType, Order, OrdersResponse, PortfolioHistoryResponse, Position, SetupAction, SetupOption } from '@lifi/perps-types';
|
|
2
2
|
import { ActionType } from '@lifi/perps-types';
|
|
3
3
|
import type { Address } from 'viem';
|
|
4
4
|
import { type GetOrderParams } from '../services/getOrder.js';
|
|
5
5
|
import { type GetOrdersParams } from '../services/getOrders.js';
|
|
6
|
-
import type { BuildProviderSetupParams, CancelOrdersParams, CancelTwapOrderParams, CreateReferralCodeActionParams, ExecuteMetaActionParams, GetAccountResult, GetDepositFlowParams, GetPortfolioHistoryParams, GetSetupParams, GetWithdrawableBalancesParams, GetWithdrawFlowParams, ModifyOrdersParams, PerpsClientOptions, PlaceOrderParams, PlaceTriggerOrderParams, PlaceTwapOrderParams, ProviderSetup, SendAssetActionParams, SubmitOnboardingParams, WithdrawParams } from '../types/api.js';
|
|
6
|
+
import type { BuildProviderSetupParams, CancelOrdersParams, CancelTwapOrderParams, CreateReferralCodeActionParams, ExecuteMetaActionParams, GetAccountResult, GetDepositFlowParams, GetPortfolioHistoryParams, GetSetupParams, GetWithdrawableBalancesParams, GetWithdrawFlowParams, ModifyOrdersParams, PerpsClientOptions, PlaceOrderParams, PlaceTriggerOrderParams, PlaceTwapOrderParams, ProviderSetup, SendAssetActionParams, SetupChecklistItem, SubmitOnboardingParams, WithdrawParams } from '../types/api.js';
|
|
7
7
|
import type { SDKRequestOptions, SwitchChainHook } from '../types/config.js';
|
|
8
8
|
import type { DepositFlow } from '../types/deposit.js';
|
|
9
9
|
import type { PerpsSDKClient, SignActionProgress } from '../types/provider.js';
|
|
@@ -24,7 +24,7 @@ export declare class PerpsClient {
|
|
|
24
24
|
constructor(options: PerpsClientOptions);
|
|
25
25
|
/**
|
|
26
26
|
* Set or update the end-user's wallet. Used whenever an action's descriptor
|
|
27
|
-
* names
|
|
27
|
+
* names `PerpsSigner.USER` as its `signer`. Pass undefined to clear.
|
|
28
28
|
*
|
|
29
29
|
* @public
|
|
30
30
|
*/
|
|
@@ -59,7 +59,7 @@ export declare class PerpsClient {
|
|
|
59
59
|
* Ask the provider plugin for the signer-bearing wire fields of `action` —
|
|
60
60
|
* the on-wire `signerAddress` and any signer-derived params (e.g.
|
|
61
61
|
* Hyperliquid's `agentAddress` for `APPROVE_AGENT`). Forwards the descriptor's
|
|
62
|
-
* `
|
|
62
|
+
* `signer` so the plugin can branch on signer role. Returns empty when the
|
|
63
63
|
* plugin signs as the user or with a non-EVM credential. Core constructs no
|
|
64
64
|
* `signerAddress` itself; signer identity is plugin-owned.
|
|
65
65
|
*/
|
|
@@ -67,10 +67,10 @@ export declare class PerpsClient {
|
|
|
67
67
|
/**
|
|
68
68
|
* Delegate signing of `actions` to the provider plugin, one call per
|
|
69
69
|
* consecutive run of steps sharing a descriptor. Each call carries that
|
|
70
|
-
* descriptor's `signingMethod` and `
|
|
70
|
+
* descriptor's `signingMethod` and `signer`, so a mixed batch signs every
|
|
71
71
|
* step with the signer its own descriptor declares; the signed steps come
|
|
72
72
|
* back in the batch's original order. The plugin owns every signing arm and
|
|
73
|
-
* branches on `
|
|
73
|
+
* branches on `signer` internally, reading the end-user's wallet from the
|
|
74
74
|
* {@link SignActionsContext} when an arm signs as the user.
|
|
75
75
|
*
|
|
76
76
|
* @throws {PerpsError} When a step's action is not declared by the provider,
|
|
@@ -105,9 +105,9 @@ export declare class PerpsClient {
|
|
|
105
105
|
private resolveMetaSigningWallet;
|
|
106
106
|
/**
|
|
107
107
|
* Assemble the per-call context the provider plugin needs in order to sign:
|
|
108
|
-
* the end-user's wallet and the descriptor's declared `
|
|
109
|
-
* forwards `
|
|
110
|
-
* branch on
|
|
108
|
+
* the end-user's wallet and the descriptor's declared `signer`. Core
|
|
109
|
+
* forwards `signer` as data so the plugin can pick WHO signs; it does not
|
|
110
|
+
* branch on it. Provider-owned session credentials (the Hyperliquid agent
|
|
111
111
|
* keypair, Lighter's API key) are resolved inside the provider's
|
|
112
112
|
* `signActions`, not threaded through here.
|
|
113
113
|
*
|
|
@@ -148,7 +148,7 @@ export declare class PerpsClient {
|
|
|
148
148
|
/**
|
|
149
149
|
* Fetch the user's account state from the backend and attach the
|
|
150
150
|
* SDK-projected `settings` array — one `AccountConfigSetting` per
|
|
151
|
-
* descriptor on `Provider.setup
|
|
151
|
+
* descriptor on `Provider.setup`. Callers read
|
|
152
152
|
* `result.settings` directly without re-deriving values from the typed
|
|
153
153
|
* `AccountConfig`.
|
|
154
154
|
*
|
|
@@ -270,28 +270,29 @@ export declare class PerpsClient {
|
|
|
270
270
|
*/
|
|
271
271
|
getPortfolioHistory(params: GetPortfolioHistoryParams, options?: SDKRequestOptions): Promise<PortfolioHistoryResponse>;
|
|
272
272
|
/**
|
|
273
|
-
* Return the
|
|
274
|
-
*
|
|
275
|
-
* `checklist` carries the renderable onboarding list: every
|
|
276
|
-
*
|
|
277
|
-
* omitted.
|
|
273
|
+
* Return the setup steps this account must still sign as a flat,
|
|
274
|
+
* self-describing list. Trading is gated on `isReady === true`.
|
|
275
|
+
* `checklist` carries the renderable onboarding list: every choice step and
|
|
276
|
+
* every `USER`-signed step with its satisfied state, with not-required
|
|
277
|
+
* conditional steps omitted.
|
|
278
278
|
*
|
|
279
|
-
* `
|
|
280
|
-
*
|
|
281
|
-
*
|
|
279
|
+
* A non-choice `SDK`-signed step is NEVER returned here — the SDK drains it
|
|
280
|
+
* with the provider's own credentials. A choice is listed but never staged
|
|
281
|
+
* or executed, whatever its `signer`: the user picks an option through
|
|
282
|
+
* {@link executeProviderOption}, and `isReady` stays `false` until every
|
|
283
|
+
* choice on `checklist` is satisfied.
|
|
282
284
|
*
|
|
283
285
|
* @public
|
|
284
286
|
*/
|
|
285
287
|
checkSetup(params: GetSetupParams): Promise<ProviderSetup>;
|
|
286
288
|
/**
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
*
|
|
289
|
+
* Project the provider's own typed account config onto its setup steps. This
|
|
290
|
+
* catches client-held auth state (e.g. Ondo SIWE/JWT) that the backend
|
|
291
|
+
* cannot observe, and carries the current value of each choice.
|
|
290
292
|
*/
|
|
291
|
-
private
|
|
293
|
+
private resolveSetupSettings;
|
|
292
294
|
/**
|
|
293
|
-
* Drain the pending
|
|
294
|
-
* `PerpsProviderPlugin.internalSetupActions`. Each step is built, signed,
|
|
295
|
+
* Drain the pending `SDK`-signed non-choice steps: each is built, signed,
|
|
295
296
|
* and executed in place with the provider's own credentials. A step is
|
|
296
297
|
* deferred while any staged user-facing step with a lower `sequence` is
|
|
297
298
|
* outstanding — it cannot succeed before its prerequisite (e.g. SET_REFERRAL
|
|
@@ -300,7 +301,7 @@ export declare class PerpsClient {
|
|
|
300
301
|
* blocks setup — the step stays unsatisfied and is retried on a later
|
|
301
302
|
* `checkSetup`.
|
|
302
303
|
*/
|
|
303
|
-
private
|
|
304
|
+
private drainSetup;
|
|
304
305
|
/**
|
|
305
306
|
* Build unsigned setup steps for the supplied descriptor subset, preserving
|
|
306
307
|
* provider sequence order with SIWE descriptors prioritized.
|
|
@@ -308,9 +309,11 @@ export declare class PerpsClient {
|
|
|
308
309
|
private buildProviderSetupActions;
|
|
309
310
|
/**
|
|
310
311
|
* Build the unsigned setup `ActionStep`s still outstanding for an account,
|
|
311
|
-
* ordered by descriptor `sequence`.
|
|
312
|
-
*
|
|
313
|
-
*
|
|
312
|
+
* ordered by descriptor `sequence`. Only a `USER`-signed non-choice step is
|
|
313
|
+
* staged: an `SDK`-signed non-choice step drains inside {@link checkSetup}
|
|
314
|
+
* and a choice executes the option the user picks. The backend filters
|
|
315
|
+
* already-satisfied setup; each plugin contributes its own signer-bearing
|
|
316
|
+
* request fields and any local-state params (e.g. Lighter's known pubkey).
|
|
314
317
|
*
|
|
315
318
|
* @public
|
|
316
319
|
*/
|
|
@@ -325,41 +328,30 @@ export declare class PerpsClient {
|
|
|
325
328
|
/**
|
|
326
329
|
* Sign and submit one pre-staged setup `ActionStep` end-to-end.
|
|
327
330
|
*
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
* through submit. If the cached step has gone stale (Lighter's `/nextNonce`
|
|
333
|
-
* advanced underneath us), `executeProviderSetup` will surface a nonce
|
|
334
|
-
* conflict that the caller invalidates on, refetches `checkSetup`, and
|
|
335
|
-
* retries with a fresh step.
|
|
331
|
+
* `step` and `checklist` must come from the same {@link checkSetup} result.
|
|
332
|
+
* This preserves the nonce allocated while staging and validates sequence
|
|
333
|
+
* prerequisites against that same snapshot, without another `createAction`
|
|
334
|
+
* round-trip.
|
|
336
335
|
*
|
|
337
336
|
* @throws {PerpsError} When the step's action is not in the provider's
|
|
338
|
-
* `setup` descriptors
|
|
337
|
+
* `setup` descriptors, or when a lower-`sequence` step on the same
|
|
338
|
+
* checklist, a choice included, is still unsatisfied.
|
|
339
339
|
* @public
|
|
340
340
|
*/
|
|
341
341
|
executeProviderSetupAction(params: {
|
|
342
342
|
provider: string;
|
|
343
343
|
address: Address;
|
|
344
344
|
step: ActionStep;
|
|
345
|
+
checklist: SetupChecklistItem[];
|
|
345
346
|
}): Promise<void>;
|
|
346
347
|
/**
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
348
|
+
* Execute one option of a choice setup step (Lighter `ACCOUNT_TYPE`,
|
|
349
|
+
* Hyperliquid `ACCOUNT_MODE`) end-to-end with its bound `{ type, params }`,
|
|
350
|
+
* throwing on a venue rejection.
|
|
350
351
|
*
|
|
351
|
-
*
|
|
352
|
-
* trades, but unlike a trade an option change is a single mandatory action:
|
|
352
|
+
* The option runs through the same {@link execute} pipeline as a trade, but
|
|
353
353
|
* a per-action `success: false` (returned as a 200 OK) means the user's
|
|
354
|
-
* selection was rejected and must surface, not be silently dropped.
|
|
355
|
-
* wrapper inspects the result and throws a {@link PerpsError} carrying the
|
|
356
|
-
* venue `error`, giving options the same throw contract that setup has via
|
|
357
|
-
* {@link executeProviderSetupAction}. The only structural difference is that
|
|
358
|
-
* an option carries `params` (the selected value) rather than a pre-staged
|
|
359
|
-
* step.
|
|
360
|
-
*
|
|
361
|
-
* `execute` itself is unchanged — it still returns results without throwing,
|
|
362
|
-
* which the trade hooks rely on for partial-fill handling.
|
|
354
|
+
* selection was rejected and must surface, not be silently dropped.
|
|
363
355
|
*
|
|
364
356
|
* @throws {PerpsError} Carrying the venue error when any returned result has
|
|
365
357
|
* `success: false`, under that result's `errorCode` when the backend
|
|
@@ -368,11 +360,25 @@ export declare class PerpsClient {
|
|
|
368
360
|
* signer, signing failure).
|
|
369
361
|
* @public
|
|
370
362
|
*/
|
|
371
|
-
executeProviderOption
|
|
363
|
+
executeProviderOption(params: {
|
|
372
364
|
provider: string;
|
|
373
365
|
address: Address;
|
|
374
|
-
|
|
375
|
-
|
|
366
|
+
option: SetupOption;
|
|
367
|
+
}): Promise<void>;
|
|
368
|
+
/**
|
|
369
|
+
* Undo a satisfied setup step by executing its `revoke` action through
|
|
370
|
+
* create, sign and execute, signed with that action's `Provider.actions`
|
|
371
|
+
* descriptor. The step stages again on the next {@link checkSetup}.
|
|
372
|
+
*
|
|
373
|
+
* @throws {PerpsError} `SDKError` when `step.revoke` is `null` or when
|
|
374
|
+
* `createAction` stages nothing to revoke; otherwise the errors
|
|
375
|
+
* {@link executeProviderOption} throws.
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
executeProviderRevoke(params: {
|
|
379
|
+
provider: string;
|
|
380
|
+
address: Address;
|
|
381
|
+
step: SetupAction;
|
|
376
382
|
}): Promise<void>;
|
|
377
383
|
/**
|
|
378
384
|
* Place a market or limit order. Convenience wrapper over {@link execute}
|
|
@@ -486,6 +492,8 @@ export declare class PerpsClient {
|
|
|
486
492
|
* deposit); called as each leg is submitted and confirmed. */
|
|
487
493
|
onProgress?: (progress: SignActionProgress) => void;
|
|
488
494
|
}): Promise<ExecuteActionResponse>;
|
|
495
|
+
/** {@link execute}, also returning the steps `createAction` staged. */
|
|
496
|
+
private runAction;
|
|
489
497
|
/**
|
|
490
498
|
* Accept the current terms and, when a code is supplied and the backend
|
|
491
499
|
* accepts it, attach that internal referral code — in one signature.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PerpsClient.d.ts","sourceRoot":"","sources":["../../../src/client/PerpsClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"PerpsClient.d.ts","sourceRoot":"","sources":["../../../src/client/PerpsClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,eAAe,EACf,cAAc,EACd,eAAe,EAEf,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,cAAc,EACd,KAAK,EACL,cAAc,EACd,wBAAwB,EACxB,QAAQ,EAGR,WAAW,EACX,WAAW,EAEZ,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAEL,UAAU,EAKX,MAAM,mBAAmB,CAAA;AAE1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAOnC,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAEL,KAAK,eAAe,EACrB,MAAM,0BAA0B,CAAA;AAEjC,OAAO,KAAK,EACV,wBAAwB,EACxB,kBAAkB,EAClB,qBAAqB,EACrB,8BAA8B,EAC9B,uBAAuB,EAGvB,gBAAgB,EAChB,oBAAoB,EACpB,yBAAyB,EACzB,cAAc,EACd,6BAA6B,EAC7B,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,oBAAoB,EACpB,aAAa,EACb,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,cAAc,EACf,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAEV,iBAAiB,EACjB,eAAe,EAChB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EAGV,cAAc,EACd,kBAAkB,EAEnB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AA0L/E;;;;;;;GAOG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,qBAAqB,CAAmC;IAChE,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,YAAY,CAA6B;gBAErC,OAAO,EAAE,kBAAkB;IAUvC;;;;;OAKG;IACH,aAAa,CAAC,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI;IAQ7D;;;;;;OAMG;IACH,cAAc,CAAC,WAAW,EAAE,eAAe,GAAG,SAAS,GAAG,IAAI;IAI9D;;;;;OAKG;IACH,IAAI,MAAM,IAAI,cAAc,CAE3B;YAEa,mBAAmB;IAsBjC;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAIvB,gEAAgE;IAC1D,SAAS,CACb,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,CAAC;IAI1B,kEAAkE;IAC5D,QAAQ,CACZ,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC;IAIjB;;;;;;;OAOG;YACW,oBAAoB;IAgBlC;;;;;;;;;;;OAWG;YACW,mBAAmB;IAgCjC;;;;OAIG;YACW,oBAAoB;IAWlC;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAkB5B;;;;;;OAMG;YACW,oBAAoB;IAelC;;;;OAIG;YACW,wBAAwB;IAiBtC;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,uBAAuB;IAqB/B;;;;;;;;;;;OAWG;YACW,uBAAuB;IAerC;;;;;OAKG;IACG,WAAW,CAAC,CAAC,SAAS,UAAU,EACpC,MAAM,EAAE,CAAC,EACT,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;KAAE,GACzE,OAAO,CAAC,oBAAoB,CAAC;IAqBhC;;;;;;;;;;OAUG;IACG,UAAU,CAAC,MAAM,EAAE;QACvB,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;KACjB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAU7B;;;;;;;;OAQG;IACG,iBAAiB,CAAC,MAAM,EAAE;QAC9B,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,SAAS,CAAA;KAClB,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAQvC;;;;;;;;;;;;;OAaG;IACG,mBAAmB,CACvB,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;KACjB,EACD,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IA+B5B;;;;;;;;OAQG;IACH,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS;IAMlE;;;;;;OAMG;IACH,iBAAiB,CACf,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,QAAQ,EAAE,GACpB,cAAc;IAOjB;;;;;;;;;OASG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzE;;;;;;;;;OASG;IACG,cAAc,CAClB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAKnC;;;;;;;;;OASG;IACG,eAAe,CACnB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAKpC;;;;;;;;;;;;;;OAcG;IACG,uBAAuB,CAC3B,MAAM,EAAE,6BAA6B,GACpC,OAAO,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAAC;IAmD7C;;;;;;;OAOG;IACG,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,wBAAwB,CAAC;IAcpC;;;;;;;;;;;;;;OAcG;IACG,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAoFhE;;;;OAIG;YACW,oBAAoB;IAalC;;;;;;;;;OASG;YACW,UAAU;IA2CxB;;;OAGG;YACW,yBAAyB;IAuCvC;;;;;;;;;OASG;IACG,kBAAkB,CACtB,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IAYhC;;;;;OAKG;YACW,oBAAoB;IAqClC;;;;;;;;;;;;OAYG;IACG,0BAA0B,CAAC,MAAM,EAAE;QACvC,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,IAAI,EAAE,UAAU,CAAA;QAChB,SAAS,EAAE,kBAAkB,EAAE,CAAA;KAChC,GAAG,OAAO,CAAC,IAAI,CAAC;IAwCjB;;;;;;;;;;;;;;;OAeG;IACG,qBAAqB,CAAC,MAAM,EAAE;QAClC,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,WAAW,CAAA;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjB;;;;;;;;;OASG;IACG,qBAAqB,CAAC,MAAM,EAAE;QAClC,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,IAAI,EAAE,WAAW,CAAA;KAClB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBjB;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI1E;;;;;;;OAOG;IACG,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;;OAIG;IACG,cAAc,CAClB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;;OAIG;IACG,eAAe,CACnB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;;;;;OAOG;IACG,YAAY,CAChB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;;;;;;OAOG;IACG,YAAY,CAChB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;;;;;;OAOG;IACG,oBAAoB,CAAC,MAAM,EAAE;QACjC,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,SAAS,CAAA;QACjB,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAA;QACxB,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAQlC;;;;;;;OAOG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAStE;;;;;;;;;OASG;IACG,SAAS,CACb,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,qBAAqB,CAAC;IAUjC;;;;;;;;;OASG;IACG,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,MAAM,EAAE;QAC1C,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,CAAC,CAAA;QACT,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;QAC1B;sEAC8D;QAC9D,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAA;KACpD,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAKlC,uEAAuE;YACzD,SAAS;IAyDvB;;;;;;;;;;;;OAYG;IACG,gBAAgB,CACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,qBAAqB,CAAC;IASjC;;;;;;;;OAQG;IACG,kBAAkB,CACtB,MAAM,EAAE,8BAA8B,GACrC,OAAO,CAAC,qBAAqB,CAAC;IASjC;;;;;;;;;;;;;;;OAeG;IACG,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAC9C,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,qBAAqB,CAAC;CA+ClC"}
|