@astrox/agent 0.0.24 → 0.0.30

package/lib/cjs/actor.d.ts

@@ -0,0 +1,126 @@
+import { Agent, QueryResponseRejected, SubmitResponse } from './agent';
+import { AgentError } from './errors';
+import { IDL } from '@astrox/candid';
+import { PollStrategyFactory } from './polling';
+import { Principal } from '@astrox/principal';
+import { RequestId } from './request_id';
+export declare class ActorCallError extends AgentError {
+    readonly canisterId: Principal;
+    readonly methodName: string;
+    readonly type: 'query' | 'update';
+    readonly props: Record<string, string>;
+    constructor(canisterId: Principal, methodName: string, type: 'query' | 'update', props: Record<string, string>);
+}
+export declare class QueryCallRejectedError extends ActorCallError {
+    readonly result: QueryResponseRejected;
+    constructor(canisterId: Principal, methodName: string, result: QueryResponseRejected);
+}
+export declare class UpdateCallRejectedError extends ActorCallError {
+    readonly requestId: RequestId;
+    readonly response: SubmitResponse['response'];
+    constructor(canisterId: Principal, methodName: string, requestId: RequestId, response: SubmitResponse['response']);
+}
+/**
+ * Configuration to make calls to the Replica.
+ */
+export interface CallConfig {
+    /**
+     * An agent to use in this call, otherwise the actor or call will try to discover the
+     * agent to use.
+     */
+    agent?: Agent;
+    /**
+     * A polling strategy factory that dictates how much and often we should poll the
+     * read_state endpoint to get the result of an update call.
+     */
+    pollingStrategyFactory?: PollStrategyFactory;
+    /**
+     * The canister ID of this Actor.
+     */
+    canisterId?: string | Principal;
+    /**
+     * The effective canister ID. This should almost always be ignored.
+     */
+    effectiveCanisterId?: Principal;
+}
+/**
+ * Configuration that can be passed to customize the Actor behaviour.
+ */
+export interface ActorConfig extends CallConfig {
+    /**
+     * The Canister ID of this Actor. This is required for an Actor.
+     */
+    canisterId: string | Principal;
+    /**
+     * An override function for update calls' CallConfig. This will be called on every calls.
+     */
+    callTransform?(methodName: string, args: unknown[], callConfig: CallConfig): Partial<CallConfig> | void;
+    /**
+     * An override function for query calls' CallConfig. This will be called on every query.
+     */
+    queryTransform?(methodName: string, args: unknown[], callConfig: CallConfig): Partial<CallConfig> | void;
+}
+/**
+ * A subclass of an actor. Actor class itself is meant to be a based class.
+ */
+export declare type ActorSubclass<T = Record<string, ActorMethod>> = Actor & T;
+/**
+ * An actor method type, defined for each methods of the actor service.
+ */
+export interface ActorMethod<Args extends unknown[] = unknown[], Ret extends unknown = unknown> {
+    (...args: Args): Promise<Ret>;
+    withOptions(options: CallConfig): (...args: Args) => Promise<Ret>;
+}
+/**
+ * The mode used when installing a canister.
+ */
+export declare enum CanisterInstallMode {
+    Install = "install",
+    Reinstall = "reinstall",
+    Upgrade = "upgrade"
+}
+/**
+ * Internal metadata for actors. It's an enhanced version of ActorConfig with
+ * some fields marked as required (as they are defaulted) and canisterId as
+ * a Principal type.
+ */
+interface ActorMetadata {
+    service: IDL.ServiceClass;
+    agent?: Agent;
+    config: ActorConfig;
+}
+declare const metadataSymbol: unique symbol;
+/**
+ * An actor base class. An actor is an object containing only functions that will
+ * return a promise. These functions are derived from the IDL definition.
+ */
+export declare class Actor {
+    /**
+     * Get the Agent class this Actor would call, or undefined if the Actor would use
+     * the default agent (global.ic.agent).
+     * @param actor The actor to get the agent of.
+     */
+    static agentOf(actor: Actor): Agent | undefined;
+    /**
+     * Get the interface of an actor, in the form of an instance of a Service.
+     * @param actor The actor to get the interface of.
+     */
+    static interfaceOf(actor: Actor): IDL.ServiceClass;
+    static canisterIdOf(actor: Actor): Principal;
+    static install(fields: {
+        module: ArrayBuffer;
+        mode?: CanisterInstallMode;
+        arg?: ArrayBuffer;
+    }, config: ActorConfig): Promise<void>;
+    static createCanister(config?: CallConfig): Promise<Principal>;
+    static createAndInstallCanister(interfaceFactory: IDL.InterfaceFactory, fields: {
+        module: ArrayBuffer;
+        arg?: ArrayBuffer;
+    }, config?: CallConfig): Promise<ActorSubclass>;
+    static createActorClass(interfaceFactory: IDL.InterfaceFactory): ActorConstructor;
+    static createActor<T = Record<string, ActorMethod>>(interfaceFactory: IDL.InterfaceFactory, configuration: ActorConfig): ActorSubclass<T>;
+    private [metadataSymbol];
+    protected constructor(metadata: ActorMetadata);
+}
+export declare type ActorConstructor = new (config: ActorConfig) => ActorSubclass;
+export {};

package/lib/cjs/actor.js

@@ -0,0 +1,207 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Actor = exports.CanisterInstallMode = exports.UpdateCallRejectedError = exports.QueryCallRejectedError = exports.ActorCallError = void 0;
+const buffer_1 = require("buffer/");
+const agent_1 = require("./agent");
+const management_1 = require("./canisters/management");
+const errors_1 = require("./errors");
+const candid_1 = require("@astrox/candid");
+const polling_1 = require("./polling");
+const principal_1 = require("@astrox/principal");
+const buffer_2 = require("./utils/buffer");
+class ActorCallError extends errors_1.AgentError {
+    constructor(canisterId, methodName, type, props) {
+        super([
+            `Call failed:`,
+            `  Canister: ${canisterId.toText()}`,
+            `  Method: ${methodName} (${type})`,
+            ...Object.getOwnPropertyNames(props).map(n => `  "${n}": ${JSON.stringify(props[n])}`),
+        ].join('\n'));
+        this.canisterId = canisterId;
+        this.methodName = methodName;
+        this.type = type;
+        this.props = props;
+    }
+}
+exports.ActorCallError = ActorCallError;
+class QueryCallRejectedError extends ActorCallError {
+    constructor(canisterId, methodName, result) {
+        var _a;
+        super(canisterId, methodName, 'query', {
+            Status: result.status,
+            Code: (_a = agent_1.ReplicaRejectCode[result.reject_code]) !== null && _a !== void 0 ? _a : `Unknown Code "${result.reject_code}"`,
+            Message: result.reject_message,
+        });
+        this.result = result;
+    }
+}
+exports.QueryCallRejectedError = QueryCallRejectedError;
+class UpdateCallRejectedError extends ActorCallError {
+    constructor(canisterId, methodName, requestId, response) {
+        super(canisterId, methodName, 'update', {
+            'Request ID': buffer_2.toHex(requestId),
+            'HTTP status code': response.status.toString(),
+            'HTTP status text': response.statusText,
+        });
+        this.requestId = requestId;
+        this.response = response;
+    }
+}
+exports.UpdateCallRejectedError = UpdateCallRejectedError;
+/**
+ * The mode used when installing a canister.
+ */
+var CanisterInstallMode;
+(function (CanisterInstallMode) {
+    CanisterInstallMode["Install"] = "install";
+    CanisterInstallMode["Reinstall"] = "reinstall";
+    CanisterInstallMode["Upgrade"] = "upgrade";
+})(CanisterInstallMode = exports.CanisterInstallMode || (exports.CanisterInstallMode = {}));
+const metadataSymbol = Symbol.for('ic-agent-metadata');
+/**
+ * An actor base class. An actor is an object containing only functions that will
+ * return a promise. These functions are derived from the IDL definition.
+ */
+class Actor {
+    constructor(metadata) {
+        this[metadataSymbol] = Object.freeze(metadata);
+    }
+    /**
+     * Get the Agent class this Actor would call, or undefined if the Actor would use
+     * the default agent (global.ic.agent).
+     * @param actor The actor to get the agent of.
+     */
+    static agentOf(actor) {
+        return actor[metadataSymbol].config.agent;
+    }
+    /**
+     * Get the interface of an actor, in the form of an instance of a Service.
+     * @param actor The actor to get the interface of.
+     */
+    static interfaceOf(actor) {
+        return actor[metadataSymbol].service;
+    }
+    static canisterIdOf(actor) {
+        return principal_1.Principal.from(actor[metadataSymbol].config.canisterId);
+    }
+    static async install(fields, config) {
+        const mode = fields.mode === undefined ? CanisterInstallMode.Install : fields.mode;
+        // Need to transform the arg into a number array.
+        const arg = fields.arg ? [...new Uint8Array(fields.arg)] : [];
+        // Same for module.
+        const wasmModule = [...new Uint8Array(fields.module)];
+        const canisterId = typeof config.canisterId === 'string'
+            ? principal_1.Principal.fromText(config.canisterId)
+            : config.canisterId;
+        await management_1.getManagementCanister(config).install_code({
+            mode: { [mode]: null },
+            arg,
+            wasm_module: wasmModule,
+            canister_id: canisterId,
+        });
+    }
+    static async createCanister(config) {
+        const { canister_id: canisterId } = await management_1.getManagementCanister(config || {}).provisional_create_canister_with_cycles({ amount: [], settings: [] });
+        return canisterId;
+    }
+    static async createAndInstallCanister(interfaceFactory, fields, config) {
+        const canisterId = await this.createCanister(config);
+        await this.install(Object.assign({}, fields), Object.assign(Object.assign({}, config), { canisterId }));
+        return this.createActor(interfaceFactory, Object.assign(Object.assign({}, config), { canisterId }));
+    }
+    static createActorClass(interfaceFactory) {
+        const service = interfaceFactory({ IDL: candid_1.IDL });
+        class CanisterActor extends Actor {
+            constructor(config) {
+                const canisterId = typeof config.canisterId === 'string'
+                    ? principal_1.Principal.fromText(config.canisterId)
+                    : config.canisterId;
+                super({
+                    config: Object.assign(Object.assign(Object.assign({}, DEFAULT_ACTOR_CONFIG), config), { canisterId }),
+                    service,
+                });
+                for (const [methodName, func] of service._fields) {
+                    this[methodName] = _createActorMethod(this, methodName, func);
+                }
+            }
+        }
+        return CanisterActor;
+    }
+    static createActor(interfaceFactory, configuration) {
+        return new (this.createActorClass(interfaceFactory))(configuration);
+    }
+}
+exports.Actor = Actor;
+// IDL functions can have multiple return values, so decoding always
+// produces an array. Ensure that functions with single or zero return
+// values behave as expected.
+function decodeReturnValue(types, msg) {
+    const returnValues = candid_1.IDL.decode(types, buffer_1.Buffer.from(msg));
+    switch (returnValues.length) {
+        case 0:
+            return undefined;
+        case 1:
+            return returnValues[0];
+        default:
+            return returnValues;
+    }
+}
+const DEFAULT_ACTOR_CONFIG = {
+    pollingStrategyFactory: polling_1.strategy.defaultStrategy,
+};
+function _createActorMethod(actor, methodName, func) {
+    let caller;
+    if (func.annotations.includes('query')) {
+        caller = async (options, ...args) => {
+            var _a, _b;
+            // First, if there's a config transformation, call it.
+            options = Object.assign(Object.assign({}, options), (_b = (_a = actor[metadataSymbol].config).queryTransform) === null || _b === void 0 ? void 0 : _b.call(_a, methodName, args, Object.assign(Object.assign({}, actor[metadataSymbol].config), options)));
+            const agent = options.agent || actor[metadataSymbol].config.agent || agent_1.getDefaultAgent();
+            const cid = principal_1.Principal.from(options.canisterId || actor[metadataSymbol].config.canisterId);
+            const arg = candid_1.IDL.encode(func.argTypes, args);
+            const result = await agent.query(cid, { methodName, arg });
+            switch (result.status) {
+                case "rejected" /* Rejected */:
+                    throw new QueryCallRejectedError(cid, methodName, result);
+                case "replied" /* Replied */:
+                    return decodeReturnValue(func.retTypes, result.reply.arg);
+            }
+        };
+    }
+    else {
+        caller = async (options, ...args) => {
+            var _a, _b;
+            // First, if there's a config transformation, call it.
+            options = Object.assign(Object.assign({}, options), (_b = (_a = actor[metadataSymbol].config).callTransform) === null || _b === void 0 ? void 0 : _b.call(_a, methodName, args, Object.assign(Object.assign({}, actor[metadataSymbol].config), options)));
+            const agent = options.agent || actor[metadataSymbol].config.agent || agent_1.getDefaultAgent();
+            const { canisterId, effectiveCanisterId, pollingStrategyFactory } = Object.assign(Object.assign(Object.assign({}, DEFAULT_ACTOR_CONFIG), actor[metadataSymbol].config), options);
+            const cid = principal_1.Principal.from(canisterId);
+            const ecid = effectiveCanisterId !== undefined ? principal_1.Principal.from(effectiveCanisterId) : cid;
+            const arg = candid_1.IDL.encode(func.argTypes, args);
+            const { requestId, response } = await agent.call(cid, {
+                methodName,
+                arg,
+                effectiveCanisterId: ecid,
+            });
+            if (!response.ok) {
+                throw new UpdateCallRejectedError(cid, methodName, requestId, response);
+            }
+            const pollStrategy = pollingStrategyFactory();
+            const responseBytes = await polling_1.pollForResponse(agent, ecid, requestId, pollStrategy);
+            if (responseBytes !== undefined) {
+                return decodeReturnValue(func.retTypes, responseBytes);
+            }
+            else if (func.retTypes.length === 0) {
+                return undefined;
+            }
+            else {
+                throw new Error(`Call was returned undefined, but type [${func.retTypes.join(',')}].`);
+            }
+        };
+    }
+    const handler = (...args) => caller({}, ...args);
+    handler.withOptions =
+        (options) => (...args) => caller(options, ...args);
+    return handler;
+}
+//# sourceMappingURL=actor.js.map

package/lib/cjs/actor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actor.js","sourceRoot":"","sources":["../../src/actor.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,mCAOiB;AACjB,uDAA+D;AAC/D,qCAAsC;AACtC,2CAAqC;AACrC,uCAA2E;AAC3E,iDAA8C;AAE9C,2CAAuC;AAEvC,MAAa,cAAe,SAAQ,mBAAU;IAC5C,YACkB,UAAqB,EACrB,UAAkB,EAClB,IAAwB,EACxB,KAA6B;QAE7C,KAAK,CACH;YACE,cAAc;YACd,eAAe,UAAU,CAAC,MAAM,EAAE,EAAE;YACpC,aAAa,UAAU,KAAK,IAAI,GAAG;YACnC,GAAG,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACvF,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAZc,eAAU,GAAV,UAAU,CAAW;QACrB,eAAU,GAAV,UAAU,CAAQ;QAClB,SAAI,GAAJ,IAAI,CAAoB;QACxB,UAAK,GAAL,KAAK,CAAwB;IAU/C,CAAC;CACF;AAhBD,wCAgBC;AAED,MAAa,sBAAuB,SAAQ,cAAc;IACxD,YACE,UAAqB,EACrB,UAAkB,EACF,MAA6B;;QAE7C,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE;YACrC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,IAAI,QAAE,yBAAiB,CAAC,MAAM,CAAC,WAAW,CAAC,mCAAI,iBAAiB,MAAM,CAAC,WAAW,GAAG;YACrF,OAAO,EAAE,MAAM,CAAC,cAAc;SAC/B,CAAC,CAAC;QANa,WAAM,GAAN,MAAM,CAAuB;IAO/C,CAAC;CACF;AAZD,wDAYC;AAED,MAAa,uBAAwB,SAAQ,cAAc;IACzD,YACE,UAAqB,EACrB,UAAkB,EACF,SAAoB,EACpB,QAAoC;QAEpD,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE;YACtC,YAAY,EAAE,cAAK,CAAC,SAAS,CAAC;YAC9B,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;YAC9C,kBAAkB,EAAE,QAAQ,CAAC,UAAU;SACxC,CAAC,CAAC;QAPa,cAAS,GAAT,SAAS,CAAW;QACpB,aAAQ,GAAR,QAAQ,CAA4B;IAOtD,CAAC;CACF;AAbD,0DAaC;AAuED;;GAEG;AACH,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8CAAuB,CAAA;IACvB,0CAAmB,CAAA;AACrB,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAaD,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAa,KAAK;IAoHhB,YAAsB,QAAuB;QAC3C,IAAI,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IArHD;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,KAAY;QAChC,OAAO,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,KAAY;QACpC,OAAO,KAAK,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,KAAY;QACrC,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACjE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CACzB,MAIC,EACD,MAAmB;QAEnB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QACnF,iDAAiD;QACjD,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,mBAAmB;QACnB,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,MAAM,UAAU,GACd,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ;YACnC,CAAC,CAAC,qBAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC;YACvC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;QAExB,MAAM,kCAAqB,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC;YAC/C,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAS;YAC7B,GAAG;YACH,WAAW,EAAE,UAAU;YACvB,WAAW,EAAE,UAAU;SACxB,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,MAAmB;QACpD,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,MAAM,kCAAqB,CAC7D,MAAM,IAAI,EAAE,CACb,CAAC,uCAAuC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QAExE,OAAO,UAAU,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,gBAAsC,EACtC,MAGC,EACD,MAAmB;QAEnB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,OAAO,mBAEX,MAAM,mCAEN,MAAM,KAAE,UAAU,IACxB,CAAC;QAEF,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,kCAAO,MAAM,KAAE,UAAU,IAAG,CAAC;IACvE,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAAC,gBAAsC;QACnE,MAAM,OAAO,GAAG,gBAAgB,CAAC,EAAE,GAAG,EAAH,YAAG,EAAE,CAAC,CAAC;QAE1C,MAAM,aAAc,SAAQ,KAAK;YAG/B,YAAY,MAAmB;gBAC7B,MAAM,UAAU,GACd,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ;oBACnC,CAAC,CAAC,qBAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC;oBACvC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;gBAExB,KAAK,CAAC;oBACJ,MAAM,gDACD,oBAAoB,GACpB,MAAM,KACT,UAAU,GACX;oBACD,OAAO;iBACR,CAAC,CAAC;gBAEH,KAAK,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE;oBAChD,IAAI,CAAC,UAAU,CAAC,GAAG,kBAAkB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;iBAC/D;YACH,CAAC;SACF;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,WAAW,CACvB,gBAAsC,EACtC,aAA0B;QAE1B,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,CAClD,aAAa,CACiB,CAAC;IACnC,CAAC;CAOF;AAvHD,sBAuHC;AAED,oEAAoE;AACpE,sEAAsE;AACtE,6BAA6B;AAC7B,SAAS,iBAAiB,CAAC,KAAiB,EAAE,GAAgB;IAC5D,MAAM,YAAY,GAAG,YAAG,CAAC,MAAM,CAAC,KAAK,EAAE,eAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACzD,QAAQ,YAAY,CAAC,MAAM,EAAE;QAC3B,KAAK,CAAC;YACJ,OAAO,SAAS,CAAC;QACnB,KAAK,CAAC;YACJ,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC;QACzB;YACE,OAAO,YAAY,CAAC;KACvB;AACH,CAAC;AAED,MAAM,oBAAoB,GAAG;IAC3B,sBAAsB,EAAE,kBAAQ,CAAC,eAAe;CACjD,CAAC;AAIF,SAAS,kBAAkB,CAAC,KAAY,EAAE,UAAkB,EAAE,IAAmB;IAC/E,IAAI,MAAqE,CAAC;IAC1E,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACtC,MAAM,GAAG,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE;;YAClC,sDAAsD;YACtD,OAAO,mCACF,OAAO,SACP,MAAA,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,EAAC,cAAc,mDAAG,UAAU,EAAE,IAAI,kCAC5D,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,GAC5B,OAAO,GAEb,CAAC;YAEF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,uBAAe,EAAE,CAAC;YACvF,MAAM,GAAG,GAAG,qBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC1F,MAAM,GAAG,GAAG,YAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAE5C,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;YAE3D,QAAQ,MAAM,CAAC,MAAM,EAAE;gBACrB;oBACE,MAAM,IAAI,sBAAsB,CAAC,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;gBAE5D;oBACE,OAAO,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aAC7D;QACH,CAAC,CAAC;KACH;SAAM;QACL,MAAM,GAAG,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE;;YAClC,sDAAsD;YACtD,OAAO,mCACF,OAAO,SACP,MAAA,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,EAAC,aAAa,mDAAG,UAAU,EAAE,IAAI,kCAC3D,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,GAC5B,OAAO,GAEb,CAAC;YAEF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,uBAAe,EAAE,CAAC;YACvF,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,iDAC5D,oBAAoB,GACpB,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,GAC5B,OAAO,CACX,CAAC;YACF,MAAM,GAAG,GAAG,qBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,mBAAmB,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YAC3F,MAAM,GAAG,GAAG,YAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC5C,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;gBACpD,UAAU;gBACV,GAAG;gBACH,mBAAmB,EAAE,IAAI;aAC1B,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;gBAChB,MAAM,IAAI,uBAAuB,CAAC,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;aACzE;YAED,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;YAC9C,MAAM,aAAa,GAAG,MAAM,yBAAe,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;YAElF,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,OAAO,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;aACxD;iBAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACrC,OAAO,SAAS,CAAC;aAClB;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;aACxF;QACH,CAAC,CAAC;KACH;IAED,MAAM,OAAO,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5D,OAAO,CAAC,WAAW;QACjB,CAAC,OAAmB,EAAE,EAAE,CACxB,CAAC,GAAG,IAAe,EAAE,EAAE,CACrB,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7B,OAAO,OAAsB,CAAC;AAChC,CAAC"}

package/lib/cjs/agent/api.d.ts

@@ -0,0 +1,140 @@
+import { Principal } from '@astrox/principal';
+import { RequestId } from '../request_id';
+import { JsonObject } from '@astrox/candid';
+/**
+ * Codes used by the replica for rejecting a message.
+ * See {@link https://sdk.dfinity.org/docs/interface-spec/#reject-codes | the interface spec}.
+ */
+export declare enum ReplicaRejectCode {
+    SysFatal = 1,
+    SysTransient = 2,
+    DestinationInvalid = 3,
+    CanisterReject = 4,
+    CanisterError = 5
+}
+/**
+ * Options when doing a {@link Agent.readState} call.
+ */
+export interface ReadStateOptions {
+    /**
+     * A list of paths to read the state of.
+     */
+    paths: ArrayBuffer[][];
+}
+/**
+ *
+ */
+export declare type QueryResponse = QueryResponseReplied | QueryResponseRejected;
+export declare const enum QueryResponseStatus {
+    Replied = "replied",
+    Rejected = "rejected"
+}
+export interface QueryResponseBase {
+    status: QueryResponseStatus;
+}
+export interface QueryResponseReplied extends QueryResponseBase {
+    status: QueryResponseStatus.Replied;
+    reply: {
+        arg: ArrayBuffer;
+    };
+}
+export interface QueryResponseRejected extends QueryResponseBase {
+    status: QueryResponseStatus.Rejected;
+    reject_code: ReplicaRejectCode;
+    reject_message: string;
+}
+/**
+ * Options when doing a {@link Agent.query} call.
+ */
+export interface QueryFields {
+    /**
+     * The method name to call.
+     */
+    methodName: string;
+    /**
+     * A binary encoded argument. This is already encoded and will be sent as is.
+     */
+    arg: ArrayBuffer;
+}
+/**
+ * Options when doing a {@link Agent.call} call.
+ */
+export interface CallOptions {
+    /**
+     * The method name to call.
+     */
+    methodName: string;
+    /**
+     * A binary encoded argument. This is already encoded and will be sent as is.
+     */
+    arg: ArrayBuffer;
+    /**
+     * An effective canister ID, used for routing. This should only be mentioned if
+     * it's different from the canister ID.
+     */
+    effectiveCanisterId: Principal | string;
+}
+export interface ReadStateResponse {
+    certificate: ArrayBuffer;
+}
+export interface SubmitResponse {
+    requestId: RequestId;
+    response: {
+        ok: boolean;
+        status: number;
+        statusText: string;
+    };
+}
+/**
+ * An Agent able to make calls and queries to a Replica.
+ */
+export interface Agent {
+    readonly rootKey: ArrayBuffer | null;
+    /**
+     * Returns the principal ID associated with this agent (by default). It only shows
+     * the principal of the default identity in the agent, which is the principal used
+     * when calls don't specify it.
+     */
+    getPrincipal(): Promise<Principal>;
+    /**
+     * Send a read state query to the replica. This includes a list of paths to return,
+     * and will return a Certificate. This will only reject on communication errors,
+     * but the certificate might contain less information than requested.
+     * @param effectiveCanisterId A Canister ID related to this call.
+     * @param options The options for this call.
+     */
+    readState(effectiveCanisterId: Principal | string, options: ReadStateOptions): Promise<ReadStateResponse>;
+    call(canisterId: Principal | string, fields: CallOptions): Promise<SubmitResponse>;
+    /**
+     * Query the status endpoint of the replica. This normally has a few fields that
+     * corresponds to the version of the replica, its root public key, and any other
+     * information made public.
+     * @returns A JsonObject that is essentially a record of fields from the status
+     *     endpoint.
+     */
+    status(): Promise<JsonObject>;
+    /**
+     * Send a query call to a canister. See
+     * {@link https://sdk.dfinity.org/docs/interface-spec/#http-query | the interface spec}.
+     * @param canisterId The Principal of the Canister to send the query to. Sending a query to
+     *     the management canister is not supported (as it has no meaning from an agent).
+     * @param options Options to use to create and send the query.
+     * @returns The response from the replica. The Promise will only reject when the communication
+     *     failed. If the query itself failed but no protocol errors happened, the response will
+     *     be of type QueryResponseRejected.
+     */
+    query(canisterId: Principal | string, options: QueryFields): Promise<QueryResponse>;
+    /**
+     * By default, the agent is configured to talk to the main Internet Computer,
+     * and verifies responses using a hard-coded public key.
+     *
+     * This function will instruct the agent to ask the endpoint for its public
+     * key, and use that instead. This is required when talking to a local test
+     * instance, for example.
+     *
+     * Only use this when you are  _not_ talking to the main Internet Computer,
+     * otherwise you are prone to man-in-the-middle attacks! Do not call this
+     * function by default.
+     */
+    fetchRootKey(): Promise<ArrayBuffer>;
+}

package/lib/cjs/agent/api.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplicaRejectCode = void 0;
+/**
+ * Codes used by the replica for rejecting a message.
+ * See {@link https://sdk.dfinity.org/docs/interface-spec/#reject-codes | the interface spec}.
+ */
+var ReplicaRejectCode;
+(function (ReplicaRejectCode) {
+    ReplicaRejectCode[ReplicaRejectCode["SysFatal"] = 1] = "SysFatal";
+    ReplicaRejectCode[ReplicaRejectCode["SysTransient"] = 2] = "SysTransient";
+    ReplicaRejectCode[ReplicaRejectCode["DestinationInvalid"] = 3] = "DestinationInvalid";
+    ReplicaRejectCode[ReplicaRejectCode["CanisterReject"] = 4] = "CanisterReject";
+    ReplicaRejectCode[ReplicaRejectCode["CanisterError"] = 5] = "CanisterError";
+})(ReplicaRejectCode = exports.ReplicaRejectCode || (exports.ReplicaRejectCode = {}));
+//# sourceMappingURL=api.js.map

package/lib/cjs/agent/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/agent/api.ts"],"names":[],"mappings":";;;AAIA;;;GAGG;AACH,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,iEAAY,CAAA;IACZ,yEAAgB,CAAA;IAChB,qFAAsB,CAAA;IACtB,6EAAkB,CAAA;IAClB,2EAAiB,CAAA;AACnB,CAAC,EANW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAM5B"}

package/lib/cjs/agent/http/index.d.ts

@@ -0,0 +1,49 @@
+import { JsonObject } from '@astrox/candid';
+import { Principal } from '@astrox/principal';
+import { Identity } from '../../auth';
+import { Agent, QueryFields, QueryResponse, ReadStateOptions, ReadStateResponse, SubmitResponse } from '../api';
+import { HttpAgentRequest, HttpAgentRequestTransformFn } from './types';
+export * from './transforms';
+export { Nonce, makeNonce } from './types';
+export declare enum RequestStatusResponseStatus {
+    Received = "received",
+    Processing = "processing",
+    Replied = "replied",
+    Rejected = "rejected",
+    Unknown = "unknown",
+    Done = "done"
+}
+export interface HttpAgentOptions {
+    source?: HttpAgent;
+    fetch?: typeof fetch;
+    fetchAgent?: typeof fetch;
+    host?: string;
+    identity?: Identity | Promise<Identity>;
+    credentials?: {
+        name: string;
+        password?: string;
+    };
+}
+export declare class HttpAgent implements Agent {
+    rootKey: ArrayBuffer;
+    private readonly _pipeline;
+    private readonly _identity;
+    private readonly _fetch;
+    private readonly _fetchAgent;
+    private readonly _host;
+    private readonly _credentials;
+    private _rootKeyFetched;
+    constructor(options?: HttpAgentOptions);
+    addTransform(fn: HttpAgentRequestTransformFn, priority?: number): void;
+    getPrincipal(): Promise<Principal>;
+    call(canisterId: Principal | string, options: {
+        methodName: string;
+        arg: ArrayBuffer;
+        effectiveCanisterId?: Principal | string;
+    }, identity?: Identity | Promise<Identity>): Promise<SubmitResponse>;
+    query(canisterId: Principal | string, fields: QueryFields, identity?: Identity | Promise<Identity>): Promise<QueryResponse>;
+    readState(canisterId: Principal | string, fields: ReadStateOptions, identity?: Identity | Promise<Identity>): Promise<ReadStateResponse>;
+    status(): Promise<JsonObject>;
+    fetchRootKey(): Promise<ArrayBuffer>;
+    protected _transform(request: HttpAgentRequest): Promise<HttpAgentRequest>;
+}