@airgap/icp 0.13.11-beta.1 → 0.13.11-beta.11

package/v1/utils/polling.js

@@ -0,0 +1,325 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pollForResponse = exports.chain = exports.backoff = exports.timeout = exports.throttle = exports.maxAttempts = exports.conditionalDelay = exports.once = exports.defaultStrategy = void 0;
+var auth_1 = require("./auth");
+var buffer_1 = require("./buffer");
+var certificate_1 = require("./certificate");
+var FIVE_MINUTES_IN_MSEC = 5 * 60 * 1000;
+/**
+ * A best practices polling strategy: wait 2 seconds before the first poll, then 1 second
+ * with an exponential backoff factor of 1.2. Timeout after 5 minutes.
+ */
+function defaultStrategy() {
+    return chain(conditionalDelay(once(), 1000), backoff(1000, 1.2), timeout(FIVE_MINUTES_IN_MSEC));
+}
+exports.defaultStrategy = defaultStrategy;
+/**
+ * Predicate that returns true once.
+ */
+function once() {
+    var _this = this;
+    var first = true;
+    return function () { return __awaiter(_this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (first) {
+                first = false;
+                return [2 /*return*/, true];
+            }
+            return [2 /*return*/, false];
+        });
+    }); };
+}
+exports.once = once;
+/**
+ * Delay the polling once.
+ * @param condition A predicate that indicates when to delay.
+ * @param timeInMsec The amount of time to delay.
+ */
+function conditionalDelay(condition, timeInMsec) {
+    var _this = this;
+    return function (canisterId, requestId, status) { return __awaiter(_this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, condition(canisterId, requestId, status)];
+                case 1:
+                    if (_a.sent()) {
+                        return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, timeInMsec); })];
+                    }
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+}
+exports.conditionalDelay = conditionalDelay;
+/**
+ * Error out after a maximum number of polling has been done.
+ * @param count The maximum attempts to poll.
+ */
+function maxAttempts(count) {
+    var _this = this;
+    var attempts = count;
+    return function (canisterId, requestId, status) { return __awaiter(_this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (--attempts <= 0) {
+                throw new Error("Failed to retrieve a reply for request after ".concat(count, " attempts:\n") +
+                    "  Request ID: ".concat((0, buffer_1.toHex)(requestId), "\n") +
+                    "  Request status: ".concat(status, "\n"));
+            }
+            return [2 /*return*/];
+        });
+    }); };
+}
+exports.maxAttempts = maxAttempts;
+/**
+ * Throttle polling.
+ * @param throttleInMsec Amount in millisecond to wait between each polling.
+ */
+function throttle(throttleInMsec) {
+    return function () { return new Promise(function (resolve) { return setTimeout(resolve, throttleInMsec); }); };
+}
+exports.throttle = throttle;
+/**
+ * Reject a call after a certain amount of time.
+ * @param timeInMsec Time in milliseconds before the polling should be rejected.
+ */
+function timeout(timeInMsec) {
+    var _this = this;
+    var end = Date.now() + timeInMsec;
+    return function (canisterId, requestId, status) { return __awaiter(_this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (Date.now() > end) {
+                throw new Error("Request timed out after ".concat(timeInMsec, " msec:\n") + "  Request ID: ".concat((0, buffer_1.toHex)(requestId), "\n") + "  Request status: ".concat(status, "\n"));
+            }
+            return [2 /*return*/];
+        });
+    }); };
+}
+exports.timeout = timeout;
+/**
+ * A strategy that throttle, but using an exponential backoff strategy.
+ * @param startingThrottleInMsec The throttle in milliseconds to start with.
+ * @param backoffFactor The factor to multiple the throttle time between every poll. For
+ *   example if using 2, the throttle will double between every run.
+ */
+function backoff(startingThrottleInMsec, backoffFactor) {
+    var currentThrottling = startingThrottleInMsec;
+    return function () {
+        return new Promise(function (resolve) {
+            return setTimeout(function () {
+                currentThrottling *= backoffFactor;
+                resolve();
+            }, currentThrottling);
+        });
+    };
+}
+exports.backoff = backoff;
+/**
+ * Chain multiple polling strategy. This _chains_ the strategies, so if you pass in,
+ * say, two throttling strategy of 1 second, it will result in a throttle of 2 seconds.
+ * @param strategies A strategy list to chain.
+ */
+function chain() {
+    var _this = this;
+    var strategies = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        strategies[_i] = arguments[_i];
+    }
+    return function (canisterId, requestId, status) { return __awaiter(_this, void 0, void 0, function () {
+        var strategies_1, strategies_1_1, a, e_1_1;
+        var e_1, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _b.trys.push([0, 5, 6, 7]);
+                    strategies_1 = __values(strategies), strategies_1_1 = strategies_1.next();
+                    _b.label = 1;
+                case 1:
+                    if (!!strategies_1_1.done) return [3 /*break*/, 4];
+                    a = strategies_1_1.value;
+                    return [4 /*yield*/, a(canisterId, requestId, status)];
+                case 2:
+                    _b.sent();
+                    _b.label = 3;
+                case 3:
+                    strategies_1_1 = strategies_1.next();
+                    return [3 /*break*/, 1];
+                case 4: return [3 /*break*/, 7];
+                case 5:
+                    e_1_1 = _b.sent();
+                    e_1 = { error: e_1_1 };
+                    return [3 /*break*/, 7];
+                case 6:
+                    try {
+                        if (strategies_1_1 && !strategies_1_1.done && (_a = strategies_1.return)) _a.call(strategies_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                    return [7 /*endfinally*/];
+                case 7: return [2 /*return*/];
+            }
+        });
+    }); };
+}
+exports.chain = chain;
+/**
+ * Polls the IC to check the status of the given request then
+ * returns the response bytes once the request has been processed.
+ * @param agent The agent to use to poll read_state.
+ * @param canisterId The effective canister ID.
+ * @param requestId The Request ID to poll status for.
+ * @param strategy A polling strategy.
+ * @param request Request for the readState call.
+ */
+function pollForResponse(agent, canisterId, requestId, strategy, 
+// eslint-disable-next-line
+request) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function () {
+        var path, currentRequest, _b, state, cert, maybeBuf, status, _c, rejectCode, rejectMessage;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    path = [new TextEncoder().encode('request_status'), requestId];
+                    if (!(request !== null && request !== void 0)) return [3 /*break*/, 1];
+                    _b = request;
+                    return [3 /*break*/, 3];
+                case 1: return [4 /*yield*/, ((_a = agent.createReadStateRequest) === null || _a === void 0 ? void 0 : _a.call(agent, { paths: [path] }))];
+                case 2:
+                    _b = (_d.sent());
+                    _d.label = 3;
+                case 3:
+                    currentRequest = _b;
+                    return [4 /*yield*/, agent.readState(canisterId, { paths: [path] }, undefined, currentRequest)];
+                case 4:
+                    state = _d.sent();
+                    if (agent.rootKey == null)
+                        throw new Error('Agent root key not initialized before polling');
+                    return [4 /*yield*/, certificate_1.Certificate.create({
+                            certificate: state.certificate,
+                            rootKey: agent.rootKey,
+                            canisterId: canisterId
+                        })];
+                case 5:
+                    cert = _d.sent();
+                    maybeBuf = cert.lookup(__spreadArray(__spreadArray([], __read(path), false), [new TextEncoder().encode('status')], false));
+                    if (typeof maybeBuf === 'undefined') {
+                        // Missing requestId means we need to wait
+                        status = auth_1.RequestStatusResponseStatus.Unknown;
+                    }
+                    else {
+                        status = new TextDecoder().decode(maybeBuf);
+                    }
+                    _c = status;
+                    switch (_c) {
+                        case auth_1.RequestStatusResponseStatus.Replied: return [3 /*break*/, 6];
+                        case auth_1.RequestStatusResponseStatus.Received: return [3 /*break*/, 7];
+                        case auth_1.RequestStatusResponseStatus.Unknown: return [3 /*break*/, 7];
+                        case auth_1.RequestStatusResponseStatus.Processing: return [3 /*break*/, 7];
+                        case auth_1.RequestStatusResponseStatus.Rejected: return [3 /*break*/, 9];
+                        case auth_1.RequestStatusResponseStatus.Done: return [3 /*break*/, 10];
+                    }
+                    return [3 /*break*/, 11];
+                case 6:
+                    {
+                        return [2 /*return*/, cert.lookup(__spreadArray(__spreadArray([], __read(path), false), ['reply'], false))];
+                    }
+                    _d.label = 7;
+                case 7: 
+                // Execute the polling strategy, then retry.
+                return [4 /*yield*/, strategy(canisterId, requestId, status)];
+                case 8:
+                    // Execute the polling strategy, then retry.
+                    _d.sent();
+                    return [2 /*return*/, pollForResponse(agent, canisterId, requestId, strategy, currentRequest)];
+                case 9:
+                    {
+                        rejectCode = new Uint8Array(cert.lookup(__spreadArray(__spreadArray([], __read(path), false), ['reject_code'], false)))[0];
+                        rejectMessage = new TextDecoder().decode(cert.lookup(__spreadArray(__spreadArray([], __read(path), false), ['reject_message'], false)));
+                        throw new Error("Call was rejected:\n" +
+                            "  Request ID: ".concat((0, buffer_1.toHex)(requestId), "\n") +
+                            "  Reject code: ".concat(rejectCode, "\n") +
+                            "  Reject text: ".concat(rejectMessage, "\n"));
+                    }
+                    _d.label = 10;
+                case 10: 
+                // This is _technically_ not an error, but we still didn't see the `Replied` status so
+                // we don't know the result and cannot decode it.
+                throw new Error("Call was marked as done but we never saw the reply:\n" + "  Request ID: ".concat((0, buffer_1.toHex)(requestId), "\n"));
+                case 11: throw new Error('unreachable');
+            }
+        });
+    });
+}
+exports.pollForResponse = pollForResponse;
+//# sourceMappingURL=polling.js.map

package/v1/utils/polling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polling.js","sourceRoot":"","sources":["../../../src/v1/utils/polling.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA+D;AAC/D,mCAAgC;AAChC,6CAA2C;AAS3C,IAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAA;AAE1C;;;GAGG;AACH,SAAgB,eAAe;IAC7B,OAAO,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAA;AACjG,CAAC;AAFD,0CAEC;AAED;;GAEG;AACH,SAAgB,IAAI;IAApB,iBASC;IARC,IAAI,KAAK,GAAG,IAAI,CAAA;IAChB,OAAO;;YACL,IAAI,KAAK,EAAE;gBACT,KAAK,GAAG,KAAK,CAAA;gBACb,sBAAO,IAAI,EAAA;aACZ;YACD,sBAAO,KAAK,EAAA;;SACb,CAAA;AACH,CAAC;AATD,oBASC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,SAA6B,EAAE,UAAkB;IAAlF,iBAMC;IALC,OAAO,UAAO,UAAqB,EAAE,SAAoB,EAAE,MAAmC;;;wBACxF,qBAAM,SAAS,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,EAAA;;oBAAlD,IAAI,SAA8C,EAAE;wBAClD,sBAAO,IAAI,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,EAA/B,CAA+B,CAAC,EAAA;qBACjE;;;;SACF,CAAA;AACH,CAAC;AAND,4CAMC;AAED;;;GAGG;AACH,SAAgB,WAAW,CAAC,KAAa;IAAzC,iBAWC;IAVC,IAAI,QAAQ,GAAG,KAAK,CAAA;IACpB,OAAO,UAAO,UAAqB,EAAE,SAAoB,EAAE,MAAmC;;YAC5F,IAAI,EAAE,QAAQ,IAAI,CAAC,EAAE;gBACnB,MAAM,IAAI,KAAK,CACb,uDAAgD,KAAK,iBAAc;oBACjE,wBAAiB,IAAA,cAAK,EAAC,SAAS,CAAC,OAAI;oBACrC,4BAAqB,MAAM,OAAI,CAClC,CAAA;aACF;;;SACF,CAAA;AACH,CAAC;AAXD,kCAWC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAC,cAAsB;IAC7C,OAAO,cAAM,OAAA,IAAI,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,UAAU,CAAC,OAAO,EAAE,cAAc,CAAC,EAAnC,CAAmC,CAAC,EAA7D,CAA6D,CAAA;AAC5E,CAAC;AAFD,4BAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,UAAkB;IAA1C,iBASC;IARC,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAA;IACnC,OAAO,UAAO,UAAqB,EAAE,SAAoB,EAAE,MAAmC;;YAC5F,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE;gBACpB,MAAM,IAAI,KAAK,CACb,kCAA2B,UAAU,aAAU,GAAG,wBAAiB,IAAA,cAAK,EAAC,SAAS,CAAC,OAAI,GAAG,4BAAqB,MAAM,OAAI,CAC1H,CAAA;aACF;;;SACF,CAAA;AACH,CAAC;AATD,0BASC;AAED;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,sBAA8B,EAAE,aAAqB;IAC3E,IAAI,iBAAiB,GAAG,sBAAsB,CAAA;IAE9C,OAAO;QACL,OAAA,IAAI,OAAO,CAAC,UAAC,OAAO;YAClB,OAAA,UAAU,CAAC;gBACT,iBAAiB,IAAI,aAAa,CAAA;gBAClC,OAAO,EAAE,CAAA;YACX,CAAC,EAAE,iBAAiB,CAAC;QAHrB,CAGqB,CACtB;IALD,CAKC,CAAA;AACL,CAAC;AAVD,0BAUC;AAED;;;;GAIG;AACH,SAAgB,KAAK;IAArB,iBAMC;IANqB,oBAA6B;SAA7B,UAA6B,EAA7B,qBAA6B,EAA7B,IAA6B;QAA7B,+BAA6B;;IACjD,OAAO,UAAO,UAAqB,EAAE,SAAoB,EAAE,MAAmC;;;;;;;oBAC5E,eAAA,SAAA,UAAU,CAAA;;;;oBAAf,CAAC;oBACV,qBAAM,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,EAAA;;oBAAtC,SAAsC,CAAA;;;;;;;;;;;;;;;;;;;SAEzC,CAAA;AACH,CAAC;AAND,sBAMC;AAED;;;;;;;;GAQG;AACH,SAAsB,eAAe,CACnC,KAAY,EACZ,UAAqB,EACrB,SAAoB,EACpB,QAAsB;AACtB,2BAA2B;AAC3B,OAAa;;;;;;;oBAEP,IAAI,GAAG,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,SAAS,CAAC,CAAA;0BAC7C,OAAO,aAAP,OAAO;oBAAP,KAAA,OAAO,CAAA;;wBAAK,qBAAM,CAAA,MAAA,KAAK,CAAC,sBAAsB,sDAAG,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,EAAA;;oBAAxD,KAAA,CAAC,SAAuD,CAAC,CAAA;;;oBAArF,cAAc,KAAuE;oBAC7E,qBAAM,KAAK,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,cAAc,CAAC,EAAA;;oBAAvF,KAAK,GAAG,SAA+E;oBAC7F,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI;wBAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;oBAC9E,qBAAM,yBAAW,CAAC,MAAM,CAAC;4BACpC,WAAW,EAAE,KAAK,CAAC,WAAW;4BAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;4BACtB,UAAU,EAAE,UAAU;yBACvB,CAAC,EAAA;;oBAJI,IAAI,GAAG,SAIX;oBACI,QAAQ,GAAG,IAAI,CAAC,MAAM,wCAAK,IAAI,YAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAE,CAAA;oBAE3E,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;wBACnC,0CAA0C;wBAC1C,MAAM,GAAG,kCAA2B,CAAC,OAAO,CAAA;qBAC7C;yBAAM;wBACL,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;qBAC5C;oBAEO,KAAA,MAAM,CAAA;;6BACP,kCAA2B,CAAC,OAAO,CAAC,CAApC,wBAAmC;6BAInC,kCAA2B,CAAC,QAAQ,CAAC,CAArC,wBAAoC;6BACpC,kCAA2B,CAAC,OAAO,CAAC,CAApC,wBAAmC;6BACnC,kCAA2B,CAAC,UAAU,CAAC,CAAvC,wBAAsC;6BAKtC,kCAA2B,CAAC,QAAQ,CAAC,CAArC,wBAAoC;6BAWpC,kCAA2B,CAAC,IAAI,CAAC,CAAjC,yBAAgC;;;;oBAtBK;wBACxC,sBAAO,IAAI,CAAC,MAAM,wCAAK,IAAI,YAAE,OAAO,UAAG,EAAA;qBACxC;;;gBAKC,4CAA4C;gBAC5C,qBAAM,QAAQ,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,EAAA;;oBAD7C,4CAA4C;oBAC5C,SAA6C,CAAA;oBAC7C,sBAAO,eAAe,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,CAAC,EAAA;;oBAErC;wBACnC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,wCAAK,IAAI,YAAE,aAAa,UAAG,CAAC,CAAC,CAAC,CAAC,CAAA;wBACtE,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,wCAAK,IAAI,YAAE,gBAAgB,UAAG,CAAC,CAAA;wBACzF,MAAM,IAAI,KAAK,CACb,sBAAsB;4BACpB,wBAAiB,IAAA,cAAK,EAAC,SAAS,CAAC,OAAI;4BACrC,yBAAkB,UAAU,OAAI;4BAChC,yBAAkB,aAAa,OAAI,CACtC,CAAA;qBACF;;;gBAGC,sFAAsF;gBACtF,iDAAiD;gBACjD,MAAM,IAAI,KAAK,CAAC,uDAAuD,GAAG,wBAAiB,IAAA,cAAK,EAAC,SAAS,CAAC,OAAI,CAAC,CAAA;yBAEpH,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAA;;;;CAC/B;AAvDD,0CAuDC"}

package/v1/utils/principal.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @param input The input array to encode.
+ * @returns A Base32 string encoding the input.
+ */
+export declare function encode(input: Uint8Array): string;
+/**
+ * @param input The base32 encoded string to decode.
+ */
+export declare function decode(input: string): Uint8Array;
+/**
+ * Calculate the CRC32 of an ArrayBufferLike.
+ * @param buf The BufferLike to calculate the CRC32 of.
+ */
+export declare function getCrc32(buf: ArrayBufferLike): number;
+/**
+ * Returns the SHA224 hash of the buffer.
+ * @param data Arraybuffer to encode
+ */
+export declare function sha224(data: ArrayBuffer): Uint8Array;
+export declare class Principal {
+    private _arr;
+    static anonymous(): Principal;
+    /**
+     * Utility method, returning the principal representing the management canister, decoded from the hex string `'aaaaa-aa'`
+     * @returns {Principal} principal of the management canister
+     */
+    static managementCanister(): Principal;
+    static selfAuthenticating(publicKey: Uint8Array): Principal;
+    static from(other: unknown): Principal;
+    static fromHex(hex: string): Principal;
+    static fromText(text: string): Principal;
+    static fromUint8Array(arr: Uint8Array): Principal;
+    readonly _isPrincipal = true;
+    protected constructor(_arr: Uint8Array);
+    isAnonymous(): boolean;
+    toUint8Array(): Uint8Array;
+    toHex(): string;
+    toText(): string;
+    toString(): string;
+    /**
+     * Utility method taking a Principal to compare against. Used for determining canister ranges in certificate verification
+     * @param {Principal} other - a {@link Principal} to compare
+     * @returns {'lt' | 'eq' | 'gt'} `'lt' | 'eq' | 'gt'` a string, representing less than, equal to, or greater than
+     */
+    compareTo(other: Principal): 'lt' | 'eq' | 'gt';
+    /**
+     * Utility method checking whether a provided Principal is less than or equal to the current one using the {@link Principal.compareTo} method
+     * @param other a {@link Principal} to compare
+     * @returns {boolean} boolean
+     */
+    ltEq(other: Principal): boolean;
+    /**
+     * Utility method checking whether a provided Principal is greater than or equal to the current one using the {@link Principal.compareTo} method
+     * @param other a {@link Principal} to compare
+     * @returns {boolean} boolean
+     */
+    gtEq(other: Principal): boolean;
+}