@n1xyz/nord-ts 0.0.21 → 0.1.0

package/README.md

@@ -6,10 +6,13 @@ This package provides an interface to interact with the Nord exchange. The core
 
 ```bash
 # npm
-npm install nord-ts
+npm install @n1xyz/nord-ts
 
 # yarn
-yarn add nord-ts
+yarn add @n1xyz/nord-ts
+
+# bun
+bun add @n1xyz/nord-ts
 ```
 
 ## Key Components
@@ -36,7 +39,7 @@ The `NordUser` class represents a user account on the Nord exchange:
 ### Initializing Nord
 
 ```typescript
-import { Nord } from "nord-ts";
+import { Nord } from "@n1xyz/nord-ts";
 
 // Create a Nord instance
 const nord = new Nord({
@@ -52,7 +55,7 @@ await Nord.initNord(nord); // Initialize client (derives program ID, fetches inf
 ### Creating a User from Private Key
 
 ```typescript
-import { Nord, NordUser } from "nord-ts";
+import { Nord, NordUser } from "@n1xyz/nord-ts";
 import { Connection } from "@solana/web3.js";
 
 // Define Nord configuration
@@ -83,7 +86,7 @@ await user.fetchInfo();
 ### Trading Operations
 
 ```typescript
-import { Nord, NordUser, Side, FillMode } from "nord-ts";
+import { Nord, NordUser, Side, FillMode } from "@n1xyz/nord-ts";
 
 // Assuming nord and user are already initialized
 
@@ -110,7 +113,7 @@ try {
 ### Deposits and Withdrawals
 
 ```typescript
-import { Nord, NordUser } from "nord-ts";
+import { Nord, NordUser } from "@n1xyz/nord-ts";
 
 // Assuming nord and user are already initialized
 
@@ -119,7 +122,7 @@ try {
   const tokenId = 0; // USDC
   const amount = 100; // 100 USDC
   
-  await user.withdraw(tokenId, amount);
+  await user.withdraw({ tokenId, amount });
   console.log(`Successfully withdrew ${amount} of token ID ${tokenId}`);
 } catch (error) {
   console.error(`Withdrawal error: ${error}`);
@@ -140,7 +143,7 @@ try {
 ### Market Data
 
 ```typescript
-import { Nord } from "nord-ts";
+import { Nord } from "@n1xyz/nord-ts";
 
 // Assuming nord is already initialized
 
@@ -150,7 +153,7 @@ console.log('Bids:', orderbook.bids);
 console.log('Asks:', orderbook.asks);
 
 // Get recent trades
-const trades = await nord.getTrades({ marketId: 0, limit: 10 });
+const trades = await nord.getTrades({ marketId: 0, pageSize: 10 });
 console.log('Recent trades:', trades.trades);
 
 // Subscribe to real-time orderbook updates
@@ -164,12 +167,12 @@ orderbookSub.on('update', (data) => {
 
 
 ```typescript
-import { Nord, NordUser } from "nord-ts";
+import { Nord, NordUser } from "@n1xyz/nord-ts";
 
 // Assuming nord and user are already initialized
 
-// Get account information
-const accountInfo = await user.fetchInfo();
+// Refresh user info
+await user.fetchInfo();
 
 // Access user balances
 console.log('Balances:', user.balances);
@@ -185,12 +188,13 @@ console.log('Orders:', user.orders);
 
 ```bash
 # Install dependencies
-yarn
+bun
 
 # Build the package
-yarn build
+bun run build
 ```
 
-## Documentation
+## Internals
 
-For more detailed documentation, please refer to the source code and inline comments in the `Nord` and `NordUser` classes.
+- `openapi` provides the OpenAPI-generated interfaces for HTTP (and partially WS) API of Nord
+- `nord_pb` provides the Protobuf-generated binary interface to build actions to be posted to `/action` API.

package/dist/api/client.d.ts

@@ -0,0 +1,14 @@
+import type { paths } from "../gen/openapi";
+export interface ClientConfig {
+    baseUrl: string;
+}
+export declare function createApiClient(config: ClientConfig): import("openapi-fetch").Client<paths, `${string}/${string}`>;
+export declare function handleApiResponse<T>(response: Promise<{
+    data: T;
+    error?: unknown;
+    response: Response;
+} | {
+    data?: never;
+    error?: unknown;
+    response: Response;
+}>): Promise<T>;

package/dist/api/client.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createApiClient = createApiClient;
+exports.handleApiResponse = handleApiResponse;
+const openapi_fetch_1 = __importDefault(require("openapi-fetch"));
+const NordError_1 = require("../nord/utils/NordError");
+function createApiClient(config) {
+    const client = (0, openapi_fetch_1.default)({
+        baseUrl: config.baseUrl,
+    });
+    client.use({
+        onResponse({ response }) {
+            if (!response.ok) {
+                throw new NordError_1.NordError(`HTTP ${response.status}: ${response.statusText}`, {
+                    statusCode: response.status,
+                    details: { url: response.url }
+                });
+            }
+            return response;
+        },
+    });
+    return client;
+}
+async function handleApiResponse(response) {
+    const result = await response;
+    if (result.error || !result.response.ok) {
+        const errorMessage = result.error
+            ? `HTTP ${result.response.status}: ${result.response.statusText}`
+            : `Request failed: ${result.response.statusText}`;
+        throw new NordError_1.NordError(errorMessage, {
+            statusCode: result.response.status,
+            details: { url: result.response.url }
+        });
+    }
+    if (!('data' in result)) {
+        throw new NordError_1.NordError("No data in response", {
+            statusCode: 500,
+            details: { url: result.response.url }
+        });
+    }
+    return result.data;
+}

package/dist/bridge/client.d.ts

@@ -0,0 +1,151 @@
+import * as anchor from "@coral-xyz/anchor";
+import { AnchorProvider } from "@coral-xyz/anchor";
+import { Connection, Keypair, PublicKey } from "@solana/web3.js";
+import { BlockFacts, DepositSplParams, PdaSeedType, SolanaBridgeConfig, WithdrawalParams } from "./types";
+/**
+ * Solana Bridge Client for interacting with the bridge program
+ */
+export declare class SolanaBridgeClient {
+    /** Anchor program instance */
+    program: any;
+    /** Solana connection */
+    connection: Connection;
+    /** Program ID */
+    programId: PublicKey;
+    /** Configuration */
+    config: SolanaBridgeConfig;
+    /** Anchor provider */
+    provider: AnchorProvider;
+    bridge: PublicKey;
+    /**
+     * Create a new Solana Bridge Client
+     *
+     * @param config Bridge configuration
+     * @param wallet Anchor wallet for signing transactions
+     */
+    constructor(config: SolanaBridgeConfig, wallet: anchor.Wallet);
+    /**
+     * Derive a PDA (Program Derived Address) for the given seeds
+     *
+     * Seeds can be of type:
+     * - Buffer: raw bytes
+     * - PublicKey: Solana public key
+     * - string: string encoded as UTF-8 bytes
+     * - number: u64 encoded as little-endian 8 bytes
+     *
+     * @param type PDA seed type
+     * @param seeds Additional seeds
+     * @returns [PDA, bump]
+     */
+    findPda(type: PdaSeedType, ...seeds: any[]): Promise<[PublicKey, number]>;
+    /**
+     * Find the asset config PDA for a token mint
+     *
+     * @param mint Token mint address
+     * @returns [PDA, bump]
+     */
+    findAssetConfigPda(mint: PublicKey): Promise<[PublicKey, number]>;
+    /**
+     * Find the deposit storage PDA for a deposit index
+     *
+     * @param depositIndex Deposit index
+     * @returns [PDA, bump]
+     */
+    findDepositStoragePda(depositIndex: number): Promise<[PublicKey, number]>;
+    /**
+     * Find the block storage PDA for a block ID
+     *
+     * @param blockId Block ID
+     * @returns [PDA, bump]
+     */
+    findBlockStoragePda(blockId: number): Promise<[PublicKey, number]>;
+    /**
+     * Find the withdrawal nullifier PDA
+     *
+     * @param blockId Block ID
+     * @param leafIndex Leaf index
+     * @returns [PDA, bump]
+     */
+    findWithdrawalNullifierPda(blockId: number, leafIndex: number): Promise<[PublicKey, number]>;
+    /**
+     * Find the authority PDA
+     *
+     * @returns [PDA, bump]
+     */
+    findAuthorityPda(): Promise<[PublicKey, number]>;
+    /**
+     * Helper method to sign and send a transaction
+     *
+     * @param transaction Transaction to sign and send
+     * @param signers Additional signers (beyond the provider's wallet)
+     * @returns Transaction signature
+     */
+    private signAndSendTransaction;
+    /**
+     * Deposit SPL tokens to the bridge
+     *
+     * @param params Deposit parameters
+     * @param signer Signer keypair
+     * @returns Transaction signature
+     */
+    depositSpl(params: DepositSplParams): Promise<string>;
+    /**
+     * Withdraw tokens from the bridge
+     *
+     * @param params Withdrawal parameters
+     * @param signer Signer keypair
+     * @returns Transaction signature
+     */
+    withdraw(params: WithdrawalParams, signer: Keypair): Promise<string>;
+    /**
+     * Whitelist an asset (token) for use with the bridge
+     *
+     * @param mint Token mint address
+     * @param signer Operator keypair
+     * @returns Transaction signature
+     */
+    whitelistAsset(mint: PublicKey, signer: Keypair): Promise<string>;
+    /**
+     * Propose a new block
+     *
+     * @param facts Block facts
+     * @param signer Operator keypair
+     * @returns Transaction signature
+     */
+    proposeBlock(facts: BlockFacts, signer: Keypair): Promise<string>;
+    /**
+     * Finalize a block
+     *
+     * @param blockId Block ID
+     * @param stateUpdateId State update ID
+     * @param signer Payer keypair
+     * @returns Transaction signature
+     */
+    finalizeBlock(blockId: number, stateUpdateId: number, signer: Keypair): Promise<string>;
+    /**
+     * Finalize a DA fact
+     *
+     * @param fact DA fact (32-byte array)
+     * @param signer Payer keypair
+     * @returns Transaction signature
+     */
+    finalizeDaFact(fact: Buffer, signer: Keypair): Promise<string>;
+    /**
+     * Initialize the bridge contract
+     *
+     * @param operator Operator public key
+     * @param initialAppStateCommitment Initial app state commitment (32-byte array)
+     * @param signer Payer keypair
+     * @returns Transaction signature
+     */
+    initialize(operator: PublicKey, initialAppStateCommitment: Buffer, signer: Keypair): Promise<string>;
+    /**
+     * Create an associated token account if it doesn't exist
+     *
+     * @param mint Token mint
+     * @param owner Account owner
+     * @param payer Transaction payer
+     * @returns Associated token account address
+     */
+    createTokenAccountIfNeeded(mint: PublicKey, owner: PublicKey, payer: Keypair): Promise<PublicKey>;
+}