Merge pull request #394 from LIT-Protocol/feat/hyperliquid-ability

Feat: Init HyperLiquid Ability

Author: spacesailor24

.env.example

@@ -7,9 +7,11 @@ YELLOWSTONE_RPC_URL=https://yellowstone-rpc.litprotocol.com/
 BASE_RPC_URL=
 ETH_RPC_URL=
 SOL_RPC_URL=
+ARBITRUM_RPC_URL=
 
 TEST_FUNDER_PRIVATE_KEY=
 TEST_SOLANA_FUNDER_PRIVATE_KEY=
+
 TEST_APP_MANAGER_PRIVATE_KEY=
 TEST_APP_DELEGATEE_PRIVATE_KEY=
 TEST_AGENT_WALLET_PKP_OWNER_PRIVATE_KEY=

.nx/version-plans/version-plan-1762328379521.md

@@ -0,0 +1,5 @@
+---
+ability-hyperliquid: major
+---
+
+Initialize first version of the HyperLiquid Vincent Ability that allows for making spot buy and sell orders, perp longs and shorts, as well as deposits into the HyperLiquid bridge contract to open a HyperLiquid master account for a Vincent Agent Wallet.

nx.json

@@ -69,6 +69,7 @@
       "ability-debridge",
       "policy-send-counter",
       "ability-aerodrome-swap",
+      "ability-hyperliquid",
       "e2e-test-utils"
     ],
     "projectsRelationship": "independent",

packages/apps/ability-hyperliquid/.env.example

@@ -0,0 +1,12 @@
+# Specifying this ENV in the root of the monorepo to reuse across Abilities will also work
+PINATA_JWT=
+
+ARBITRUM_RPC_URL=
+
+TEST_FUNDER_PRIVATE_KEY=
+
+TEST_APP_MANAGER_PRIVATE_KEY=
+
+TEST_APP_DELEGATEE_PRIVATE_KEY=
+
+TEST_AGENT_WALLET_PKP_OWNER_PRIVATE_KEY=

packages/apps/ability-hyperliquid/.gitignore

@@ -0,0 +1,4 @@
+**/**/vincent-contract-caller-config.json
+!.env.test.example
+test/test-config.json
+#src/generated/**/*

packages/apps/ability-hyperliquid/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing to Vincent Ability Hyperliquid
+
+This document provides guidelines for contributing to the Vincent Ability Hyperliquid project.
+
+<!-- TODO: Add documentation -->

packages/apps/ability-hyperliquid/README.md

@@ -0,0 +1,2 @@
+const denoFetch = (...args) => globalThis.fetch(...args);
+export default denoFetch;

packages/apps/ability-hyperliquid/deno-fetch-shim.js

@@ -0,0 +1,171 @@
+const fs = require('fs');
+const path = require('path');
+
+const esbuild = require('esbuild');
+const { polyfillNode } = require('@lit-protocol/esbuild-plugin-polyfill-node');
+const Hash = require('ipfs-only-hash');
+
+function aliasFetch() {
+  const shim = path.resolve(__dirname, 'deno-fetch-shim.js');
+
+  return {
+    name: 'alias-fetch',
+    setup(build) {
+      build.onResolve({ filter: /^node-fetch$/ }, () => ({ path: shim }));
+      build.onResolve({ filter: /^cross-fetch(\/.*)?$/ }, () => ({ path: shim }));
+    },
+  };
+}
+
+const ensureDirectoryExistence = (filePath) => {
+  const dirname = path.dirname(filePath);
+  if (!fs.existsSync(dirname)) {
+    fs.mkdirSync(dirname, { recursive: true });
+  }
+};
+
+function getBundledVincentAbilityCode() {
+  return `/**
+ * DO NOT EDIT THIS FILE. IT IS GENERATED ON BUILD.
+ */
+
+import { asBundledVincentAbility } from '@lit-protocol/vincent-ability-sdk';
+import { vincentAbility } from '../lib/vincent-ability';
+import metadata from './vincent-ability-metadata.json';
+
+if(!metadata.ipfsCid) {
+  throw new Error('ipfsCid is not defined in metadata JSON file');
+}
+
+export const bundledVincentAbility = asBundledVincentAbility(vincentAbility, metadata.ipfsCid);
+`;
+}
+
+function litActionModuleCode({ ipfsCid, content }) {
+  return `/**
+ * DO NOT EDIT THIS FILE. IT IS GENERATED ON BUILD.
+ * @type {string}
+ */
+const code = ${JSON.stringify(content)};
+module.exports = {
+  "code": code,
+  "ipfsCid": "${ipfsCid}",
+};
+`;
+}
+
+function metadataJsonFile({ ipfsCid }) {
+  return `{
+  "ipfsCid": "${ipfsCid}"
+}
+`;
+}
+
+const createBundledAbilityFile = {
+  name: 'create-vincent-bundled-ability-file',
+  setup(build) {
+    build.initialOptions.write = false;
+
+    const sourceDir = path.dirname(build.initialOptions.entryPoints[0]);
+
+    console.log(sourceDir);
+    build.onEnd(async (result) => {
+      if (result.errors.length > 0) {
+        console.error('Build failed with errors:', result.errors);
+        return;
+      }
+
+      const outputFile = result.outputFiles[0];
+      const content = outputFile.text;
+      const ipfsCid = await Hash.of(content);
+
+      // Write bundledAbility wrapper
+      const bundledSource = getBundledVincentAbilityCode();
+      const bundledPath = path.join(sourceDir, '../generated/vincent-bundled-ability.ts');
+      fs.writeFileSync(bundledPath, bundledSource);
+
+      // Write metadata JSON
+      const outputPath = path.dirname(path.resolve(outputFile.path));
+      const metadataPath = path.join(outputPath, 'vincent-ability-metadata.json');
+      const metadataContent = metadataJsonFile({ ipfsCid });
+      fs.writeFileSync(metadataPath, metadataContent);
+    });
+  },
+};
+
+const wrapIIFEInStringPlugin = {
+  name: 'wrap-iife-in-string',
+  setup(build) {
+    build.initialOptions.write = false;
+
+    build.onEnd(async (result) => {
+      if (result.errors.length > 0) {
+        console.error('Build failed with errors:', result.errors);
+        return;
+      }
+
+      const outputFile = result.outputFiles[0];
+      const content = outputFile.text;
+      const ipfsCid = await Hash.of(content);
+
+      const wrapped = litActionModuleCode({ content, ipfsCid });
+      const outputPath = path.resolve(outputFile.path);
+      ensureDirectoryExistence(outputPath);
+      fs.writeFileSync(outputPath, wrapped);
+    });
+  },
+};
+
+(async () => {
+  try {
+    await esbuild
+      .build({
+        tsconfig: './tsconfig.lib.json',
+        entryPoints: ['./src/lib/lit-action.ts'],
+        bundle: true,
+        minify: false,
+        sourcemap: false,
+        treeShaking: true,
+        metafile: true,
+        outdir: './src/generated/',
+        plugins: [
+          aliasFetch(),
+          polyfillNode({
+            globals: {
+              Buffer: true,
+              process: true,
+            },
+            modules: {
+              crypto: true,
+              http: true,
+              https: true,
+              stream: true,
+              zlib: true,
+              url: true,
+              util: true,
+            },
+          }),
+          wrapIIFEInStringPlugin,
+          createBundledAbilityFile,
+        ],
+        platform: 'browser',
+        write: false,
+      })
+      .then((result) => {
+        result.outputFiles.forEach((file) => {
+          const bytes = file.text.length;
+          const mbInBinary = (bytes / (1024 * 1024)).toFixed(4);
+          const mbInDecimal = (bytes / 1_000_000).toFixed(4);
+
+          console.log(
+            `✅ ${file.path.split('/').pop()}\n- ${mbInDecimal} MB (in decimal)\n- ${mbInBinary} MB (in binary)`,
+          );
+        });
+      });
+
+    console.log('✅ Vincent ability built successfully');
+  } catch (e) {
+    console.error('❌ Error building Vincent ability: ', e);
+    process.exit(1);
+  }
+})();

packages/apps/ability-hyperliquid/esbuild.config.js

@@ -0,0 +1,27 @@
+const baseConfig = require('../../../eslint.config.js');
+
+module.exports = [
+  ...baseConfig,
+  {
+    files: ['package.json'],
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          buildTargets: ['build'],
+          checkVersionMismatches: true,
+          ignoredFiles: [
+            '{projectRoot}/eslint.config.{js,cjs,mjs}',
+            '{projectRoot}/jest.config.{js,cjs,mjs,ts}',
+            '{projectRoot}/vite.config.*',
+            '{projectRoot}/esbuild.config.{js,cjs,mjs}',
+          ],
+          ignoredDependencies: [
+            // It's a peerDependency to ensure people don't try to use the wrong VincentAbilityClient with it -- not directly used.
+            '@lit-protocol/vincent-app-sdk',
+          ],
+        },
+      ],
+    },
+  },
+];