chore: adding result types

spacesailor24 · spacesailor24 · commit e1b2cf8d70a9 · 2025-11-05T21:23:29.000-10:00
diff --git a/packages/apps/ability-hyperliquid/src/generated/lit-action.js b/packages/apps/ability-hyperliquid/src/generated/lit-action.js
diff --git a/packages/apps/ability-hyperliquid/src/generated/vincent-ability-metadata.json b/packages/apps/ability-hyperliquid/src/generated/vincent-ability-metadata.json
@@ -1,3 +1,3 @@
 {
-  "ipfsCid": "QmTE5cjdcMp8teZyni4D6SA9LVsSsH2HuKwfwQpUskqG8E"
+  "ipfsCid": "QmdFLepEXEa4E25yZGbiVdM6UEHoKNxmqt9MefDwy4H3EC"
 }
diff --git a/packages/apps/ability-hyperliquid/src/lib/ability-checks/deposit.ts b/packages/apps/ability-hyperliquid/src/lib/ability-checks/deposit.ts
@@ -1,11 +1,20 @@
 import { ethers } from 'ethers';
 import { ERC20_ABI } from '@lit-protocol/vincent-ability-sdk';
 
-import {
-  ARBITRUM_USDC_ADDRESS_MAINNET,
-  ARBITRUM_USDC_ADDRESS_TESTNET,
-  DepositPrechecksResult,
-} from '../types';
+import { ARBITRUM_USDC_ADDRESS_MAINNET, ARBITRUM_USDC_ADDRESS_TESTNET } from '../types';
+
+export type DepositPrechecksResult = DepositPrechecksResultSuccess | DepositPrechecksResultFailure;
+
+export interface DepositPrechecksResultSuccess {
+  success: true;
+  balance: string;
+}
+
+export interface DepositPrechecksResultFailure {
+  success: false;
+  reason: string;
+  balance: string;
+}
 
 export const depositPrechecks = async ({
   provider,
diff --git a/packages/apps/ability-hyperliquid/src/lib/ability-helpers/cancel-order/cancel-all-orders.ts b/packages/apps/ability-hyperliquid/src/lib/ability-helpers/cancel-order/cancel-all-orders.ts
@@ -1,11 +1,22 @@
 import * as hyperliquid from '@nktkas/hyperliquid';
 import { SymbolConverter } from '@nktkas/hyperliquid/utils';
-import { CancelRequest, parser } from '@nktkas/hyperliquid/api/exchange';
+import { CancelRequest, CancelResponse, parser } from '@nktkas/hyperliquid/api/exchange';
 import { signL1Action } from '@nktkas/hyperliquid/signing';
-import { bigIntReplacer } from '@lit-protocol/vincent-ability-sdk';
 
 import { LitActionPkpEthersWallet } from '../lit-action-pkp-ethers-wallet';
 
+export type CancelAllOrdersResult = CancelAllOrdersResultSuccess | CancelAllOrdersResultFailure;
+
+export interface CancelAllOrdersResultSuccess {
+  status: 'success';
+  cancelResult: CancelResponse;
+}
+
+export interface CancelAllOrdersResultFailure {
+  status: 'error';
+  reason: string;
+}
+
 /**
  * Cancel all open spot orders for a specific symbol
  */
@@ -19,7 +30,7 @@ export async function cancelAllOrdersForSymbol({
   pkpPublicKey: string;
   symbol: string;
   useTestnet?: boolean;
-}) {
+}): Promise<CancelAllOrdersResult> {
   // Get converter for symbol to asset ID
   const converter = await SymbolConverter.create({ transport });
   const assetId = converter.getAssetId(symbol);
@@ -94,6 +105,6 @@ export async function cancelAllOrdersForSymbol({
 
   return {
     status: 'success',
-    cancelResult: parsedCancelResult.result as Record<string, unknown>,
+    cancelResult: parsedCancelResult.result as CancelResponse,
   };
 }
diff --git a/packages/apps/ability-hyperliquid/src/lib/ability-helpers/cancel-order/cancel-order.ts b/packages/apps/ability-hyperliquid/src/lib/ability-helpers/cancel-order/cancel-order.ts
@@ -1,6 +1,6 @@
 import * as hyperliquid from '@nktkas/hyperliquid';
 import { SymbolConverter } from '@nktkas/hyperliquid/utils';
-import { CancelRequest, parser } from '@nktkas/hyperliquid/api/exchange';
+import { CancelRequest, CancelResponse, parser } from '@nktkas/hyperliquid/api/exchange';
 import { signL1Action } from '@nktkas/hyperliquid/signing';
 import { bigIntReplacer } from '@lit-protocol/vincent-ability-sdk';
 
@@ -11,6 +11,18 @@ export interface CancelSpotOrderParams {
   orderId: number; // Order ID to cancel
 }
 
+export type CancelOrderResult = CancelOrderResultSuccess | CancelOrderResultFailure;
+
+export interface CancelOrderResultSuccess {
+  status: 'success';
+  cancelResult: CancelResponse;
+}
+
+export interface CancelOrderResultFailure {
+  status: 'error';
+  reason: string;
+}
+
 /**
  * Cancel a specific spot order on Hyperliquid
  */
@@ -24,7 +36,7 @@ export async function cancelOrder({
   pkpPublicKey: string;
   params: CancelSpotOrderParams;
   useTestnet?: boolean;
-}) {
+}): Promise<CancelOrderResult> {
   // Get converter for symbol to asset ID
   const converter = await SymbolConverter.create({ transport });
   const assetId = converter.getAssetId(params.symbol);
@@ -95,6 +107,6 @@ export async function cancelOrder({
 
   return {
     status: 'success',
-    cancelResult: parsedCancelResult.result as Record<string, unknown>,
+    cancelResult: parsedCancelResult.result as CancelResponse,
   };
 }
diff --git a/packages/apps/ability-hyperliquid/src/lib/ability-helpers/execute-perp-order.ts b/packages/apps/ability-hyperliquid/src/lib/ability-helpers/execute-perp-order.ts
@@ -1,6 +1,11 @@
 import * as hyperliquid from '@nktkas/hyperliquid';
 import { SymbolConverter } from '@nktkas/hyperliquid/utils';
-import { OrderRequest, UpdateLeverageRequest, parser } from '@nktkas/hyperliquid/api/exchange';
+import {
+  OrderRequest,
+  OrderResponse,
+  UpdateLeverageRequest,
+  parser,
+} from '@nktkas/hyperliquid/api/exchange';
 import { signL1Action } from '@nktkas/hyperliquid/signing';
 import { bigIntReplacer } from '@lit-protocol/vincent-ability-sdk';
 
@@ -36,6 +41,18 @@ export interface PerpTradeParams {
   };
 }
 
+export type PerpOrderResult = PerpOrderResultSuccess | PerpOrderResultFailure;
+
+export interface PerpOrderResultSuccess {
+  status: 'success';
+  orderResult: OrderResponse;
+}
+
+export interface PerpOrderResultFailure {
+  status: 'error';
+  error: string;
+}
+
 /**
  * Execute a perpetual trade on Hyperliquid
  */
@@ -49,7 +66,7 @@ export async function executePerpOrder({
   pkpPublicKey: string;
   params: PerpTradeParams;
   useTestnet?: boolean;
-}) {
+}): Promise<PerpOrderResult> {
   // Get converter for symbol to asset ID
   const converter = await SymbolConverter.create({ transport });
   const assetId = converter.getAssetId(params.symbol);
@@ -178,6 +195,6 @@ export async function executePerpOrder({
 
   return {
     status: 'success',
-    orderResult: parsedOrderResult.result as Record<string, unknown>,
+    orderResult: parsedOrderResult.result as OrderResponse,
   };
 }
diff --git a/packages/apps/ability-hyperliquid/src/lib/ability-helpers/execute-spot-order.ts b/packages/apps/ability-hyperliquid/src/lib/ability-helpers/execute-spot-order.ts
@@ -1,6 +1,6 @@
 import * as hyperliquid from '@nktkas/hyperliquid';
 import { SymbolConverter } from '@nktkas/hyperliquid/utils';
-import { OrderRequest, parser } from '@nktkas/hyperliquid/api/exchange';
+import { OrderRequest, OrderResponse, parser } from '@nktkas/hyperliquid/api/exchange';
 import { signL1Action } from '@nktkas/hyperliquid/signing';
 import { bigIntReplacer } from '@lit-protocol/vincent-ability-sdk';
 
@@ -22,6 +22,18 @@ export interface SpotTradeParams {
   orderType?: { type: 'limit'; tif: TimeInForce } | { type: 'market' };
 }
 
+export type SpotOrderResult = SpotOrderResultSuccess | SpotOrderResultFailure;
+
+export interface SpotOrderResultSuccess {
+  status: 'success';
+  orderResult: OrderResponse;
+}
+
+export interface SpotOrderResultFailure {
+  status: 'error';
+  error: string;
+}
+
 /**
  * Execute a spot trade on Hyperliquid
  */
@@ -35,7 +47,7 @@ export async function executeSpotOrder({
   pkpPublicKey: string;
   params: SpotTradeParams;
   useTestnet?: boolean;
-}) {
+}): Promise<SpotOrderResult> {
   // Get converter for symbol to asset ID
   const converter = await SymbolConverter.create({ transport });
   const assetId = converter.getAssetId(params.symbol);
@@ -120,6 +132,6 @@ export async function executeSpotOrder({
 
   return {
     status: 'success',
-    orderResult: parsedOrderResult.result as Record<string, unknown>,
+    orderResult: parsedOrderResult.result as OrderResponse,
   };
 }
diff --git a/packages/apps/ability-hyperliquid/src/lib/ability-helpers/send-deposit-tx.ts b/packages/apps/ability-hyperliquid/src/lib/ability-helpers/send-deposit-tx.ts
@@ -3,18 +3,6 @@ import { populateTransaction, sponsoredGasRawTransaction } from '@lit-protocol/v
 
 import { signTx } from './sign-tx';
 
-declare const Lit: {
-  Actions: {
-    runOnce: (
-      params: {
-        waitForResponse: boolean;
-        name: string;
-      },
-      callback: () => Promise<string>,
-    ) => Promise<string>;
-  };
-};
-
 export const sendDepositTx = async ({
   rpcUrl,
   chainId,
diff --git a/packages/apps/ability-hyperliquid/src/lib/ability-helpers/sign-tx.ts b/packages/apps/ability-hyperliquid/src/lib/ability-helpers/sign-tx.ts
@@ -1,15 +1,5 @@
 import { ethers } from 'ethers';
 
-declare const Lit: {
-  Actions: {
-    signAndCombineEcdsa: (params: {
-      toSign: Uint8Array;
-      publicKey: string;
-      sigName: string;
-    }) => Promise<string>;
-  };
-};
-
 export const signTx = async (
   pkpPublicKey: string,
   tx: ethers.UnsignedTransaction,
diff --git a/packages/apps/ability-hyperliquid/src/lib/ability-helpers/transfer-usdc-to.ts b/packages/apps/ability-hyperliquid/src/lib/ability-helpers/transfer-usdc-to.ts
@@ -2,6 +2,7 @@ import * as hyperliquid from '@nktkas/hyperliquid';
 import {
   UsdClassTransferRequest,
   UsdClassTransferTypes,
+  SuccessResponse,
   parser,
 } from '@nktkas/hyperliquid/api/exchange';
 import { signUserSignedAction } from '@nktkas/hyperliquid/signing';
@@ -10,6 +11,10 @@ import { bigIntReplacer } from '@lit-protocol/vincent-ability-sdk';
 
 import { LitActionPkpEthersWallet } from './lit-action-pkp-ethers-wallet';
 
+export type TransferUsdcResult = {
+  transferResult: SuccessResponse;
+};
+
 /**
  * Transfer funds between spot and perpetuals accounts on Hyperliquid
  */
@@ -25,7 +30,7 @@ export async function transferUsdcTo({
   amount: string;
   to: 'spot' | 'perp';
   useTestnet?: boolean;
-}) {
+}): Promise<TransferUsdcResult> {
   if (to !== 'spot' && to !== 'perp') {
     throw new Error(
       '[transferUsdcTo] Invalid transfer destination. Must be either "spot" or "perp".',
@@ -86,6 +91,6 @@ export async function transferUsdcTo({
 
   const parsedTransferResult = JSON.parse(transferResult);
   return {
-    transferResult: parsedTransferResult.result as Record<string, unknown>,
+    transferResult: parsedTransferResult.result as SuccessResponse,
   };
 }
diff --git a/packages/apps/ability-hyperliquid/src/lib/schemas.ts b/packages/apps/ability-hyperliquid/src/lib/schemas.ts
@@ -84,7 +84,6 @@ export const abilityParamsSchema = z
     useTestnet: z
       .boolean()
       .optional()
-      .default(false)
       .describe('Use Hyperliquid testnet instead of mainnet (default: false)'),
     // Deposit-specific params
     deposit: depositParamsSchema
diff --git a/packages/apps/ability-hyperliquid/src/lib/types.ts b/packages/apps/ability-hyperliquid/src/lib/types.ts
@@ -35,21 +35,8 @@ export enum OrderType {
 
 export const HYPERLIQUID_BRIDGE_ADDRESS_MAINNET = '0x2Df1c51E09aECF9cacB7bc98cB1742757f163dF7';
 
-export const HYPERLIQUID_BRIDGE_ADDRESS_TESTNET = '0xEdB6e5c456B7ccA2EB1e5c7007f4Ab80426CD20F';
+export const HYPERLIQUID_BRIDGE_ADDRESS_TESTNET = '0xedb6e5c456b7cca2eb1e5c7007f4ab80426cd20f';
 
 export const ARBITRUM_USDC_ADDRESS_MAINNET = '0xaf88d065e77c8cC2239327C5EDb3A432268e5831';
 
 export const ARBITRUM_USDC_ADDRESS_TESTNET = '0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d';
-
-export type DepositPrechecksResult = DepositPrechecksResultSuccess | DepositPrechecksResultFailure;
-
-export interface DepositPrechecksResultSuccess {
-  success: true;
-  balance: string;
-}
-
-export interface DepositPrechecksResultFailure {
-  success: false;
-  reason: string;
-  balance: string;
-}
diff --git a/packages/apps/ability-hyperliquid/src/lib/vincent-ability.ts b/packages/apps/ability-hyperliquid/src/lib/vincent-ability.ts
@@ -339,12 +339,12 @@ export const vincentAbility = createVincentAbility({
           const rpcUrl = await Lit.Actions.getRpcUrl({ chain: 'arbitrum' });
 
           // Select addresses based on network
-          const bridgeAddress = useTestnet
-            ? HYPERLIQUID_BRIDGE_ADDRESS_TESTNET
-            : HYPERLIQUID_BRIDGE_ADDRESS_MAINNET;
-          const usdcAddress = useTestnet
-            ? ARBITRUM_USDC_ADDRESS_TESTNET
-            : ARBITRUM_USDC_ADDRESS_MAINNET;
+          const bridgeAddress = ethers.utils.getAddress(
+            useTestnet ? HYPERLIQUID_BRIDGE_ADDRESS_TESTNET : HYPERLIQUID_BRIDGE_ADDRESS_MAINNET,
+          );
+          const usdcAddress = ethers.utils.getAddress(
+            useTestnet ? ARBITRUM_USDC_ADDRESS_TESTNET : ARBITRUM_USDC_ADDRESS_MAINNET,
+          );
           const chainId = useTestnet
             ? 421614 // Arbitrum Sepolia testnet
             : 42161; // Arbitrum mainnet
diff --git a/packages/apps/ability-hyperliquid/test/e2e/deposit.spec.ts b/packages/apps/ability-hyperliquid/test/e2e/deposit.spec.ts
@@ -28,6 +28,7 @@ describe('Hyperliquid Ability E2E Deposit Tests', () => {
     ARBITRUM_RPC_URL: z.string(),
   });
   const USDC_DEPOSIT_AMOUNT = '6000000';
+  const USE_TESTNET = false;
 
   let agentPkpInfo: PkpInfo;
   let wallets: {
@@ -75,7 +76,6 @@ describe('Hyperliquid Ability E2E Deposit Tests', () => {
       const newAppVersion = await appManager.registerNewAppVersion({
         abilityIpfsCids,
         abilityPolicies,
-        appVersion: existingApp.appVersion,
       });
       appId = existingApp.appId;
       appVersion = newAppVersion.appVersion;
@@ -111,6 +111,7 @@ describe('Hyperliquid Ability E2E Deposit Tests', () => {
       const precheckResult = await hyperliquidAbilityClient.precheck(
         {
           action: 'deposit',
+          useTestnet: USE_TESTNET,
           deposit: {
             amount: USDC_DEPOSIT_AMOUNT,
           },
@@ -132,7 +133,7 @@ describe('Hyperliquid Ability E2E Deposit Tests', () => {
       }
     });
 
-    it.skip('should execute the Hyperliquid Ability to make a deposit from the Agent Wallet PKP into the HyperLiquid bridge', async () => {
+    it('should execute the Hyperliquid Ability to make a deposit from the Agent Wallet PKP into the HyperLiquid bridge', async () => {
       const hyperliquidAbilityClient = getVincentAbilityClient({
         bundledVincentAbility: hyperliquidBundledAbility,
         ethersSigner: wallets.appDelegatee,
@@ -141,6 +142,7 @@ describe('Hyperliquid Ability E2E Deposit Tests', () => {
       const executeResult = await hyperliquidAbilityClient.execute(
         {
           action: 'deposit',
+          useTestnet: USE_TESTNET,
           deposit: {
             amount: USDC_DEPOSIT_AMOUNT,
           },
@@ -175,7 +177,7 @@ describe('Hyperliquid Ability E2E Deposit Tests', () => {
     // NOTE It takes about a minute for the deposit to be reflected in the portfolio.
     // This test assumes a previous deposit has been made by the Agent Wallet PKP into the HyperLiquid bridge.
     it('should verify the Agent Wallet PKP has funds in the HyperLiquid portfolio', async () => {
-      const transport = new hyperliquid.HttpTransport();
+      const transport = new hyperliquid.HttpTransport({ isTestnet: USE_TESTNET });
       const infoClient = new hyperliquid.InfoClient({ transport });
 
       // Check clearinghouse state which includes account balance
diff --git a/packages/apps/ability-hyperliquid/test/e2e/perp/long.spec.ts b/packages/apps/ability-hyperliquid/test/e2e/perp/long.spec.ts
@@ -84,7 +84,6 @@ describe('Hyperliquid Ability E2E Perp Long Tests', () => {
       const newAppVersion = await appManager.registerNewAppVersion({
         abilityIpfsCids,
         abilityPolicies,
-        appVersion: existingApp.appVersion,
       });
       appId = existingApp.appId;
       appVersion = newAppVersion.appVersion;
diff --git a/packages/apps/ability-hyperliquid/test/e2e/perp/short.spec.ts b/packages/apps/ability-hyperliquid/test/e2e/perp/short.spec.ts
@@ -84,7 +84,6 @@ describe('Hyperliquid Ability E2E Perp Short Tests', () => {
       const newAppVersion = await appManager.registerNewAppVersion({
         abilityIpfsCids,
         abilityPolicies,
-        appVersion: existingApp.appVersion,
       });
       appId = existingApp.appId;
       appVersion = newAppVersion.appVersion;
diff --git a/packages/apps/ability-hyperliquid/test/e2e/spot/buy.spec.ts b/packages/apps/ability-hyperliquid/test/e2e/spot/buy.spec.ts
diff --git a/packages/apps/ability-hyperliquid/test/e2e/spot/cancel-all-orders.spec.ts b/packages/apps/ability-hyperliquid/test/e2e/spot/cancel-all-orders.spec.ts
diff --git a/packages/apps/ability-hyperliquid/test/e2e/spot/cancel-order.spec.ts b/packages/apps/ability-hyperliquid/test/e2e/spot/cancel-order.spec.ts
diff --git a/packages/apps/ability-hyperliquid/test/e2e/spot/sell.spec.ts b/packages/apps/ability-hyperliquid/test/e2e/spot/sell.spec.ts
diff --git a/packages/apps/ability-hyperliquid/test/e2e/transfer.spec.ts b/packages/apps/ability-hyperliquid/test/e2e/transfer.spec.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "ipfsCid": "QmTE5cjdcMp8teZyni4D6SA9LVsSsH2HuKwfwQpUskqG8E"`
	`2`	`+ "ipfsCid": "QmdFLepEXEa4E25yZGbiVdM6UEHoKNxmqt9MefDwy4H3EC"`
`3`	`3`	`}`