@pear-protocol/symmio-client 0.1.5 → 0.1.6

package/dist/react/index.d.mts

@@ -44,6 +44,22 @@ type Account = {
     accountAddress: Address;
     name: string;
 };
+type AccountBalance = {
+    collateralBalance: bigint;
+    allocatedBalance: bigint;
+    availableBalance: bigint;
+    lockedCVA: bigint;
+    lockedLF: bigint;
+    lockedPartyAMM: bigint;
+    lockedPartyBMM: bigint;
+    pendingLockedCVA: bigint;
+    pendingLockedLF: bigint;
+    pendingLockedPartyAMM: bigint;
+    pendingLockedPartyBMM: bigint;
+    positionsCount: number;
+    pendingCount: number;
+    nonces: number;
+};
 
 type SchnorrSign = {
     signature: bigint;
@@ -246,6 +262,11 @@ type RevokeAccessParams = {
     target: Address;
     selectors: Hex[];
 };
+type DelegatedAccessParams = {
+    account: Address;
+    target: Address;
+    selector: Hex;
+};
 
 /**
  * SymmioSDK — Main client for Symmio protocol.
@@ -362,6 +383,8 @@ declare class SymmioSDK {
         proposeRevoke: (params: ProposeRevokeParams) => Promise<`0x${string}`>;
         /** Revoke delegated access (after cooldown). */
         revokeAccess: (params: RevokeAccessParams) => Promise<`0x${string}`>;
+        /** Reads whether a selector is delegated to a target for a sub-account. */
+        hasAccess: (params: DelegatedAccessParams) => Promise<boolean>;
     };
     get signature(): {
         signTerms: () => Promise<`0x${string}`>;
@@ -389,6 +412,12 @@ declare class SymmioSDK {
         /** Fetches the list of open instant close requests for an account. */
         getOpenCloses: (account: Address, accessToken: string) => Promise<unknown[]>;
     };
+    get stats(): {
+        /** Reads partyA statistics (balances, locks) from the Diamond contract. */
+        getPartyAStats: (partyA: Address) => Promise<AccountBalance>;
+        /** Calculates available margin for placing orders given uPNL. */
+        calculateAvailableForOrder: (stats: AccountBalance, upnl: bigint) => bigint;
+    };
     getQuoteSig(partyA: Address, symbolId: number): Promise<MuonSingleUpnlAndPriceSig>;
     getDeallocateSig(partyA: Address): Promise<MuonSingleUpnlSig>;
 }
@@ -416,6 +445,55 @@ declare function useSymmAuth(): {
     refresh: (accountAddress?: viem.Address) => Promise<string | null>;
 };
 
+type UseSymmDelegationParams = {
+    accountAddress?: Address;
+    target?: Address;
+    selectors?: readonly Hex[];
+    enabled?: boolean;
+};
+type SymmDelegationState = {
+    hasAccess: boolean;
+    account: Address | null;
+    target: Address | null;
+    selectors: readonly Hex[];
+    accessBySelector: Record<Hex, boolean>;
+    openAccess?: boolean;
+    closeAccess?: boolean;
+};
+declare function useSymmDelegation(params?: UseSymmDelegationParams): _tanstack_react_query.UseQueryResult<SymmDelegationState, Error>;
+
+type SymmInstantTradeActionArgs = {
+    symmCoreClient: SymmSDK;
+    accessToken: string;
+    accountAddress: Address;
+};
+type SymmInstantTradeRequest = {
+    accountAddress?: Address;
+    target?: Address;
+    selectors?: readonly Hex[];
+    action: (args: SymmInstantTradeActionArgs) => Promise<unknown>;
+    invalidatePositionsOnSuccess?: boolean;
+};
+declare function useSymmInstantTrade(params?: {
+    accountAddress?: Address;
+    target?: Address;
+    selectors?: readonly Hex[];
+    enabled?: boolean;
+}): {
+    delegation: _tanstack_react_query.UseQueryResult<SymmDelegationState, Error>;
+    ensureReady: _tanstack_react_query.UseMutationResult<{
+        accessToken: string;
+        accountAddress: `0x${string}`;
+        target: `0x${string}`;
+        selectors: readonly `0x${string}`[];
+    }, Error, {
+        accountAddress?: Address;
+        target?: Address;
+        selectors?: readonly Hex[];
+    } | undefined, unknown>;
+    execute: _tanstack_react_query.UseMutationResult<unknown, Error, SymmInstantTradeRequest, unknown>;
+};
+
 declare function useSymmAccounts(userAddress?: Address): {
     accounts: Account[];
     count: number;
@@ -483,6 +561,50 @@ declare function useSymmSignature(userAddress?: Address): {
     signTerms: _tanstack_react_query.UseMutationResult<void, Error, void, unknown>;
 };
 
+declare function useSymmAvailableMargin(params: {
+    accountAddress?: Address;
+    upnl?: bigint;
+}): {
+    availableForOrder: bigint | null;
+    stats: {
+        upnl: bigint;
+        availableForOrder: bigint;
+        collateralBalance: bigint;
+        allocatedBalance: bigint;
+        availableBalance: bigint;
+        lockedCVA: bigint;
+        lockedLF: bigint;
+        lockedPartyAMM: bigint;
+        lockedPartyBMM: bigint;
+        pendingLockedCVA: bigint;
+        pendingLockedLF: bigint;
+        pendingLockedPartyAMM: bigint;
+        pendingLockedPartyBMM: bigint;
+        positionsCount: number;
+        pendingCount: number;
+        nonces: number;
+    } | null;
+    isLoading: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
+        upnl: bigint;
+        availableForOrder: bigint;
+        collateralBalance: bigint;
+        allocatedBalance: bigint;
+        availableBalance: bigint;
+        lockedCVA: bigint;
+        lockedLF: bigint;
+        lockedPartyAMM: bigint;
+        lockedPartyBMM: bigint;
+        pendingLockedCVA: bigint;
+        pendingLockedLF: bigint;
+        pendingLockedPartyAMM: bigint;
+        pendingLockedPartyBMM: bigint;
+        positionsCount: number;
+        pendingCount: number;
+        nonces: number;
+    }, Error>>;
+};
+
 declare function useSymmBalances(params: {
     userAddress?: Address;
     chainId?: number;
@@ -754,8 +876,10 @@ declare const symmKeys: {
     portfolio: (address?: Address, chainId?: number) => readonly ["symm", "portfolio", `0x${string}` | undefined, number | undefined];
     notifications: (address?: Address, chainId?: number) => readonly ["symm", "notifications", `0x${string}` | undefined, number | undefined];
     unreadCount: (address?: Address, chainId?: number) => readonly ["symm", "unreadCount", `0x${string}` | undefined, number | undefined];
+    availableMargin: (address?: Address, chainId?: number) => readonly ["symm", "availableMargin", `0x${string}` | undefined, number | undefined];
+    delegation: (account?: Address, target?: Address, selectors?: readonly Hex[], chainId?: number) => readonly ["symm", "delegation", `0x${string}` | undefined, `0x${string}` | undefined, readonly `0x${string}`[] | undefined, number | undefined];
 };
 
 declare function getSymmErrorMessage(error: unknown): string;
 
-export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmHedgerMarketsParams, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDeposit, useSymmFunding, useSymmHedgerMarkets, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };
+export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmDelegationState, type SymmInstantTradeActionArgs, type SymmInstantTradeRequest, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmDelegationParams, type UseSymmHedgerMarketsParams, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmAvailableMargin, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDelegation, useSymmDeposit, useSymmFunding, useSymmHedgerMarkets, useSymmInstantTrade, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };

package/dist/react/index.d.ts

@@ -44,6 +44,22 @@ type Account = {
     accountAddress: Address;
     name: string;
 };
+type AccountBalance = {
+    collateralBalance: bigint;
+    allocatedBalance: bigint;
+    availableBalance: bigint;
+    lockedCVA: bigint;
+    lockedLF: bigint;
+    lockedPartyAMM: bigint;
+    lockedPartyBMM: bigint;
+    pendingLockedCVA: bigint;
+    pendingLockedLF: bigint;
+    pendingLockedPartyAMM: bigint;
+    pendingLockedPartyBMM: bigint;
+    positionsCount: number;
+    pendingCount: number;
+    nonces: number;
+};
 
 type SchnorrSign = {
     signature: bigint;
@@ -246,6 +262,11 @@ type RevokeAccessParams = {
     target: Address;
     selectors: Hex[];
 };
+type DelegatedAccessParams = {
+    account: Address;
+    target: Address;
+    selector: Hex;
+};
 
 /**
  * SymmioSDK — Main client for Symmio protocol.
@@ -362,6 +383,8 @@ declare class SymmioSDK {
         proposeRevoke: (params: ProposeRevokeParams) => Promise<`0x${string}`>;
         /** Revoke delegated access (after cooldown). */
         revokeAccess: (params: RevokeAccessParams) => Promise<`0x${string}`>;
+        /** Reads whether a selector is delegated to a target for a sub-account. */
+        hasAccess: (params: DelegatedAccessParams) => Promise<boolean>;
     };
     get signature(): {
         signTerms: () => Promise<`0x${string}`>;
@@ -389,6 +412,12 @@ declare class SymmioSDK {
         /** Fetches the list of open instant close requests for an account. */
         getOpenCloses: (account: Address, accessToken: string) => Promise<unknown[]>;
     };
+    get stats(): {
+        /** Reads partyA statistics (balances, locks) from the Diamond contract. */
+        getPartyAStats: (partyA: Address) => Promise<AccountBalance>;
+        /** Calculates available margin for placing orders given uPNL. */
+        calculateAvailableForOrder: (stats: AccountBalance, upnl: bigint) => bigint;
+    };
     getQuoteSig(partyA: Address, symbolId: number): Promise<MuonSingleUpnlAndPriceSig>;
     getDeallocateSig(partyA: Address): Promise<MuonSingleUpnlSig>;
 }
@@ -416,6 +445,55 @@ declare function useSymmAuth(): {
     refresh: (accountAddress?: viem.Address) => Promise<string | null>;
 };
 
+type UseSymmDelegationParams = {
+    accountAddress?: Address;
+    target?: Address;
+    selectors?: readonly Hex[];
+    enabled?: boolean;
+};
+type SymmDelegationState = {
+    hasAccess: boolean;
+    account: Address | null;
+    target: Address | null;
+    selectors: readonly Hex[];
+    accessBySelector: Record<Hex, boolean>;
+    openAccess?: boolean;
+    closeAccess?: boolean;
+};
+declare function useSymmDelegation(params?: UseSymmDelegationParams): _tanstack_react_query.UseQueryResult<SymmDelegationState, Error>;
+
+type SymmInstantTradeActionArgs = {
+    symmCoreClient: SymmSDK;
+    accessToken: string;
+    accountAddress: Address;
+};
+type SymmInstantTradeRequest = {
+    accountAddress?: Address;
+    target?: Address;
+    selectors?: readonly Hex[];
+    action: (args: SymmInstantTradeActionArgs) => Promise<unknown>;
+    invalidatePositionsOnSuccess?: boolean;
+};
+declare function useSymmInstantTrade(params?: {
+    accountAddress?: Address;
+    target?: Address;
+    selectors?: readonly Hex[];
+    enabled?: boolean;
+}): {
+    delegation: _tanstack_react_query.UseQueryResult<SymmDelegationState, Error>;
+    ensureReady: _tanstack_react_query.UseMutationResult<{
+        accessToken: string;
+        accountAddress: `0x${string}`;
+        target: `0x${string}`;
+        selectors: readonly `0x${string}`[];
+    }, Error, {
+        accountAddress?: Address;
+        target?: Address;
+        selectors?: readonly Hex[];
+    } | undefined, unknown>;
+    execute: _tanstack_react_query.UseMutationResult<unknown, Error, SymmInstantTradeRequest, unknown>;
+};
+
 declare function useSymmAccounts(userAddress?: Address): {
     accounts: Account[];
     count: number;
@@ -483,6 +561,50 @@ declare function useSymmSignature(userAddress?: Address): {
     signTerms: _tanstack_react_query.UseMutationResult<void, Error, void, unknown>;
 };
 
+declare function useSymmAvailableMargin(params: {
+    accountAddress?: Address;
+    upnl?: bigint;
+}): {
+    availableForOrder: bigint | null;
+    stats: {
+        upnl: bigint;
+        availableForOrder: bigint;
+        collateralBalance: bigint;
+        allocatedBalance: bigint;
+        availableBalance: bigint;
+        lockedCVA: bigint;
+        lockedLF: bigint;
+        lockedPartyAMM: bigint;
+        lockedPartyBMM: bigint;
+        pendingLockedCVA: bigint;
+        pendingLockedLF: bigint;
+        pendingLockedPartyAMM: bigint;
+        pendingLockedPartyBMM: bigint;
+        positionsCount: number;
+        pendingCount: number;
+        nonces: number;
+    } | null;
+    isLoading: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
+        upnl: bigint;
+        availableForOrder: bigint;
+        collateralBalance: bigint;
+        allocatedBalance: bigint;
+        availableBalance: bigint;
+        lockedCVA: bigint;
+        lockedLF: bigint;
+        lockedPartyAMM: bigint;
+        lockedPartyBMM: bigint;
+        pendingLockedCVA: bigint;
+        pendingLockedLF: bigint;
+        pendingLockedPartyAMM: bigint;
+        pendingLockedPartyBMM: bigint;
+        positionsCount: number;
+        pendingCount: number;
+        nonces: number;
+    }, Error>>;
+};
+
 declare function useSymmBalances(params: {
     userAddress?: Address;
     chainId?: number;
@@ -754,8 +876,10 @@ declare const symmKeys: {
     portfolio: (address?: Address, chainId?: number) => readonly ["symm", "portfolio", `0x${string}` | undefined, number | undefined];
     notifications: (address?: Address, chainId?: number) => readonly ["symm", "notifications", `0x${string}` | undefined, number | undefined];
     unreadCount: (address?: Address, chainId?: number) => readonly ["symm", "unreadCount", `0x${string}` | undefined, number | undefined];
+    availableMargin: (address?: Address, chainId?: number) => readonly ["symm", "availableMargin", `0x${string}` | undefined, number | undefined];
+    delegation: (account?: Address, target?: Address, selectors?: readonly Hex[], chainId?: number) => readonly ["symm", "delegation", `0x${string}` | undefined, `0x${string}` | undefined, readonly `0x${string}`[] | undefined, number | undefined];
 };
 
 declare function getSymmErrorMessage(error: unknown): string;
 
-export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmHedgerMarketsParams, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDeposit, useSymmFunding, useSymmHedgerMarkets, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };
+export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmDelegationState, type SymmInstantTradeActionArgs, type SymmInstantTradeRequest, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmDelegationParams, type UseSymmHedgerMarketsParams, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmAvailableMargin, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDelegation, useSymmDeposit, useSymmFunding, useSymmHedgerMarkets, useSymmInstantTrade, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };