UNPKG

@coral-xyz/anchor

Version:
156 lines • 5.79 kB
import { inflate } from "pako"; import { BorshCoder } from "../coder/index.js"; import { convertIdlToCamelCase, decodeIdlAccount, idlAddress, } from "../idl.js"; import { getProvider } from "../provider.js"; import { utf8 } from "../utils/bytes/index.js"; import { translateAddress } from "./common.js"; import { EventManager } from "./event.js"; import NamespaceFactory 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 class Program { /** * Address of the program. */ get programId() { return this._programId; } /** * IDL in camelCase format to work in TypeScript. * * See {@link rawIdl} field if you need the original IDL. */ get idl() { return this._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() { return this._rawIdl; } /** * Coder for serializing requests. */ get coder() { return this._coder; } /** * Wallet and network provider. */ get provider() { return this._provider; } /** * @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, provider = getProvider(), coder, getCustomResolver) { // Fields. this._idl = convertIdlToCamelCase(idl); this._rawIdl = idl; this._provider = provider; this._programId = translateAddress(idl.address); this._coder = coder !== null && coder !== void 0 ? coder : new BorshCoder(this._idl); this._events = new EventManager(this._programId, provider, this._coder); // Dynamic namespaces. const [rpc, instruction, transaction, account, simulate, methods, views] = NamespaceFactory.build(this._idl, this._coder, this._programId, provider, getCustomResolver); this.rpc = rpc; this.instruction = instruction; this.transaction = transaction; this.account = account; this.simulate = simulate; this.methods = methods; this.views = views; } /** * 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 async at(address, provider) { const programId = translateAddress(address); const idl = await Program.fetchIdl(programId, provider); if (!idl) { throw new Error(`IDL not found for program: ${address.toString()}`); } return new Program(idl, provider); } /** * 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 async fetchIdl(address, provider) { provider = provider !== null && provider !== void 0 ? provider : getProvider(); const programId = translateAddress(address); const idlAddr = await idlAddress(programId); const accountInfo = await provider.connection.getAccountInfo(idlAddr); if (!accountInfo) { return null; } // Chop off account discriminator. let idlAccount = decodeIdlAccount(accountInfo.data.slice(8)); const inflatedIdl = inflate(idlAccount.data); return JSON.parse(utf8.decode(inflatedIdl)); } /** * 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(eventName, callback, commitment) { return this._events.addEventListener(eventName, callback, commitment); } /** * Unsubscribes from the given eventName. */ async removeEventListener(listener) { return await this._events.removeEventListener(listener); } } //# sourceMappingURL=index.js.map