@oobe-protocol-labs/synapse-sap-sdk 0.14.0 → 0.15.0

package/dist/cjs/core/connection.js

@@ -0,0 +1,350 @@
+"use strict";
+/**
+ * @module core/connection
+ * @description RPC connection factory for SAP v2 SDK.
+ *
+ * Provides a high-level, synapse-client-sdk–compatible entry point
+ * for creating {@link SapClient} instances from an RPC URL and wallet.
+ *
+ * @category Core
+ * @since v0.1.0
+ *
+ * @example
+ * ```ts
+ * import { SapConnection } from "@synapse-sap/sdk";
+ *
+ * // Quick start — RPC URL + Keypair
+ * const sap = SapConnection.fromKeypair("https://api.devnet.solana.com", keypair);
+ * const agent = await sap.client.agent.fetch();
+ *
+ * // Or build step-by-step
+ * const conn = new SapConnection({
+ *   rpcUrl: "https://us-1-mainnet.oobeprotocol.ai/rpc?api_key=xxx",
+ *   cluster: "mainnet-beta",
+ *   commitment: "confirmed",
+ * });
+ * const client = conn.createClient(wallet);
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SapConnection = exports.KeypairWallet = void 0;
+const web3_js_1 = require("@solana/web3.js");
+const anchor_1 = require("@coral-xyz/anchor");
+const constants_1 = require("../constants");
+const client_1 = require("./client");
+/**
+ * @name KeypairWallet
+ * @description Simple wallet wrapper around a `Keypair`.
+ * Drop-in replacement for Anchor's `NodeWallet` / `Wallet` class.
+ * @category Core
+ * @since v0.4.1
+ */
+class KeypairWallet {
+    payer;
+    publicKey;
+    constructor(payer) {
+        this.payer = payer;
+        this.publicKey = payer.publicKey;
+    }
+    async signTransaction(tx) {
+        if ("partialSign" in tx) {
+            tx.partialSign(this.payer);
+        }
+        else {
+            tx.sign([this.payer]);
+        }
+        return tx;
+    }
+    async signAllTransactions(txs) {
+        for (const tx of txs) {
+            await this.signTransaction(tx);
+        }
+        return txs;
+    }
+}
+exports.KeypairWallet = KeypairWallet;
+// ═══════════════════════════════════════════════════════════════════
+//  Implementation
+// ═══════════════════════════════════════════════════════════════════
+/**
+ * @name SapConnection
+ * @description Lightweight RPC connection wrapper that creates
+ * properly-configured {@link SapClient} instances.
+ *
+ * Compatible with the `synapse-client-sdk` connection model:
+ * start from an RPC URL, attach a wallet, get a typed client.
+ *
+ * @category Core
+ * @since v0.1.0
+ * @see {@link SapClient}
+ * @see {@link SapConnectionConfig}
+ *
+ * @example
+ * ```ts
+ * // Factory shortcut for devnet
+ * const conn = SapConnection.devnet();
+ * const client = conn.createClient(wallet);
+ *
+ * // One-liner with Keypair
+ * const { client } = SapConnection.fromKeypair(
+ *   "https://api.devnet.solana.com",
+ *   keypair,
+ * );
+ * ```
+ */
+class SapConnection {
+    /**
+     * @readonly
+     * @description Raw Solana {@link Connection}. Exposed for advanced
+     * use-cases that need direct RPC access.
+     */
+    connection;
+    /**
+     * @readonly
+     * @description The resolved Solana cluster for this connection,
+     * either explicitly provided or auto-detected from the RPC URL.
+     */
+    cluster;
+    /**
+     * @readonly
+     * @description Commitment level used for all queries and
+     * transaction confirmations on this connection.
+     */
+    commitment;
+    /**
+     * @readonly
+     * @description The SAP on-chain program {@link PublicKey} resolved
+     * for the current {@link cluster}.
+     * @see {@link SapConnection.programIdForCluster}
+     */
+    programId;
+    constructor(config) {
+        this.commitment = config.commitment ?? "confirmed";
+        this.cluster = config.cluster ?? SapConnection.detectCluster(config.rpcUrl);
+        this.programId = SapConnection.programIdForCluster(this.cluster);
+        this.connection = new web3_js_1.Connection(config.rpcUrl, {
+            commitment: this.commitment,
+            wsEndpoint: config.wsUrl,
+        });
+    }
+    // ─────────────────────────────────────────────
+    //  Factory helpers
+    // ─────────────────────────────────────────────
+    /**
+     * Create a {@link SapConnection} for **devnet** with sensible defaults.
+     *
+     * @static
+     * @param {Commitment} [commitment="confirmed"] — Commitment level.
+     * @returns {SapConnection} A connection targeting Solana devnet.
+     * @since v0.1.0
+     *
+     * @example
+     * ```ts
+     * const conn = SapConnection.devnet();
+     * ```
+     */
+    static devnet(commitment = "confirmed") {
+        return new SapConnection({
+            rpcUrl: "https://api.devnet.solana.com",
+            cluster: "devnet",
+            commitment,
+        });
+    }
+    /**
+     * Create a {@link SapConnection} for **mainnet-beta** with sensible defaults.
+     *
+     * @static
+     * @param {string} [rpcUrl="https://api.mainnet-beta.solana.com"] — Custom RPC URL.
+     * @param {Commitment} [commitment="confirmed"] — Commitment level.
+     * @returns {SapConnection} A connection targeting Solana mainnet-beta.
+     * @since v0.1.0
+     *
+     * @example
+     * ```ts
+     * const conn = SapConnection.mainnet("https://my-rpc.example.com");
+     * ```
+     */
+    static mainnet(rpcUrl = "https://api.mainnet-beta.solana.com", commitment = "confirmed") {
+        return new SapConnection({ rpcUrl, cluster: "mainnet-beta", commitment });
+    }
+    /**
+     * Create a {@link SapConnection} for **localnet** (`localhost:8899`).
+     *
+     * @static
+     * @param {Commitment} [commitment="confirmed"] — Commitment level.
+     * @returns {SapConnection} A connection targeting a local validator.
+     * @since v0.1.0
+     *
+     * @example
+     * ```ts
+     * const conn = SapConnection.localnet();
+     * ```
+     */
+    static localnet(commitment = "confirmed") {
+        return new SapConnection({
+            rpcUrl: "http://localhost:8899",
+            cluster: "localnet",
+            commitment,
+        });
+    }
+    /**
+     * One-liner: create a {@link SapConnection} + {@link SapClient} from
+     * an RPC URL and a `Keypair`. Perfect for scripts and CLI tools.
+     *
+     * @static
+     * @param {string} rpcUrl — Solana JSON-RPC endpoint.
+     * @param {Keypair} keypair — Signer keypair.
+     * @param {object} [opts] — Optional overrides.
+     * @param {Commitment} [opts.commitment] — Commitment level.
+     * @param {SapCluster} [opts.cluster] — Explicit cluster hint.
+     * @returns {SapConnection & { readonly client: SapClient }} Connection with an attached client.
+     * @since v0.1.0
+     *
+     * @example
+     * ```ts
+     * const { client, connection } = SapConnection.fromKeypair(
+     *   "https://api.devnet.solana.com",
+     *   Keypair.generate(),
+     * );
+     * ```
+     */
+    static fromKeypair(rpcUrl, keypair, opts) {
+        const conn = new SapConnection({
+            rpcUrl,
+            commitment: opts?.commitment,
+            cluster: opts?.cluster,
+        });
+        const client = conn.createClient(new KeypairWallet(keypair));
+        return Object.assign(conn, { client });
+    }
+    // ─────────────────────────────────────────────
+    //  Client creation
+    // ─────────────────────────────────────────────
+    /**
+     * Create a {@link SapClient} from a {@link SapWallet} (signer).
+     *
+     * @param {SapWallet} wallet — A wallet/signer implementing {@link SapWallet}.
+     * @returns {SapClient} A fully-configured SAP client.
+     * @since v0.1.0
+     *
+     * @example
+     * ```ts
+     * const client = conn.createClient(new KeypairWallet(keypair));
+     * ```
+     */
+    createClient(wallet) {
+        const provider = new anchor_1.AnchorProvider(this.connection, wallet, {
+            commitment: this.commitment,
+        });
+        return client_1.SapClient.from(provider, this.programId);
+    }
+    /**
+     * Create a {@link SapClient} from a raw {@link Keypair}.
+     *
+     * @param {Keypair} keypair — The signer keypair.
+     * @returns {SapClient} A fully-configured SAP client.
+     * @since v0.1.0
+     *
+     * @example
+     * ```ts
+     * const client = conn.fromKeypair(Keypair.generate());
+     * ```
+     */
+    fromKeypair(keypair) {
+        return this.createClient(new KeypairWallet(keypair));
+    }
+    // ─────────────────────────────────────────────
+    //  Utility methods
+    // ─────────────────────────────────────────────
+    /**
+     * Request an airdrop (devnet / localnet only).
+     *
+     * @param {PublicKey} to — Recipient public key.
+     * @param {number} solAmount — Amount of SOL to airdrop.
+     * @returns {Promise<string>} The confirmed transaction signature.
+     * @throws {Error} If the airdrop request or confirmation fails (e.g. on mainnet).
+     * @since v0.1.0
+     *
+     * @example
+     * ```ts
+     * const sig = await conn.airdrop(wallet.publicKey, 2);
+     * ```
+     */
+    async airdrop(to, solAmount) {
+        const sig = await this.connection.requestAirdrop(to, solAmount * web3_js_1.LAMPORTS_PER_SOL);
+        await this.connection.confirmTransaction(sig, this.commitment);
+        return sig;
+    }
+    /**
+     * Get the SOL balance of an address in **lamports**.
+     *
+     * @param {PublicKey} address — The account to query.
+     * @returns {Promise<number>} Balance in lamports.
+     * @since v0.1.0
+     */
+    async getBalance(address) {
+        return this.connection.getBalance(address, this.commitment);
+    }
+    /**
+     * Get the SOL balance of an address in **SOL** (human-readable).
+     *
+     * @param {PublicKey} address — The account to query.
+     * @returns {Promise<number>} Balance in SOL.
+     * @since v0.1.0
+     *
+     * @example
+     * ```ts
+     * const sol = await conn.getBalanceSol(wallet.publicKey);
+     * console.log(`Balance: ${sol} SOL`);
+     * ```
+     */
+    async getBalanceSol(address) {
+        const lamports = await this.getBalance(address);
+        return lamports / web3_js_1.LAMPORTS_PER_SOL;
+    }
+    // ─────────────────────────────────────────────
+    //  Internal helpers
+    // ─────────────────────────────────────────────
+    /**
+     * Infer the {@link SapCluster} from an RPC URL by inspecting
+     * well-known substrings (`devnet`, `localhost`, `:8899`).
+     *
+     * @static
+     * @param {string} rpcUrl — The RPC endpoint to inspect.
+     * @returns {SapCluster} The detected cluster, defaulting to `"mainnet-beta"`.
+     * @since v0.1.0
+     */
+    static detectCluster(rpcUrl) {
+        const lower = rpcUrl.toLowerCase();
+        if (lower.includes("devnet"))
+            return "devnet";
+        if (lower.includes("localhost") ||
+            lower.includes("127.0.0.1") ||
+            lower.includes(":8899"))
+            return "localnet";
+        return "mainnet-beta";
+    }
+    /**
+     * Map a {@link SapCluster} to the canonical SAP on-chain program ID.
+     *
+     * @static
+     * @param {SapCluster} cluster — Target cluster.
+     * @returns {PublicKey} The program {@link PublicKey} for the given cluster.
+     * @since v0.1.0
+     * @see {@link SAP_PROGRAM_ID}
+     */
+    static programIdForCluster(cluster) {
+        switch (cluster) {
+            case "mainnet-beta":
+                return constants_1.MAINNET_SAP_PROGRAM_ID;
+            case "devnet":
+                return constants_1.DEVNET_SAP_PROGRAM_ID;
+            case "localnet":
+                return constants_1.LOCALNET_SAP_PROGRAM_ID;
+            default:
+                return constants_1.SAP_PROGRAM_ID;
+        }
+    }
+}
+exports.SapConnection = SapConnection;
+//# sourceMappingURL=connection.js.map

package/dist/cjs/core/connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../../src/core/connection.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;;;AAEH,6CAQyB;AACzB,8CAAmD;AACnD,4CAKsB;AACtB,qCAAqC;AAqBrC;;;;;;GAMG;AACH,MAAa,aAAa;IAGH;IAFZ,SAAS,CAAY;IAE9B,YAAqB,KAAc;QAAd,UAAK,GAAL,KAAK,CAAS;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,eAAe,CAA+C,EAAK;QACvE,IAAI,aAAa,IAAI,EAAE,EAAE,CAAC;YACvB,EAAkB,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACL,EAA2B,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAA+C,GAAQ;QAC9E,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAtBD,sCAsBC;AAoDD,sEAAsE;AACtE,kBAAkB;AAClB,sEAAsE;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,aAAa;IACxB;;;;OAIG;IACM,UAAU,CAAa;IAEhC;;;;OAIG;IACM,OAAO,CAAa;IAE7B;;;;OAIG;IACM,UAAU,CAAa;IAEhC;;;;;OAKG;IACM,SAAS,CAAY;IAE9B,YAAY,MAA2B;QACrC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEjE,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,MAAM,CAAC,MAAM,EAAE;YAC9C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,MAAM,CAAC,KAAK;SACzB,CAAC,CAAC;IACL,CAAC;IAED,gDAAgD;IAChD,mBAAmB;IACnB,gDAAgD;IAEhD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,CAAC,aAAyB,WAAW;QAChD,OAAO,IAAI,aAAa,CAAC;YACvB,MAAM,EAAE,+BAA+B;YACvC,OAAO,EAAE,QAAQ;YACjB,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,OAAO,CACZ,MAAM,GAAG,qCAAqC,EAC9C,aAAyB,WAAW;QAEpC,OAAO,IAAI,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAyB,WAAW;QAClD,OAAO,IAAI,aAAa,CAAC;YACvB,MAAM,EAAE,uBAAuB;YAC/B,OAAO,EAAE,UAAU;YACnB,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,WAAW,CAChB,MAAc,EACd,OAAgB,EAChB,IAAwD;QAExD,MAAM,IAAI,GAAG,IAAI,aAAa,CAAC;YAC7B,MAAM;YACN,UAAU,EAAE,IAAI,EAAE,UAAU;YAC5B,OAAO,EAAE,IAAI,EAAE,OAAO;SACvB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,gDAAgD;IAChD,mBAAmB;IACnB,gDAAgD;IAEhD;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,MAAiB;QAC5B,MAAM,QAAQ,GAAG,IAAI,uBAAc,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE;YAC3D,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;QACH,OAAO,kBAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,OAAgB;QAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,gDAAgD;IAChD,mBAAmB;IACnB,gDAAgD;IAEhD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,OAAO,CAAC,EAAa,EAAE,SAAiB;QAC5C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAC9C,EAAE,EACF,SAAS,GAAG,0BAAgB,CAC7B,CAAC;QACF,MAAM,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,OAAkB;QACjC,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa,CAAC,OAAkB;QACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAChD,OAAO,QAAQ,GAAG,0BAAgB,CAAC;IACrC,CAAC;IAED,gDAAgD;IAChD,oBAAoB;IACpB,gDAAgD;IAEhD;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,CAAC,MAAc;QACjC,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QACnC,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,OAAO,QAAQ,CAAC;QAC9C,IACE,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC3B,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC3B,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;YAEvB,OAAO,UAAU,CAAC;QACpB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,mBAAmB,CAAC,OAAmB;QAC5C,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,cAAc;gBACjB,OAAO,kCAAsB,CAAC;YAChC,KAAK,QAAQ;gBACX,OAAO,iCAAqB,CAAC;YAC/B,KAAK,UAAU;gBACb,OAAO,mCAAuB,CAAC;YACjC;gBACE,OAAO,0BAAc,CAAC;QAC1B,CAAC;IACH,CAAC;CACF;AA5RD,sCA4RC"}

package/dist/cjs/core/index.js

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * @module core
+ * @description Core infrastructure — client creation and RPC connection.
+ *
+ * @example
+ * ```ts
+ * import { SapClient, SapConnection } from "@synapse-sap/sdk";
+ *
+ * // From Anchor provider
+ * const client = SapClient.from(provider);
+ *
+ * // From RPC URL + keypair (synapse-client-sdk compatible)
+ * const conn = SapConnection.devnet();
+ * const client2 = conn.fromKeypair(keypair);
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeypairWallet = exports.SapConnection = exports.SapClient = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "SapClient", { enumerable: true, get: function () { return client_1.SapClient; } });
+var connection_1 = require("./connection");
+Object.defineProperty(exports, "SapConnection", { enumerable: true, get: function () { return connection_1.SapConnection; } });
+Object.defineProperty(exports, "KeypairWallet", { enumerable: true, get: function () { return connection_1.KeypairWallet; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,mCAAqC;AAA5B,mGAAA,SAAS,OAAA;AAClB,2CAA4D;AAAnD,2GAAA,aAAa,OAAA;AAAE,2GAAA,aAAa,OAAA"}