@nktkas/hyperliquid 0.22.1 → 0.22.2

package/README.md

@@ -48,6 +48,66 @@ deno add jsr:@nktkas/hyperliquid
 </script>
 ```
 
+### React Native
+
+<details>
+<summary>For React Native, you need to import several polyfills before importing the SDK:</summary>
+
+```js
+// React Native 0.76.3
+import { Event, EventTarget } from "event-target-shim";
+
+if (!globalThis.EventTarget || !globalThis.Event) {
+    globalThis.EventTarget = EventTarget;
+    globalThis.Event = Event;
+}
+
+if (!globalThis.CustomEvent) {
+    globalThis.CustomEvent = function (type, params) {
+        params = params || {};
+        const event = new Event(type, params);
+        event.detail = params.detail || null;
+        return event;
+    };
+}
+
+if (!AbortSignal.timeout) {
+    AbortSignal.timeout = function (delay) {
+        const controller = new AbortController();
+        setTimeout(() => controller.abort(), delay);
+        return controller.signal;
+    };
+}
+
+if (!Promise.withResolvers) {
+    Promise.withResolvers = function () {
+        let resolve, reject;
+        const promise = new Promise((res, rej) => {
+            resolve = res;
+            reject = rej;
+        });
+        return { promise, resolve, reject };
+    };
+}
+
+if (!ArrayBuffer.prototype.transfer) {
+    ArrayBuffer.prototype.transfer = function (newByteLength) {
+        const length = newByteLength ?? this.byteLength;
+        const newBuffer = new ArrayBuffer(length);
+        const oldView = new Uint8Array(this);
+        const newView = new Uint8Array(newBuffer);
+
+        newView.set(oldView.subarray(0, Math.min(oldView.length, length)));
+
+        Object.defineProperty(this, "byteLength", { value: 0 });
+
+        return newBuffer;
+    };
+}
+```
+
+</details>
+
 ## Quick Start
 
 #### Info endpoint
@@ -65,12 +125,11 @@ const openOrders = await infoClient.openOrders({ user: "0x..." });
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
-import { privateKeyToAccount } from "viem/accounts"; // or other wallet libraries
 
-const wallet = privateKeyToAccount("0x...");
+const privateKey = "0x..."; // or `viem`, `ethers`
 
 const transport = new hl.HttpTransport();
-const exchClient = new hl.ExchangeClient({ wallet, transport });
+const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
 
 const result = await exchClient.order({
     orders: [{
@@ -108,15 +167,11 @@ await sub.unsubscribe(); // unsubscribe from the event
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
-import { privateKeyToAccount } from "viem/accounts"; // or other wallet libraries
 
 const multiSignAddress = "0x...";
 const signers = [
-    privateKeyToAccount("0x..."), // first is leader
-    privateKeyToAccount("0x..."), // can be a custom async wallet
-    // ...
-    privateKeyToAccount("0x..."),
-];
+    "0x...", // Private key; or any other wallet libraries
+] as const;
 
 const transport = new hl.HttpTransport();
 const multiSignClient = new hl.MultiSignClient({ transport, multiSignAddress, signers }); // extends ExchangeClient
@@ -167,20 +222,24 @@ import { ethers } from "ethers";
 
 const transport = new hl.HttpTransport(); // or WebSocketTransport
 
-// 1. Using Viem with private key
+// 1. Using private key
+const privateKey = "0x...";
+const exchClient_privateKey = new hl.ExchangeClient({ wallet: privateKey, transport });
+
+// 2. Using Viem with private key
 const viemAccount = privateKeyToAccount("0x...");
 const exchClient_viem = new hl.ExchangeClient({ wallet: viemAccount, transport });
 
-// 2. Using Ethers (or Ethers V5) with private key
+// 3. Using Ethers (or Ethers V5) with private key
 const ethersWallet = new ethers.Wallet("0x...");
 const exchClient_ethers = new hl.ExchangeClient({ wallet: ethersWallet, transport });
 
-// 3. Using external wallet (e.g. MetaMask) via Viem
+// 4. Using external wallet (e.g. MetaMask) via Viem
 const [account] = await window.ethereum.request({ method: "eth_requestAccounts" });
 const externalWallet = createWalletClient({ account, transport: custom(window.ethereum) });
 const exchClient_viemMetamask = new hl.ExchangeClient({ wallet: externalWallet, transport });
 
-// 4. Using external wallet (e.g. MetaMask) via `window.ethereum` (EIP-1193)
+// 5. Using external wallet (e.g. MetaMask) via `window.ethereum` (EIP-1193)
 const exchClient_windowMetamask = new hl.ExchangeClient({ wallet: window.ethereum, transport });
 ```
 
@@ -203,6 +262,7 @@ import { ethers } from "ethers";
 const multiSignAddress = "0x...";
 const signers = [
     privateKeyToAccount("0x..."), // first is leader for multi-sign transaction, must contain own address
+    new ethers.Wallet("0x..."),
     { // can be a custom async wallet
         signTypedData(params: {
             domain: {
@@ -224,8 +284,7 @@ const signers = [
             return "0x..."; // return signature
         },
     },
-    // ...
-    new ethers.Wallet("0x..."),
+    "0x...", // private key directly
 ];
 
 const transport = new hl.HttpTransport();
@@ -258,12 +317,11 @@ const openOrders = await infoClient.openOrders({ user: "0x..." });
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
-import { privateKeyToAccount } from "viem/accounts";
 
-const account = privateKeyToAccount("0x...");
+const privateKey = "0x..."; // or `viem`, `ethers`
 
 const transport = new hl.HttpTransport();
-const exchClient = new hl.ExchangeClient({ wallet: account, transport });
+const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
 
 // Place an orders
 const result = await exchClient.order({
@@ -323,10 +381,11 @@ const sub = await subsClient.candle({ coin: "BTC", interval: "1h" }, (data) => {
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
-import { privateKeyToAccount } from "viem/accounts";
 
 const multiSignAddress = "0x...";
-const signers = [privateKeyToAccount("0x...")];
+const signers = [
+    "0x...", // Private keys
+] as const;
 
 const transport = new hl.HttpTransport();
 const multiSignClient = new hl.MultiSignClient({ transport, multiSignAddress, signers });
@@ -555,7 +614,7 @@ class SubscriptionClient {
 
     // Explorer
     explorerBlock(listener: (data: WsBlockDetails[]) => void): Promise<Subscription>;
-    explorerTx(listener: (data: TxDetails[]) => void): Promise<Subscription>;
+    explorerTxs(listener: (data: TxDetails[]) => void): Promise<Subscription>;
 }
 ```
 <!-- deno-fmt-ignore-end -->
@@ -647,9 +706,8 @@ The import point gives access to functions that generate signatures for Hyperliq
 
 ```ts
 import { actionSorter, signL1Action } from "@nktkas/hyperliquid/signing";
-import { privateKeyToAccount } from "viem/accounts"; // or other wallet libraries
 
-const wallet = privateKeyToAccount("0x...");
+const privateKey = "0x..."; // or `viem`, `ethers`
 
 const action = {
     type: "cancel",
@@ -660,7 +718,7 @@ const action = {
 const nonce = Date.now();
 
 const signature = await signL1Action({
-    wallet,
+    wallet: privateKey,
     action: actionSorter[action.type](action), // key order affects signature
     nonce,
     isTestnet: true, // change to `false` for mainnet
@@ -678,9 +736,8 @@ const body = await response.json();
 
 ```ts
 import { signUserSignedAction, userSignedActionEip712Types } from "@nktkas/hyperliquid/signing";
-import { privateKeyToAccount } from "viem/accounts"; // or other wallet libraries
 
-const wallet = privateKeyToAccount("0x...");
+const privateKey = "0x..."; // or `viem`, `ethers`
 
 const action = {
     type: "approveAgent",
@@ -692,7 +749,7 @@ const action = {
 };
 
 const signature = await signUserSignedAction({
-    wallet,
+    wallet: privateKey,
     action,
     types: userSignedActionEip712Types[action.type], // key order affects signature
     chainId: parseInt(action.signatureChainId, 16),

package/esm/mod.d.ts

@@ -1,6 +1,6 @@
 export * from "./src/base.js";
 export * from "./src/transports/base.js";
-export type { AbstractEthersSigner, AbstractEthersV5Signer, AbstractViemWalletClient, AbstractWindowEthereum, } from "./src/signing.js";
+export type { AbstractEthersSigner, AbstractEthersV5Signer, AbstractViemWalletClient, AbstractWindowEthereum, } from "./src/signing/mod.js";
 export * from "./src/clients/exchange.js";
 export * from "./src/clients/info.js";
 export * from "./src/clients/multiSign.js";

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AAGzC,YAAY,EACR,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,GACzB,MAAM,kBAAkB,CAAC;AAG1B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAG9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,mDAAmD,CAAC;AAGlE,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,iCAAiC,CAAC;AACrD,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,wCAAwC,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AAGzC,YAAY,EACR,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,GACzB,MAAM,sBAAsB,CAAC;AAG9B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAG9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,mDAAmD,CAAC;AAGlE,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,iCAAiC,CAAC;AACrD,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,wCAAwC,CAAC"}