@trixter-osec/core 0.40.4

package/dist/cjs/program/event.d.ts

@@ -0,0 +1,59 @@
+import { Commitment, PublicKey } from "@solana/web3.js";
+import { Coder } from "../coder/index.js";
+import { IdlEvent, IdlField } from "../idl.js";
+import Provider from "../provider.js";
+import { DecodeType } from "./namespace/types.js";
+export type Event<E extends IdlEvent = IdlEvent, Defined = Record<string, never>> = {
+    name: E["name"];
+    data: any;
+};
+export type EventData<T extends IdlField, Defined> = {
+    [N in T["name"]]: DecodeType<(T & {
+        name: N;
+    })["type"], Defined>;
+};
+export declare class EventManager {
+    /**
+     * Program ID for event subscriptions.
+     */
+    private _programId;
+    /**
+     * Network and wallet provider.
+     */
+    private _provider;
+    /**
+     * Event parser to handle onLogs callbacks.
+     */
+    private _eventParser;
+    /**
+     * Maps event listener id to [event-name, callback].
+     */
+    private _eventCallbacks;
+    /**
+     * Maps event name to all listeners for the event.
+     */
+    private _eventListeners;
+    /**
+     * The next listener id to allocate.
+     */
+    private _listenerIdCount;
+    /**
+     * The subscription id from the connection onLogs subscription.
+     */
+    private _onLogsSubscriptionId;
+    constructor(programId: PublicKey, provider: Provider, coder: Coder);
+    addEventListener(eventName: string, callback: (event: any, slot: number, signature: string) => void, commitment?: Commitment): number;
+    removeEventListener(listener: number): Promise<void>;
+}
+export declare class EventParser {
+    private coder;
+    private programId;
+    private static readonly INVOKE_RE;
+    private static readonly ROOT_DEPTH;
+    constructor(programId: PublicKey, coder: Coder);
+    parseLogs(logs: string[], errorOnDecodeFailure?: boolean): Generator<Event>;
+    private handleLog;
+    private handleProgramLog;
+    private handleSystemLog;
+}
+//# sourceMappingURL=event.d.ts.map

package/dist/cjs/program/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../../src/program/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAQlD,MAAM,MAAM,KAAK,CACf,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAC7B,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAC7B;IACF,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IAGhB,IAAI,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,QAAQ,EAAE,OAAO,IAAI;KAClD,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CACjE,CAAC;AAIF,qBAAa,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,UAAU,CAAY;IAE9B;;OAEG;IACH,OAAO,CAAC,SAAS,CAAW;IAE5B;;OAEG;IACH,OAAO,CAAC,YAAY,CAAc;IAElC;;OAEG;IACH,OAAO,CAAC,eAAe,CAAuC;IAE9D;;OAEG;IACH,OAAO,CAAC,eAAe,CAA6B;IAEpD;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;OAEG;IACH,OAAO,CAAC,qBAAqB,CAAqB;gBAEtC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK;IAS3D,gBAAgB,CACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,EAC/D,UAAU,CAAC,EAAE,UAAU,GACtB,MAAM;IAiDI,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAsClE;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CACsB;IACvD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAO;gBAE7B,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK;IAgBtC,SAAS,CACf,IAAI,EAAE,MAAM,EAAE,EACd,oBAAoB,UAAQ,GAC3B,SAAS,CAAC,KAAK,CAAC;IAyCnB,OAAO,CAAC,SAAS;IAmBjB,OAAO,CAAC,gBAAgB;IAuBxB,OAAO,CAAC,eAAe;CAcxB"}

package/dist/cjs/program/event.js

@@ -0,0 +1,227 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventParser = exports.EventManager = void 0;
+const PROGRAM_LOG = "Program log: ";
+const PROGRAM_DATA = "Program data: ";
+const PROGRAM_LOG_START_INDEX = PROGRAM_LOG.length;
+const PROGRAM_DATA_START_INDEX = PROGRAM_DATA.length;
+class EventManager {
+    constructor(programId, provider, coder) {
+        this._programId = programId;
+        this._provider = provider;
+        this._eventParser = new EventParser(programId, coder);
+        this._eventCallbacks = new Map();
+        this._eventListeners = new Map();
+        this._listenerIdCount = 0;
+    }
+    addEventListener(eventName, callback, commitment) {
+        var _a;
+        let listener = this._listenerIdCount;
+        this._listenerIdCount += 1;
+        // Store the listener into the event map.
+        if (!this._eventListeners.has(eventName)) {
+            this._eventListeners.set(eventName, []);
+        }
+        this._eventListeners.set(eventName, ((_a = this._eventListeners.get(eventName)) !== null && _a !== void 0 ? _a : []).concat(listener));
+        // Store the callback into the listener map.
+        this._eventCallbacks.set(listener, [eventName, callback]);
+        // Create the subscription singleton, if needed.
+        if (this._onLogsSubscriptionId !== undefined) {
+            return listener;
+        }
+        this._onLogsSubscriptionId = this._provider.connection.onLogs(this._programId, (logs, ctx) => {
+            if (logs.err) {
+                return;
+            }
+            for (const event of this._eventParser.parseLogs(logs.logs)) {
+                const allListeners = this._eventListeners.get(event.name);
+                if (allListeners) {
+                    allListeners.forEach((listener) => {
+                        const listenerCb = this._eventCallbacks.get(listener);
+                        if (listenerCb) {
+                            const [, callback] = listenerCb;
+                            callback(event.data, ctx.slot, logs.signature);
+                        }
+                    });
+                }
+            }
+        }, commitment);
+        return listener;
+    }
+    async removeEventListener(listener) {
+        // Get the callback.
+        const callback = this._eventCallbacks.get(listener);
+        if (!callback) {
+            throw new Error(`Event listener ${listener} doesn't exist!`);
+        }
+        const [eventName] = callback;
+        // Get the listeners.
+        let listeners = this._eventListeners.get(eventName);
+        if (!listeners) {
+            throw new Error(`Event listeners don't exist for ${eventName}!`);
+        }
+        // Update both maps.
+        this._eventCallbacks.delete(listener);
+        listeners = listeners.filter((l) => l !== listener);
+        this._eventListeners.set(eventName, listeners);
+        if (listeners.length === 0) {
+            this._eventListeners.delete(eventName);
+        }
+        // Kill the websocket connection if all listeners have been removed.
+        if (this._eventCallbacks.size === 0) {
+            if (this._eventListeners.size !== 0) {
+                throw new Error(`Expected event listeners size to be 0 but got ${this._eventListeners.size}`);
+            }
+            if (this._onLogsSubscriptionId !== undefined) {
+                await this._provider.connection.removeOnLogsListener(this._onLogsSubscriptionId);
+                this._onLogsSubscriptionId = undefined;
+            }
+        }
+    }
+}
+exports.EventManager = EventManager;
+class EventParser {
+    constructor(programId, coder) {
+        this.coder = coder;
+        this.programId = programId;
+    }
+    // Each log given, represents an array of messages emitted by
+    // a single transaction, which can execute many different programs across
+    // CPI boundaries. However, the subscription is only interested in the
+    // events emitted by *this* program. In achieving this, we keep track of the
+    // program execution context by parsing each log and looking for a CPI
+    // `invoke` call. If one exists, we know a new program is executing. So we
+    // push the programId onto a stack and switch the program context. This
+    // allows us to track, for a given log, which program was executing during
+    // its emission, thereby allowing us to know if a given log event was
+    // emitted by *this* program. If it was, then we parse the raw string and
+    // emit the event if the string matches the event being subscribed to.
+    *parseLogs(logs, errorOnDecodeFailure = false) {
+        const scanner = new LogScanner([...logs]);
+        const execution = new ExecutionContext();
+        const firstLog = scanner.next();
+        if (firstLog === null)
+            return;
+        const firstCap = EventParser.INVOKE_RE.exec(firstLog);
+        if (!firstCap || firstCap[2] !== EventParser.ROOT_DEPTH) {
+            throw new Error(`Unexpected first log line: ${firstLog}`);
+        }
+        execution.push(firstCap[1]);
+        while (scanner.peek() !== null) {
+            const log = scanner.next();
+            if (log === null)
+                break;
+            let [event, newProgram, didPop] = this.handleLog(execution, log, errorOnDecodeFailure);
+            if (event)
+                yield event;
+            if (newProgram)
+                execution.push(newProgram);
+            if (didPop) {
+                execution.pop();
+                const nextLog = scanner.peek();
+                if (nextLog && nextLog.endsWith("invoke [1]")) {
+                    const m = EventParser.INVOKE_RE.exec(nextLog);
+                    if (m)
+                        execution.push(m[1]);
+                }
+            }
+        }
+    }
+    // Main log handler. Returns a three element array of the event, the
+    // next program that was invoked for CPI, and a boolean indicating if
+    // a program has completed execution (and thus should be popped off the
+    // execution stack).
+    handleLog(execution, log, errorOnDecodeFailure) {
+        // Executing program is this program.
+        if (execution.stack.length > 0 &&
+            execution.program() === this.programId.toString()) {
+            return this.handleProgramLog(log, errorOnDecodeFailure);
+        }
+        // Executing program is not this program.
+        else {
+            return [null, ...this.handleSystemLog(log)];
+        }
+    }
+    // Handles logs from *this* program.
+    handleProgramLog(log, errorOnDecodeFailure) {
+        // This is a `msg!` log or a `sol_log_data` log.
+        if (log.startsWith(PROGRAM_LOG) || log.startsWith(PROGRAM_DATA)) {
+            const logStr = log.startsWith(PROGRAM_LOG)
+                ? log.slice(PROGRAM_LOG_START_INDEX)
+                : log.slice(PROGRAM_DATA_START_INDEX);
+            const event = this.coder.events.decode(logStr);
+            if (errorOnDecodeFailure && event === null) {
+                throw new Error(`Unable to decode event ${logStr}`);
+            }
+            return [event, null, false];
+        }
+        // System log.
+        else {
+            return [null, ...this.handleSystemLog(log)];
+        }
+    }
+    // Handles logs when the current program being executing is *not* this.
+    handleSystemLog(log) {
+        if (log.startsWith(`Program ${this.programId.toString()} log:`)) {
+            return [this.programId.toString(), false];
+        }
+        else if (log.includes("invoke") && !log.endsWith("[1]")) {
+            return ["cpi", false];
+        }
+        else {
+            let regex = /^Program ([1-9A-HJ-NP-Za-km-z]+) success$/;
+            if (regex.test(log)) {
+                return [null, true];
+            }
+            else {
+                return [null, false];
+            }
+        }
+    }
+}
+exports.EventParser = EventParser;
+EventParser.INVOKE_RE = /^Program ([1-9A-HJ-NP-Za-km-z]+) invoke \[(\d+)\]$/;
+EventParser.ROOT_DEPTH = "1";
+// Stack frame execution context, allowing one to track what program is
+// executing for a given log.
+class ExecutionContext {
+    constructor() {
+        this.stack = [];
+    }
+    program() {
+        if (!this.stack.length) {
+            throw new Error("Expected the stack to have elements");
+        }
+        return this.stack[this.stack.length - 1];
+    }
+    push(newProgram) {
+        this.stack.push(newProgram);
+    }
+    pop() {
+        if (!this.stack.length) {
+            throw new Error("Expected the stack to have elements");
+        }
+        this.stack.pop();
+    }
+}
+class LogScanner {
+    constructor(logs) {
+        this.logs = logs;
+        // remove any logs that don't start with "Program "
+        // this can happen in loader logs.
+        // e.g. 3psYALQ9s7SjdezXw2kxKkVuQLtSAQxPAjETvy765EVxJE7cYqfc4oGbpNYEWsAiuXuTnqcsSUHLQ3iZUenTHTsA on devnet
+        this.logs = this.logs.filter((log) => log.startsWith("Program "));
+    }
+    next() {
+        if (this.logs.length === 0) {
+            return null;
+        }
+        let l = this.logs[0];
+        this.logs = this.logs.slice(1);
+        return l;
+    }
+    peek() {
+        return this.logs.length > 0 ? this.logs[0] : null;
+    }
+}
+//# sourceMappingURL=event.js.map

package/dist/cjs/program/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../../src/program/event.ts"],"names":[],"mappings":";;;AAMA,MAAM,WAAW,GAAG,eAAe,CAAC;AACpC,MAAM,YAAY,GAAG,gBAAgB,CAAC;AACtC,MAAM,uBAAuB,GAAG,WAAW,CAAC,MAAM,CAAC;AACnD,MAAM,wBAAwB,GAAG,YAAY,CAAC,MAAM,CAAC;AAmBrD,MAAa,YAAY;IAoCvB,YAAY,SAAoB,EAAE,QAAkB,EAAE,KAAY;QAChE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACtD,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC;QACjC,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;IAC5B,CAAC;IAEM,gBAAgB,CACrB,SAAiB,EACjB,QAA+D,EAC/D,UAAuB;;QAEvB,IAAI,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACrC,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;QAE3B,yCAAyC;QACzC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,GAAG,CACtB,SAAS,EACT,CAAC,MAAA,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAC7D,CAAC;QAEF,4CAA4C;QAC5C,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;QAE1D,gDAAgD;QAChD,IAAI,IAAI,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;YAC7C,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,SAAU,CAAC,UAAU,CAAC,MAAM,CAC5D,IAAI,CAAC,UAAU,EACf,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACZ,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;gBACb,OAAO;YACT,CAAC;YAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3D,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAE1D,IAAI,YAAY,EAAE,CAAC;oBACjB,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;wBAChC,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;wBAEtD,IAAI,UAAU,EAAE,CAAC;4BACf,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,UAAU,CAAC;4BAChC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;wBACjD,CAAC;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC,EACD,UAAU,CACX,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,QAAgB;QAC/C,oBAAoB;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,QAAQ,iBAAiB,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC;QAE7B,qBAAqB;QACrB,IAAI,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,GAAG,CAAC,CAAC;QACnE,CAAC;QAED,oBAAoB;QACpB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC/C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACzC,CAAC;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACpC,MAAM,IAAI,KAAK,CACb,iDAAiD,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAC7E,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;gBAC7C,MAAM,IAAI,CAAC,SAAU,CAAC,UAAU,CAAC,oBAAoB,CACnD,IAAI,CAAC,qBAAqB,CAC3B,CAAC;gBACF,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;YACzC,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAxID,oCAwIC;AAED,MAAa,WAAW;IAOtB,YAAY,SAAoB,EAAE,KAAY;QAC5C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,6DAA6D;IAC7D,yEAAyE;IACzE,sEAAsE;IACtE,4EAA4E;IAC5E,sEAAsE;IACtE,0EAA0E;IAC1E,uEAAuE;IACvE,0EAA0E;IAC1E,qEAAqE;IACrE,yEAAyE;IACzE,sEAAsE;IAC/D,CAAC,SAAS,CACf,IAAc,EACd,oBAAoB,GAAG,KAAK;QAE5B,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAEzC,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,QAAQ,KAAK,IAAI;YAAE,OAAO;QAE9B,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,UAAU,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5B,OAAO,OAAO,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;YAC3B,IAAI,GAAG,KAAK,IAAI;gBAAE,MAAM;YAExB,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAC9C,SAAS,EACT,GAAG,EACH,oBAAoB,CACrB,CAAC;YAEF,IAAI,KAAK;gBAAE,MAAM,KAAK,CAAC;YACvB,IAAI,UAAU;gBAAE,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAE3C,IAAI,MAAM,EAAE,CAAC;gBACX,SAAS,CAAC,GAAG,EAAE,CAAC;gBAChB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;gBAC/B,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;oBAC9C,MAAM,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC9C,IAAI,CAAC;wBAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,oEAAoE;IACpE,qEAAqE;IACrE,uEAAuE;IACvE,oBAAoB;IACZ,SAAS,CACf,SAA2B,EAC3B,GAAW,EACX,oBAA6B;QAE7B,qCAAqC;QACrC,IACE,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;YAC1B,SAAS,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EACjD,CAAC;YACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;QAC1D,CAAC;QACD,yCAAyC;aACpC,CAAC;YACJ,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,oCAAoC;IAC5B,gBAAgB,CACtB,GAAW,EACX,oBAA6B;QAE7B,gDAAgD;QAChD,IAAI,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAChE,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC;gBACxC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC;gBACpC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;YACxC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAE/C,IAAI,oBAAoB,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;QACD,cAAc;aACT,CAAC;YACJ,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,uEAAuE;IAC/D,eAAe,CAAC,GAAW;QACjC,IAAI,GAAG,CAAC,UAAU,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;YAChE,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1D,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,IAAI,KAAK,GAAG,2CAA2C,CAAC;YACxD,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpB,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;;AA1HH,kCA2HC;AAxHyB,qBAAS,GAC/B,oDAAoD,CAAC;AAC/B,sBAAU,GAAG,GAAG,CAAC;AAwH3C,uEAAuE;AACvE,6BAA6B;AAC7B,MAAM,gBAAgB;IAAtB;QACE,UAAK,GAAa,EAAE,CAAC;IAmBvB,CAAC;IAjBC,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,CAAC,UAAkB;QACrB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;IAED,GAAG;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IACnB,CAAC;CACF;AAED,MAAM,UAAU;IACd,YAAmB,IAAc;QAAd,SAAI,GAAJ,IAAI,CAAU;QAC/B,mDAAmD;QACnD,kCAAkC;QAClC,0GAA0G;QAC1G,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACpD,CAAC;CACF"}

package/dist/cjs/program/index.d.ts

@@ -0,0 +1,272 @@
+import { Commitment, PublicKey } from "@solana/web3.js";
+import { Coder } from "../coder/index.js";
+import { Idl, IdlInstruction } from "../idl.js";
+import Provider from "../provider.js";
+import { CustomAccountResolver } from "./accounts-resolver.js";
+import { Address } from "./common.js";
+import { AccountNamespace, IdlEvents, InstructionNamespace, MethodsNamespace, RpcNamespace, SimulateNamespace, TransactionNamespace, ViewNamespace } from "./namespace/index.js";
+export * from "./common.js";
+export * from "./context.js";
+export * from "./event.js";
+export * from "./namespace/index.js";
+/**
+ * ## Program
+ *
+ * Program provides the IDL deserialized client representation of an Anchor
+ * program.
+ *
+ * This API is the one stop shop for all things related to communicating with
+ * on-chain programs. Among other things, one can send transactions, fetch
+ * deserialized accounts, decode instruction data, subscribe to account
+ * changes, and listen to events.
+ *
+ * In addition to field accessors and methods, the object provides a set of
+ * dynamically generated properties, also known as namespaces, that
+ * map one-to-one to program methods and accounts. These namespaces generally
+ *  can be used as follows:
+ *
+ * ## Usage
+ *
+ * ```javascript
+ * program.<namespace>.<program-specific-method>
+ * ```
+ *
+ * API specifics are namespace dependent. The examples used in the documentation
+ * below will refer to the two counter examples found
+ * [here](https://github.com/coral-xyz/anchor#examples).
+ */
+export declare class Program<IDL extends Idl = Idl> {
+    /**
+     * Async methods to send signed transactions to *non*-state methods on the
+     * program, returning a [[TransactionSignature]].
+     *
+     * ## Usage
+     *
+     * ```javascript
+     * rpc.<method>(...args, ctx);
+     * ```
+     *
+     * ## Parameters
+     *
+     * 1. `args` - The positional arguments for the program. The type and number
+     *    of these arguments depend on the program being used.
+     * 2. `ctx`  - [[Context]] non-argument parameters to pass to the method.
+     *    Always the last parameter in the method call.
+     *
+     * ## Example
+     *
+     * To send a transaction invoking the `increment` method above,
+     *
+     * ```javascript
+     * const txSignature = await program.rpc.increment({
+     *   accounts: {
+     *     counter,
+     *     authority,
+     *   },
+     * });
+     * ```
+     * @deprecated
+     * Use program.methods.<method>(...args).rpc() instead
+     */
+    readonly rpc: RpcNamespace<IDL>;
+    /**
+     * The namespace provides handles to an [[AccountClient]] object for each
+     * account in the program.
+     *
+     * ## Usage
+     *
+     * ```javascript
+     * program.account.<account-client>
+     * ```
+     *
+     * ## Example
+     *
+     * To fetch a `Counter` account from the above example,
+     *
+     * ```javascript
+     * const counter = await program.account.counter.fetch(address);
+     * ```
+     *
+     * For the full API, see the [[AccountClient]] reference.
+     */
+    readonly account: AccountNamespace<IDL>;
+    /**
+     * The namespace provides functions to build [[TransactionInstruction]]
+     * objects for each method of a program.
+     *
+     * ## Usage
+     *
+     * ```javascript
+     * program.instruction.<method>(...args, ctx);
+     * ```
+     *
+     * ## Parameters
+     *
+     * 1. `args` - The positional arguments for the program. The type and number
+     *    of these arguments depend on the program being used.
+     * 2. `ctx`  - [[Context]] non-argument parameters to pass to the method.
+     *    Always the last parameter in the method call.
+     *
+     * ## Example
+     *
+     * To create an instruction for the `increment` method above,
+     *
+     * ```javascript
+     * const tx = await program.instruction.increment({
+     *   accounts: {
+     *     counter,
+     *   },
+     * });
+     * ```
+     * @deprecated
+     */
+    readonly instruction: InstructionNamespace<IDL>;
+    /**
+     * The namespace provides functions to build [[Transaction]] objects for each
+     * method of a program.
+     *
+     * ## Usage
+     *
+     * ```javascript
+     * program.transaction.<method>(...args, ctx);
+     * ```
+     *
+     * ## Parameters
+     *
+     * 1. `args` - The positional arguments for the program. The type and number
+     *    of these arguments depend on the program being used.
+     * 2. `ctx`  - [[Context]] non-argument parameters to pass to the method.
+     *    Always the last parameter in the method call.
+     *
+     * ## Example
+     *
+     * To create an instruction for the `increment` method above,
+     *
+     * ```javascript
+     * const tx = await program.transaction.increment({
+     *   accounts: {
+     *     counter,
+     *   },
+     * });
+     * ```
+     * @deprecated
+     */
+    readonly transaction: TransactionNamespace<IDL>;
+    /**
+     * The namespace provides functions to simulate transactions for each method
+     * of a program, returning a list of deserialized events *and* raw program
+     * logs.
+     *
+     * One can use this to read data calculated from a program on chain, by
+     * emitting an event in the program and reading the emitted event client side
+     * via the `simulate` namespace.
+     *
+     * ## simulate
+     *
+     * ```javascript
+     * program.simulate.<method>(...args, ctx);
+     * ```
+     *
+     * ## Parameters
+     *
+     * 1. `args` - The positional arguments for the program. The type and number
+     *    of these arguments depend on the program being used.
+     * 2. `ctx`  - [[Context]] non-argument parameters to pass to the method.
+     *    Always the last parameter in the method call.
+     *
+     * ## Example
+     *
+     * To simulate the `increment` method above,
+     *
+     * ```javascript
+     * const events = await program.simulate.increment({
+     *   accounts: {
+     *     counter,
+     *   },
+     * });
+     * ```
+     * @deprecated
+     */
+    readonly simulate: SimulateNamespace<IDL>;
+    /**
+     * The namespace provides a builder API for all APIs on the program.
+     * This is an alternative to using namespace the other namespaces..
+     */
+    readonly methods: MethodsNamespace<IDL>;
+    readonly views?: ViewNamespace<IDL>;
+    /**
+     * Address of the program.
+     */
+    get programId(): PublicKey;
+    private _programId;
+    /**
+     * IDL in camelCase format to work in TypeScript.
+     *
+     * See {@link rawIdl} field if you need the original IDL.
+     */
+    get idl(): IDL;
+    private _idl;
+    /**
+     * Raw IDL i.e. the original IDL without camelCase conversion.
+     *
+     * See {@link idl} field if you need the camelCased version of the IDL.
+     */
+    get rawIdl(): Idl;
+    private _rawIdl;
+    /**
+     * Coder for serializing requests.
+     */
+    get coder(): Coder;
+    private _coder;
+    /**
+     * Wallet and network provider.
+     */
+    get provider(): Provider;
+    private _provider;
+    /**
+     * Handles event subscriptions.
+     */
+    private _events;
+    /**
+     * @param idl       The interface definition.
+     * @param provider  The network and wallet context to use. If not provided
+     *                  then uses [[getProvider]].
+     * @param getCustomResolver A function that returns a custom account resolver
+     *                          for the given instruction. This is useful for resolving
+     *                          public keys of missing accounts when building instructions
+     */
+    constructor(idl: any, provider?: Provider, coder?: Coder, getCustomResolver?: (instruction: IdlInstruction) => CustomAccountResolver<IDL> | undefined);
+    /**
+     * Generates a Program client by fetching the IDL from the network.
+     *
+     * In order to use this method, an IDL must have been previously initialized
+     * via the anchor CLI's `anchor idl init` command.
+     *
+     * @param programId The on-chain address of the program.
+     * @param provider  The network and wallet context.
+     */
+    static at<IDL extends Idl = Idl>(address: Address, provider?: Provider): Promise<Program<IDL>>;
+    /**
+     * Fetches an idl from the blockchain.
+     *
+     * In order to use this method, an IDL must have been previously initialized
+     * via the anchor CLI's `anchor idl init` command.
+     *
+     * @param programId The on-chain address of the program.
+     * @param provider  The network and wallet context.
+     */
+    static fetchIdl<IDL extends Idl = Idl>(address: Address, provider?: Provider): Promise<IDL | null>;
+    /**
+     * Invokes the given callback every time the given event is emitted.
+     *
+     * @param eventName The PascalCase name of the event, provided by the IDL.
+     * @param callback  The function to invoke whenever the event is emitted from
+     *                  program logs.
+     */
+    addEventListener<E extends keyof IdlEvents<IDL>>(eventName: E & string, callback: (event: IdlEvents<IDL>[E], slot: number, signature: string) => void, commitment?: Commitment): number;
+    /**
+     * Unsubscribes from the given eventName.
+     */
+    removeEventListener(listener: number): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/program/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/program/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAc,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EACL,GAAG,EACH,cAAc,EAIf,MAAM,WAAW,CAAC;AACnB,OAAO,QAAyB,MAAM,gBAAgB,CAAC;AAEvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAoB,MAAM,aAAa,CAAC;AAExD,OAAyB,EACvB,gBAAgB,EAChB,SAAS,EACT,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAE9B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,OAAO,CAAC,GAAG,SAAS,GAAG,GAAG,GAAG;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC;IAEhC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CAAC,WAAW,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CAAC,WAAW,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAE1C;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAExC,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAW,SAAS,IAAI,SAAS,CAEhC;IACD,OAAO,CAAC,UAAU,CAAY;IAE9B;;;;OAIG;IACH,IAAW,GAAG,IAAI,GAAG,CAEpB;IACD,OAAO,CAAC,IAAI,CAAM;IAElB;;;;OAIG;IACH,IAAW,MAAM,IAAI,GAAG,CAEvB;IACD,OAAO,CAAC,OAAO,CAAM;IAErB;;OAEG;IACH,IAAW,KAAK,IAAI,KAAK,CAExB;IACD,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;IACH,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IACD,OAAO,CAAC,SAAS,CAAW;IAE5B;;OAEG;IACH,OAAO,CAAC,OAAO,CAAe;IAE9B;;;;;;;OAOG;gBAED,GAAG,EAAE,GAAG,EACR,QAAQ,GAAE,QAAwB,EAClC,KAAK,CAAC,EAAE,KAAK,EACb,iBAAiB,CAAC,EAAE,CAClB,WAAW,EAAE,cAAc,KACxB,qBAAqB,CAAC,GAAG,CAAC,GAAG,SAAS;IA4B7C;;;;;;;;OAQG;WACiB,EAAE,CAAC,GAAG,SAAS,GAAG,GAAG,GAAG,EAC1C,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,QAAQ,GAClB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAWxB;;;;;;;;OAQG;WACiB,QAAQ,CAAC,GAAG,SAAS,GAAG,GAAG,GAAG,EAChD,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,QAAQ,GAClB,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAetB;;;;;;OAMG;IACI,gBAAgB,CAAC,CAAC,SAAS,MAAM,SAAS,CAAC,GAAG,CAAC,EACpD,SAAS,EAAE,CAAC,GAAG,MAAM,EACrB,QAAQ,EAAE,CACR,KAAK,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,KACd,IAAI,EACT,UAAU,CAAC,EAAE,UAAU,GACtB,MAAM;IAIT;;OAEG;IACU,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGlE"}