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

package/dist/cjs/modules/attestation.js

@@ -0,0 +1,147 @@
+"use strict";
+/**
+ * @module attestation
+ * @description Web-of-trust attestations — create, revoke, and close
+ *   on-chain attestations that vouch for agent trustworthiness.
+ *
+ * Attestations are signed endorsements from one wallet to an agent,
+ * forming a composable trust graph on Solana.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttestationModule = void 0;
+const web3_js_1 = require("@solana/web3.js");
+const base_1 = require("./base");
+const pda_1 = require("../pda");
+/**
+ * @name AttestationModule
+ * @description Manages on-chain attestations for the Synapse Agent Protocol.
+ *   Provides methods to create, revoke, close, and fetch attestation PDAs
+ *   that form the web-of-trust layer.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @extends BaseModule
+ *
+ * @example
+ * ```ts
+ * const sap = new SapClient(provider);
+ * // Create an attestation for an agent
+ * const sig = await sap.attestation.create(agentWallet, {
+ *   attestationType: { identity: {} },
+ *   metadataHash: [...],
+ *   expiresAt: null,
+ * });
+ * ```
+ */
+class AttestationModule extends base_1.BaseModule {
+    // ── PDA helpers ──────────────────────────────────────
+    /**
+     * @name deriveAttestation
+     * @description Derive the `AgentAttestation` PDA for a given agent and attester.
+     * @param agentPda - The agent account PDA to attest.
+     * @param attester - The attester wallet. Defaults to the connected wallet.
+     * @returns A tuple of `[PublicKey, bump]` for the attestation PDA.
+     * @see {@link deriveAttestation} from `pda/` module for the underlying derivation.
+     * @since v0.1.0
+     */
+    deriveAttestation(agentPda, attester) {
+        return (0, pda_1.deriveAttestation)(agentPda, attester ?? this.walletPubkey);
+    }
+    // ── Instructions ─────────────────────────────────────
+    /**
+     * @name create
+     * @description Create an on-chain attestation vouching for an agent.
+     *   The connected wallet becomes the attester.
+     * @param agentWallet - The wallet that owns the target agent.
+     * @param args - Attestation parameters (type, metadata hash, optional expiry).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    async create(agentWallet, args) {
+        const [agentPda] = (0, pda_1.deriveAgent)(agentWallet);
+        const [attestPda] = this.deriveAttestation(agentPda);
+        const [globalPda] = (0, pda_1.deriveGlobalRegistry)();
+        return this.methods
+            .createAttestation(args.attestationType, args.metadataHash, args.expiresAt)
+            .accounts({
+            attester: this.walletPubkey,
+            agent: agentPda,
+            attestation: attestPda,
+            globalRegistry: globalPda,
+            systemProgram: web3_js_1.SystemProgram.programId,
+        })
+            .rpc();
+    }
+    /**
+     * @name revoke
+     * @description Revoke a previously issued attestation. Only the original
+     *   attester may revoke.
+     * @param agentWallet - The wallet of the attested agent.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    async revoke(agentWallet) {
+        const [agentPda] = (0, pda_1.deriveAgent)(agentWallet);
+        const [attestPda] = this.deriveAttestation(agentPda);
+        return this.methods
+            .revokeAttestation()
+            .accounts({
+            attester: this.walletPubkey,
+            attestation: attestPda,
+        })
+            .rpc();
+    }
+    /**
+     * @name close
+     * @description Close a revoked attestation PDA and reclaim rent to the attester.
+     * @param agentWallet - The wallet of the attested agent.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    async close(agentWallet) {
+        const [agentPda] = (0, pda_1.deriveAgent)(agentWallet);
+        const [attestPda] = this.deriveAttestation(agentPda);
+        const [globalPda] = (0, pda_1.deriveGlobalRegistry)();
+        return this.methods
+            .closeAttestation()
+            .accounts({
+            attester: this.walletPubkey,
+            attestation: attestPda,
+            globalRegistry: globalPda,
+        })
+            .rpc();
+    }
+    // ── Fetchers ─────────────────────────────────────────
+    /**
+     * @name fetch
+     * @description Fetch a deserialized `AgentAttestation` account.
+     * @param agentPda - The agent account PDA.
+     * @param attester - The attester wallet. Defaults to the connected wallet.
+     * @returns {Promise<AgentAttestationData>} The attestation account data.
+     * @throws Will throw if the attestation account does not exist.
+     * @since v0.1.0
+     */
+    async fetch(agentPda, attester) {
+        const [pda] = this.deriveAttestation(agentPda, attester);
+        return this.fetchAccount("agentAttestation", pda);
+    }
+    /**
+     * @name fetchNullable
+     * @description Fetch a deserialized `AgentAttestation` account, or `null`
+     *   if it does not exist on-chain.
+     * @param agentPda - The agent account PDA.
+     * @param attester - The attester wallet. Defaults to the connected wallet.
+     * @returns {Promise<AgentAttestationData | null>} The attestation data or `null`.
+     * @since v0.1.0
+     */
+    async fetchNullable(agentPda, attester) {
+        const [pda] = this.deriveAttestation(agentPda, attester);
+        return this.fetchAccountNullable("agentAttestation", pda);
+    }
+}
+exports.AttestationModule = AttestationModule;
+//# sourceMappingURL=attestation.js.map

package/dist/cjs/modules/attestation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attestation.js","sourceRoot":"","sources":["../../../src/modules/attestation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AAEH,6CAA2F;AAC3F,iCAAoC;AACpC,gCAA8E;AAG9E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,iBAAkB,SAAQ,iBAAU;IAC/C,wDAAwD;IAExD;;;;;;;;OAQG;IACH,iBAAiB,CACf,QAAmB,EACnB,QAAoB;QAEpB,OAAO,IAAA,uBAAiB,EAAC,QAAQ,EAAE,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IACpE,CAAC;IAED,wDAAwD;IAExD;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,WAAsB,EACtB,IAA2B;QAE3B,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAA,iBAAW,EAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACrD,MAAM,CAAC,SAAS,CAAC,GAAG,IAAA,0BAAoB,GAAE,CAAC;QAE3C,OAAO,IAAI,CAAC,OAAO;aAChB,iBAAiB,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC;aAC1E,QAAQ,CAAC;YACR,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,SAAS;YACtB,cAAc,EAAE,SAAS;YACzB,aAAa,EAAE,uBAAa,CAAC,SAAS;SACvC,CAAC;aACD,GAAG,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,WAAsB;QACjC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAA,iBAAW,EAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAErD,OAAO,IAAI,CAAC,OAAO;aAChB,iBAAiB,EAAE;aACnB,QAAQ,CAAC;YACR,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,WAAW,EAAE,SAAS;SACvB,CAAC;aACD,GAAG,EAAE,CAAC;IACX,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,WAAsB;QAChC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAA,iBAAW,EAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACrD,MAAM,CAAC,SAAS,CAAC,GAAG,IAAA,0BAAoB,GAAE,CAAC;QAE3C,OAAO,IAAI,CAAC,OAAO;aAChB,gBAAgB,EAAE;aAClB,QAAQ,CAAC;YACR,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,WAAW,EAAE,SAAS;YACtB,cAAc,EAAE,SAAS;SAC1B,CAAC;aACD,GAAG,EAAE,CAAC;IACX,CAAC;IAED,wDAAwD;IAExD;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CACT,QAAmB,EACnB,QAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,YAAY,CAAuB,kBAAkB,EAAE,GAAG,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CACjB,QAAmB,EACnB,QAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,oBAAoB,CAAuB,kBAAkB,EAAE,GAAG,CAAC,CAAC;IAClF,CAAC;CACF;AAhID,8CAgIC"}

package/dist/cjs/modules/base.js

@@ -0,0 +1,189 @@
+"use strict";
+/**
+ * @module base
+ * @description Abstract base class for all SDK modules.
+ *
+ * Provides shared access to the Anchor program, provider,
+ * and typed `fetch` / `fetchNullable` helpers.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseModule = void 0;
+const anchor_1 = require("@coral-xyz/anchor");
+const anchor_errors_1 = require("../utils/anchor-errors");
+/**
+ * @name BaseModule
+ * @description Abstract base module inherited by every domain module in the SDK.
+ * Encapsulates the Anchor program reference, provider access, and common
+ * helpers for account fetching and BN construction.
+ *
+ * @abstract
+ * @category Modules
+ * @since v0.1.0
+ *
+ * @example
+ * ```ts
+ * class MyModule extends BaseModule {
+ *   async doSomething() {
+ *     const data = await this.fetchAccount<MyData>("myAccount", pda);
+ *   }
+ * }
+ * ```
+ */
+class BaseModule {
+    program;
+    /**
+     * Create a new module instance.
+     *
+     * @param program - The Anchor `Program` instance for the SAP IDL.
+     * @protected
+     */
+    constructor(program) {
+        this.program = program;
+    }
+    /**
+     * @name methods
+     * @description Instruction method namespace — bypasses `noUncheckedIndexedAccess`
+     *   on `Program<any>` where every property is `T | undefined`.
+     *   Used internally by subclasses to build and send instructions.
+     * @returns The Anchor program `methods` object for chaining instruction builders.
+     * @protected
+     * @since v0.1.0
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    get methods() {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return this.program.methods;
+    }
+    /**
+     * @name provider
+     * @description The AnchorProvider from the program, giving access to
+     *   the connection and wallet for signing transactions.
+     * @returns {AnchorProvider} The Anchor provider instance.
+     * @protected
+     * @since v0.1.0
+     */
+    get provider() {
+        return this.program.provider;
+    }
+    /**
+     * @name walletPubkey
+     * @description Convenience accessor for the signer wallet's public key.
+     * @returns {PublicKey} The public key of the connected wallet.
+     * @protected
+     * @since v0.1.0
+     */
+    get walletPubkey() {
+        return this.provider.wallet.publicKey;
+    }
+    /**
+     * @name fetchAccount
+     * @description Generic account fetch — deserializes the on-chain account
+     *   data into the given type `T`, or throws if the account does not exist.
+     * @typeParam T - The expected deserialized account data type.
+     * @param accountName - The Anchor account discriminator name (e.g. `"agentAccount"`).
+     * @param address - The public key of the account to fetch.
+     * @returns {Promise<T>} The deserialized account data.
+     * @throws Will throw if the account does not exist on-chain.
+     * @protected
+     * @since v0.1.0
+     */
+    async fetchAccount(accountName, address) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
+        return this.program.account[accountName].fetch(address);
+    }
+    /**
+     * @name fetchAccountNullable
+     * @description Generic nullable account fetch — deserializes the on-chain
+     *   account data into type `T`, or returns `null` if the account does not exist.
+     * @typeParam T - The expected deserialized account data type.
+     * @param accountName - The Anchor account discriminator name (e.g. `"agentAccount"`).
+     * @param address - The public key of the account to fetch.
+     * @returns {Promise<T | null>} The deserialized account data, or `null`.
+     * @protected
+     * @since v0.1.0
+     */
+    async fetchAccountNullable(accountName, address) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
+        return this.program.account[accountName].fetchNullable(address);
+    }
+    /**
+     * @name bn
+     * @description Create an Anchor `BN` from a number, bigint, or existing BN.
+     *   Passes through values that are already `BN` instances.
+     * @param value - The numeric value to convert.
+     * @returns {BN} An Anchor-compatible big number.
+     * @protected
+     * @since v0.1.0
+     */
+    bn(value) {
+        if (anchor_1.BN.isBN(value))
+            return value;
+        return new anchor_1.BN(value.toString());
+    }
+    // ── v0.13.0 preflight helpers ─────────────────────────
+    /**
+     * @name requireAccountExists
+     * @description Fetch a required account; throw a {@link SapPreflightError}
+     *   with an actionable message if it does not exist.
+     * @typeParam T - Expected account type.
+     * @param accountName - Anchor account discriminator name.
+     * @param address - PDA to fetch.
+     * @param onMissing - `{ predicted, hint }` describing the on-chain rejection
+     *   that would otherwise occur.
+     * @protected
+     * @since v0.13.0
+     */
+    async requireAccountExists(accountName, address, onMissing) {
+        const acc = await this.fetchAccountNullable(accountName, address);
+        if (acc == null) {
+            (0, anchor_errors_1.throwPredicted)(onMissing.predicted, onMissing.hint ?? `${accountName} ${address.toBase58()} not found`);
+        }
+        return acc;
+    }
+    /**
+     * @name requireAccountAbsent
+     * @description Verify a PDA does not yet exist on-chain. Used before any
+     *   `init` instruction to catch `account already in use` early.
+     * @protected
+     * @since v0.13.0
+     */
+    async requireAccountAbsent(accountName, address, hint) {
+        const acc = await this.provider.connection.getAccountInfo(address);
+        if (acc !== null) {
+            throw new anchor_errors_1.SapPreflightError(`${accountName} ${address.toBase58()} already exists. ${hint}`, 0, "AccountAlreadyInUse", hint);
+        }
+    }
+    /**
+     * @name simulateOrThrow
+     * @description Run `simulate()` on a method builder. If the simulation
+     *   reports a SAP program error, throw it as a {@link SapPreflightError}
+     *   with the decoded name + friendly hint *before* the user pays fees.
+     *   Returns the simulation logs on success for inspection.
+     * @protected
+     * @since v0.13.0
+     */
+    async simulateOrThrow(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    builder, label) {
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+            const sim = await builder.simulate();
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            const logs = (sim?.raw ?? sim?.logs ?? []);
+            return logs;
+        }
+        catch (err) {
+            const decoded = (0, anchor_errors_1.decodeAnchorError)(err);
+            if (decoded) {
+                throw new anchor_errors_1.SapPreflightError(`[${label}] simulation failed: ${decoded.friendly}`, decoded.code, decoded.name, decoded.logs?.slice(0, 6).join(" | "));
+            }
+            throw err;
+        }
+    }
+}
+exports.BaseModule = BaseModule;
+//# sourceMappingURL=base.js.map

package/dist/cjs/modules/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/modules/base.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAEH,8CAA0E;AAE1E,0DAKgC;AA0BhC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAsB,UAAU;IAOC;IAN/B;;;;;OAKG;IACH,YAA+B,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;IAAG,CAAC;IAEtD;;;;;;;;OAQG;IACH,8DAA8D;IAC9D,IAAc,OAAO;QACnB,+DAA+D;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,IAAc,QAAQ;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,QAA0B,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,IAAc,YAAY;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;OAWG;IACO,KAAK,CAAC,YAAY,CAC1B,WAAmB,EACnB,OAAkB;QAElB,0GAA0G;QAC1G,OAAQ,IAAI,CAAC,OAAO,CAAC,OAAe,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,OAAO,CAAe,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACO,KAAK,CAAC,oBAAoB,CAClC,WAAmB,EACnB,OAAkB;QAElB,0GAA0G;QAC1G,OAAQ,IAAI,CAAC,OAAO,CAAC,OAAe,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,OAAO,CAAsB,CAAC;IAChG,CAAC;IAED;;;;;;;;OAQG;IACO,EAAE,CAAC,KAA2B;QACtC,IAAI,WAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QACjC,OAAO,IAAI,WAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,yDAAyD;IAEzD;;;;;;;;;;;OAWG;IACO,KAAK,CAAC,oBAAoB,CAClC,WAAmB,EACnB,OAAkB,EAClB,SAAuE;QAEvE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAI,WAAW,EAAE,OAAO,CAAC,CAAC;QACrE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YAChB,IAAA,8BAAc,EAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,IAAI,GAAG,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC1G,CAAC;QACD,OAAO,GAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,oBAAoB,CAClC,WAAmB,EACnB,OAAkB,EAClB,IAAY;QAEZ,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACnE,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,iCAAiB,CACzB,GAAG,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,oBAAoB,IAAI,EAAE,EAC9D,CAAC,EACD,qBAAqB,EACrB,IAAI,CACL,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACO,KAAK,CAAC,eAAe;IAC7B,8DAA8D;IAC9D,OAAY,EACZ,KAAa;QAEb,IAAI,CAAC;YACH,yGAAyG;YACzG,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrC,sEAAsE;YACtE,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,EAAE,IAAI,IAAI,EAAE,CAAsB,CAAC;YAChE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,IAAA,iCAAiB,EAAC,GAAG,CAAC,CAAC;YACvC,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,IAAI,iCAAiB,CACzB,IAAI,KAAK,wBAAwB,OAAO,CAAC,QAAQ,EAAE,EACnD,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACtC,CAAC;YACJ,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;CACF;AAtLD,gCAsLC"}