@shuffle-protocol/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { ShuffleClient } from "./client";
+export type { UserBalance, OrderInfo, DecryptedOrderInfo, BatchInfo, BatchResult, PairResult, ShuffleConfig, EstimatedPayout, EffectiveBalance, } from "./types";
+export { AssetId, PairId, Direction, PROGRAM_ID, NUM_PAIRS, NUM_ASSETS, POOL_SEED, USER_SEED, BATCH_ACCUMULATOR_SEED, BATCH_LOG_SEED, VAULT_SEED, VAULT_ASSET_SEEDS, ASSET_LABELS, PAIR_TOKENS, } from "./constants";
+export { getPoolPDA, getUserAccountPDA, getBatchAccumulatorPDA, getBatchLogPDA, getVaultPDA, } from "./pda";
+export { generateEncryptionKeypair, createCipher, encryptValue, decryptValue, fetchMXEPublicKey, nonceToBN, } from "./encryption";
+export type { EncryptionKeypair, EncryptedValue } from "./encryption";
+export { ShuffleError, parseError, ERROR_MAP } from "./errors";

package/dist/index.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR_MAP = exports.parseError = exports.ShuffleError = exports.nonceToBN = exports.fetchMXEPublicKey = exports.decryptValue = exports.encryptValue = exports.createCipher = exports.generateEncryptionKeypair = exports.getVaultPDA = exports.getBatchLogPDA = exports.getBatchAccumulatorPDA = exports.getUserAccountPDA = exports.getPoolPDA = exports.PAIR_TOKENS = exports.ASSET_LABELS = exports.VAULT_ASSET_SEEDS = exports.VAULT_SEED = exports.BATCH_LOG_SEED = exports.BATCH_ACCUMULATOR_SEED = exports.USER_SEED = exports.POOL_SEED = exports.NUM_ASSETS = exports.NUM_PAIRS = exports.PROGRAM_ID = exports.Direction = exports.PairId = exports.AssetId = exports.ShuffleClient = void 0;
+// Main SDK exports
+var client_1 = require("./client");
+Object.defineProperty(exports, "ShuffleClient", { enumerable: true, get: function () { return client_1.ShuffleClient; } });
+// Constants & Enums
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "AssetId", { enumerable: true, get: function () { return constants_1.AssetId; } });
+Object.defineProperty(exports, "PairId", { enumerable: true, get: function () { return constants_1.PairId; } });
+Object.defineProperty(exports, "Direction", { enumerable: true, get: function () { return constants_1.Direction; } });
+Object.defineProperty(exports, "PROGRAM_ID", { enumerable: true, get: function () { return constants_1.PROGRAM_ID; } });
+Object.defineProperty(exports, "NUM_PAIRS", { enumerable: true, get: function () { return constants_1.NUM_PAIRS; } });
+Object.defineProperty(exports, "NUM_ASSETS", { enumerable: true, get: function () { return constants_1.NUM_ASSETS; } });
+Object.defineProperty(exports, "POOL_SEED", { enumerable: true, get: function () { return constants_1.POOL_SEED; } });
+Object.defineProperty(exports, "USER_SEED", { enumerable: true, get: function () { return constants_1.USER_SEED; } });
+Object.defineProperty(exports, "BATCH_ACCUMULATOR_SEED", { enumerable: true, get: function () { return constants_1.BATCH_ACCUMULATOR_SEED; } });
+Object.defineProperty(exports, "BATCH_LOG_SEED", { enumerable: true, get: function () { return constants_1.BATCH_LOG_SEED; } });
+Object.defineProperty(exports, "VAULT_SEED", { enumerable: true, get: function () { return constants_1.VAULT_SEED; } });
+Object.defineProperty(exports, "VAULT_ASSET_SEEDS", { enumerable: true, get: function () { return constants_1.VAULT_ASSET_SEEDS; } });
+Object.defineProperty(exports, "ASSET_LABELS", { enumerable: true, get: function () { return constants_1.ASSET_LABELS; } });
+Object.defineProperty(exports, "PAIR_TOKENS", { enumerable: true, get: function () { return constants_1.PAIR_TOKENS; } });
+// PDA helpers
+var pda_1 = require("./pda");
+Object.defineProperty(exports, "getPoolPDA", { enumerable: true, get: function () { return pda_1.getPoolPDA; } });
+Object.defineProperty(exports, "getUserAccountPDA", { enumerable: true, get: function () { return pda_1.getUserAccountPDA; } });
+Object.defineProperty(exports, "getBatchAccumulatorPDA", { enumerable: true, get: function () { return pda_1.getBatchAccumulatorPDA; } });
+Object.defineProperty(exports, "getBatchLogPDA", { enumerable: true, get: function () { return pda_1.getBatchLogPDA; } });
+Object.defineProperty(exports, "getVaultPDA", { enumerable: true, get: function () { return pda_1.getVaultPDA; } });
+// Encryption helpers
+var encryption_1 = require("./encryption");
+Object.defineProperty(exports, "generateEncryptionKeypair", { enumerable: true, get: function () { return encryption_1.generateEncryptionKeypair; } });
+Object.defineProperty(exports, "createCipher", { enumerable: true, get: function () { return encryption_1.createCipher; } });
+Object.defineProperty(exports, "encryptValue", { enumerable: true, get: function () { return encryption_1.encryptValue; } });
+Object.defineProperty(exports, "decryptValue", { enumerable: true, get: function () { return encryption_1.decryptValue; } });
+Object.defineProperty(exports, "fetchMXEPublicKey", { enumerable: true, get: function () { return encryption_1.fetchMXEPublicKey; } });
+Object.defineProperty(exports, "nonceToBN", { enumerable: true, get: function () { return encryption_1.nonceToBN; } });
+// Errors
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "ShuffleError", { enumerable: true, get: function () { return errors_1.ShuffleError; } });
+Object.defineProperty(exports, "parseError", { enumerable: true, get: function () { return errors_1.parseError; } });
+Object.defineProperty(exports, "ERROR_MAP", { enumerable: true, get: function () { return errors_1.ERROR_MAP; } });

package/dist/pda.d.ts

@@ -0,0 +1,7 @@
+import { PublicKey } from "@solana/web3.js";
+import * as anchor from "@coral-xyz/anchor";
+export declare function getPoolPDA(programId: PublicKey): [PublicKey, number];
+export declare function getUserAccountPDA(programId: PublicKey, owner: PublicKey): [PublicKey, number];
+export declare function getBatchAccumulatorPDA(programId: PublicKey): [PublicKey, number];
+export declare function getBatchLogPDA(programId: PublicKey, batchId: number | anchor.BN): [PublicKey, number];
+export declare function getVaultPDA(programId: PublicKey, assetSeed: string): [PublicKey, number];

package/dist/pda.js

@@ -0,0 +1,59 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPoolPDA = getPoolPDA;
+exports.getUserAccountPDA = getUserAccountPDA;
+exports.getBatchAccumulatorPDA = getBatchAccumulatorPDA;
+exports.getBatchLogPDA = getBatchLogPDA;
+exports.getVaultPDA = getVaultPDA;
+const web3_js_1 = require("@solana/web3.js");
+const anchor = __importStar(require("@coral-xyz/anchor"));
+const constants_1 = require("./constants");
+function getPoolPDA(programId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([Buffer.from(constants_1.POOL_SEED)], programId);
+}
+function getUserAccountPDA(programId, owner) {
+    return web3_js_1.PublicKey.findProgramAddressSync([Buffer.from(constants_1.USER_SEED), owner.toBuffer()], programId);
+}
+function getBatchAccumulatorPDA(programId) {
+    return web3_js_1.PublicKey.findProgramAddressSync([Buffer.from(constants_1.BATCH_ACCUMULATOR_SEED)], programId);
+}
+function getBatchLogPDA(programId, batchId) {
+    const bn = typeof batchId === "number" ? new anchor.BN(batchId) : batchId;
+    return web3_js_1.PublicKey.findProgramAddressSync([Buffer.from(constants_1.BATCH_LOG_SEED), Buffer.from(bn.toArray("le", 8))], programId);
+}
+function getVaultPDA(programId, assetSeed) {
+    return web3_js_1.PublicKey.findProgramAddressSync([Buffer.from(constants_1.VAULT_SEED), Buffer.from(assetSeed)], programId);
+}

package/dist/types.d.ts

@@ -0,0 +1,83 @@
+import { PublicKey } from "@solana/web3.js";
+import { AssetId, PairId, Direction } from "./constants";
+import * as anchor from "@coral-xyz/anchor";
+/** Decrypted balances for all 4 assets */
+export interface UserBalance {
+    usdc: bigint;
+    tsla: bigint;
+    spy: bigint;
+    aapl: bigint;
+}
+/** Pending order info (decoded from on-chain UserProfile) */
+export interface OrderInfo {
+    batchId: number;
+    pairId: number[];
+    direction: number[];
+    encryptedAmount: number[];
+}
+/** Decrypted order info - user-readable after decryption */
+export interface DecryptedOrderInfo {
+    batchId: number;
+    pairId: number;
+    direction: number;
+    amount: bigint;
+}
+/** Batch accumulator state */
+export interface BatchInfo {
+    batchId: number;
+    orderCount: number;
+    /** MXE nonce - 0 means batch state needs initialization */
+    mxeNonce: string;
+}
+/** Per-pair result from a batch execution */
+export interface PairResult {
+    totalAIn: anchor.BN;
+    totalBIn: anchor.BN;
+    finalPoolA: anchor.BN;
+    finalPoolB: anchor.BN;
+}
+/** Full batch log with results for all 6 pairs */
+export interface BatchResult {
+    batchId: number;
+    results: PairResult[];
+}
+/** SDK constructor configuration */
+export interface ShuffleConfig {
+    connection: anchor.web3.Connection;
+    wallet: anchor.Wallet;
+    programId?: PublicKey;
+    /** Arcium cluster offset (default: 0 for localnet) */
+    clusterOffset?: number;
+}
+/** Estimated payout for a pending order after batch execution */
+export interface EstimatedPayout {
+    /** The batch this payout is from */
+    batchId: number;
+    /** The pair for this order */
+    pairId: number;
+    /** Direction: 0=A_to_B, 1=B_to_A */
+    direction: number;
+    /** User's order amount (decrypted) */
+    orderAmount: bigint;
+    /** Total input to the pool for this direction */
+    totalInput: bigint;
+    /** Final pool output for this direction */
+    finalPoolOutput: bigint;
+    /** Calculated pro-rata payout */
+    estimatedPayout: bigint;
+    /** Output asset ID (what the user receives) */
+    outputAssetId: AssetId;
+}
+/** Effective balance including pending payout */
+export interface EffectiveBalance {
+    /** Current on-chain balance */
+    currentBalance: bigint;
+    /** Estimated payout from pending order (0 if none) */
+    pendingPayout: bigint;
+    /** Total effective balance (current + pending) */
+    effectiveBalance: bigint;
+    /** Whether there's a pending order to settle */
+    hasPendingOrder: boolean;
+}
+/** Re-export enums for convenience */
+export { AssetId, PairId, Direction };

package/dist/types.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Direction = exports.PairId = exports.AssetId = void 0;
+const constants_1 = require("./constants");
+Object.defineProperty(exports, "AssetId", { enumerable: true, get: function () { return constants_1.AssetId; } });
+Object.defineProperty(exports, "PairId", { enumerable: true, get: function () { return constants_1.PairId; } });
+Object.defineProperty(exports, "Direction", { enumerable: true, get: function () { return constants_1.Direction; } });

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@shuffle-protocol/sdk",
+  "version": "0.1.0",
+  "description": "CLI and SDK for the Shuffle privacy protocol on Solana",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "shuffle": "./dist/cli/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "clean": "rm -rf dist"
+  },
+  "keywords": [
+    "solana",
+    "privacy",
+    "defi",
+    "mpc",
+    "arcium",
+    "shuffle"
+  ],
+  "author": "tothster",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tothster/shuffle"
+  },
+  "homepage": "https://github.com/tothster/shuffle#readme",
+  "bugs": {
+    "url": "https://github.com/tothster/shuffle/issues"
+  },
+  "dependencies": {
+    "@arcium-hq/client": "0.6.3",
+    "@coral-xyz/anchor": "^0.32.1",
+    "@solana/web3.js": "^1.98.4",
+    "@solana/spl-token": "^0.4.14",
+    "commander": "^12.0.0",
+    "inquirer": "^8.2.6",
+    "ora": "^5.4.1",
+    "chalk": "^4.1.2"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.0",
+    "@types/node": "^20.0.0",
+    "@types/inquirer": "^8.2.10"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}