@cartridge/controller 0.1.0

package/dist/index.js

@@ -0,0 +1,696 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var cuid = require('cuid');
+var starknet = require('starknet');
+var qs = require('query-string');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var cuid__default = /*#__PURE__*/_interopDefaultLegacy(cuid);
+var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise */
+
+var extendStatics = function(d, b) {
+    extendStatics = Object.setPrototypeOf ||
+        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+        function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+    return extendStatics(d, b);
+};
+
+function __extends(d, b) {
+    if (typeof b !== "function" && b !== null)
+        throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+    extendStatics(d, b);
+    function __() { this.constructor = d; }
+    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+}
+
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+
+function __awaiter(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());
+    });
+}
+
+function __generator(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 Signer = /** @class */ (function () {
+    function Signer(messenger, options) {
+        this.url = "https://cartridge.gg";
+        this.messenger = messenger;
+        if (options === null || options === void 0 ? void 0 : options.url) {
+            this.url = options.url;
+        }
+    }
+    /**
+   * Method to get the public key of the signer
+   *
+   * @returns public key of signer as hex string with 0x prefix
+   */
+    Signer.prototype.getPubKey = function () {
+        return Promise.resolve("");
+    };
+    /**
+     * Sign an JSON object for off-chain usage with the starknet private key and return the signature
+     * This adds a message prefix so it cant be interchanged with transactions
+     *
+     * @param typedData - JSON object to be signed
+     * @param accountAddress - account
+     * @returns the signature of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    Signer.prototype.signMessage = function (typedData, account) {
+        return __awaiter(this, void 0, void 0, function () {
+            var id, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        id = cuid__default["default"]();
+                        window.open("".concat(this.url, "/sign?").concat(qs__default["default"].stringify({
+                            id: id,
+                            origin: window.origin,
+                            message: JSON.stringify(typedData.message),
+                        })), "_blank", "height=650,width=400");
+                        return [4 /*yield*/, this.messenger.send({
+                                method: "sign-message",
+                                params: {
+                                    id: id,
+                                    account: account,
+                                    typedData: typedData,
+                                },
+                            })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    /**
+     * Signs a transaction with the starknet private key and returns the signature
+     *
+     * @param invocation the invocation object containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     * @param abi (optional) the abi of the contract for better displaying
+     *
+     * @returns signature
+     */
+    Signer.prototype.signTransaction = function (transactions, transactionsDetail, abis) {
+        return __awaiter(this, void 0, void 0, function () {
+            var id, calls, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        id = cuid__default["default"]();
+                        calls = Array.isArray(transactions) ? transactions : [transactions];
+                        window.open("".concat(this.url, "/sign?").concat(qs__default["default"].stringify({
+                            id: id,
+                            origin: window.origin,
+                            calls: JSON.stringify(calls),
+                        })), "_blank", "height=650,width=400");
+                        return [4 /*yield*/, this.messenger.send({
+                                method: "sign-transaction",
+                                params: {
+                                    id: id,
+                                    transactions: transactions,
+                                    abis: abis,
+                                    transactionsDetail: transactionsDetail,
+                                },
+                            })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    return Signer;
+}());
+
+var Account = /** @class */ (function (_super) {
+    __extends(Account, _super);
+    function Account(address, scopes, messenger, options) {
+        if (scopes === void 0) { scopes = []; }
+        var _this = _super.call(this) || this;
+        _this.url = "https://cartridge.gg";
+        _this._scopes = [];
+        _this.address = address;
+        _this.messenger = messenger;
+        _this._scopes = scopes;
+        _this.signer = new Signer(messenger, options);
+        if (options === null || options === void 0 ? void 0 : options.url) {
+            _this.url = options.url;
+        }
+        return _this;
+    }
+    /**
+     * Deploys a given compiled contract (json) to starknet
+     *
+     * @param payload payload to be deployed containing:
+     * - compiled contract code
+     * - constructor calldata
+     * - address salt
+     * @param abi the abi of the contract
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    Account.prototype.deployContract = function (payload, abi) {
+        return __awaiter(this, void 0, void 0, function () {
+            var id, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        id = cuid__default["default"]();
+                        window.open("".concat(this.url, "/deploy?origin=").concat(encodeURIComponent(window.origin), "&id=").concat(id), "_blank", "height=650,width=400");
+                        return [4 /*yield*/, this.messenger.send({
+                                method: "deploy-contract",
+                                params: {
+                                    id: id,
+                                    payload: payload,
+                                    abi: abi,
+                                },
+                            })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    /**
+     * Estimate Fee for a method on starknet
+     *
+     * @param invocation the invocation object containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     *
+     * @returns response from addTransaction
+     */
+    Account.prototype.estimateFee = function (invocation) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.messenger.send({
+                            method: "estimate-fee",
+                            params: {
+                                invocation: invocation,
+                            },
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    /**
+     * Invoke execute function in account contract
+     *
+     * @param transactions the invocation object or an array of them, containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     * @param abi (optional) the abi of the contract for better displaying
+     *
+     * @returns response from addTransaction
+     */
+    Account.prototype.execute = function (transactions, abis, transactionsDetail) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, id, calls;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.messenger.send({
+                            method: "execute",
+                            params: {
+                                transactions: transactions,
+                                abis: abis,
+                                transactionsDetail: transactionsDetail,
+                            },
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.result) {
+                            return [2 /*return*/, response.result];
+                        }
+                        if (response.error && response.error !== "missing scopes") {
+                            throw new Error(response.error);
+                        }
+                        id = cuid__default["default"]();
+                        calls = Array.isArray(transactions) ? transactions : [transactions];
+                        window.open("".concat(this.url, "/execute?").concat(qs__default["default"].stringify({
+                            id: id,
+                            origin: window.origin,
+                            calls: JSON.stringify(calls),
+                        })), "_blank", "height=650,width=400");
+                        return [4 /*yield*/, this.messenger.send({
+                                method: "execute",
+                                params: {
+                                    id: id,
+                                    transactions: transactions,
+                                    abis: abis,
+                                    transactionsDetail: transactionsDetail,
+                                },
+                            })];
+                    case 2:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    /**
+     * Sign an JSON object for off-chain usage with the starknet private key and return the signature
+     * This adds a message prefix so it cant be interchanged with transactions
+     *
+     * @param json - JSON object to be signed
+     * @returns the signature of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    Account.prototype.signMessage = function (typedData) {
+        return __awaiter(this, void 0, void 0, function () {
+            var id, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        id = cuid__default["default"]();
+                        window.open("".concat(this.url, "/sign?").concat(qs__default["default"].stringify({
+                            id: id,
+                            origin: window.origin,
+                            typedData: JSON.stringify(typedData),
+                        })), "_blank", "height=650,width=400");
+                        return [4 /*yield*/, this.messenger.send({
+                                method: "sign-message",
+                                params: {
+                                    id: id,
+                                    typedData: typedData,
+                                },
+                            })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    /**
+     * Hash a JSON object with pederson hash and return the hash
+     * This adds a message prefix so it cant be interchanged with transactions
+     *
+     * @param json - JSON object to be hashed
+     * @returns the hash of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    Account.prototype.hashMessage = function (typedData) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.messenger.send({
+                            method: "hash-message",
+                            params: {
+                                typedData: typedData,
+                            },
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    /**
+     * Verify a signature of a JSON object
+     *
+     * @param json - JSON object to be verified
+     * @param signature - signature of the JSON object
+     * @returns true if the signature is valid, false otherwise
+     * @throws {Error} if the JSON object is not a valid JSON or the signature is not a valid signature
+     */
+    Account.prototype.verifyMessage = function (typedData, signature) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.messenger.send({
+                            method: "verify-message",
+                            params: {
+                                typedData: typedData,
+                                signature: signature,
+                            },
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    /**
+     * Verify a signature of a given hash
+     * @warning This method is not recommended, use verifyMessage instead
+     *
+     * @param hash - hash to be verified
+     * @param signature - signature of the hash
+     * @returns true if the signature is valid, false otherwise
+     * @throws {Error} if the signature is not a valid signature
+     */
+    Account.prototype.verifyMessageHash = function (hash, signature) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.messenger.send({
+                            method: "verify-message-hash",
+                            params: {
+                                hash: hash,
+                                signature: signature,
+                            },
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    Account.prototype.getNonce = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.messenger.send({
+                            method: "get-nonce",
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.error) {
+                            throw new Error(response.error);
+                        }
+                        return [2 /*return*/, response.result];
+                }
+            });
+        });
+    };
+    return Account;
+}(starknet.Provider));
+
+var Messenger = /** @class */ (function () {
+    function Messenger(target, origin) {
+        if (origin === void 0) { origin = "https://cartridge.gg"; }
+        var _this = this;
+        this.pending = [];
+        this.defaultHandler = function (e) {
+            if (e.data.target === "cartridge" &&
+                e.data.type === "request") {
+                _this.pending.push(e);
+            }
+        };
+        this.target = target;
+        this.origin = origin;
+        if (typeof document !== "undefined" &&
+            document.body.getAttribute("cartridge") !== "true") {
+            document.body.setAttribute("cartridge", "true");
+        }
+        window.addEventListener("message", this.defaultHandler);
+    }
+    Messenger.prototype.onRequest = function (cb) {
+        window.removeEventListener("message", this.defaultHandler);
+        var onResponse = function (_a) {
+            var origin = _a.origin, source = _a.source, id = _a.data.id;
+            return function (response) {
+                source.postMessage({
+                    id: id,
+                    target: "cartridge",
+                    type: "response",
+                    payload: __assign({ origin: window.origin }, response),
+                }, { targetOrigin: origin });
+            };
+        };
+        for (var i = 0; i < this.pending.length; i++) {
+            var payload = this.pending[i].data.payload;
+            cb(payload, onResponse(this.pending[i]));
+        }
+        window.addEventListener("message", function (e) {
+            var _a = e.data, type = _a.type, target = _a.target, payload = _a.payload;
+            if (target === "cartridge" &&
+                type === "request") {
+                cb(payload, onResponse(e));
+            }
+        });
+    };
+    Messenger.prototype.send = function (request) {
+        var id = cuid__default["default"]();
+        if (!this.target) {
+            throw new Error("read only");
+        }
+        this.target.postMessage({
+            id: id,
+            target: "cartridge",
+            type: "request",
+            payload: __assign({ origin: window.origin }, request),
+        }, this.origin);
+        return new Promise(function (resolve, reject) {
+            var handler = function (_a) {
+                var data = _a.data;
+                if (data.target === "cartridge" &&
+                    data.type === "response" &&
+                    id === data.id) {
+                    resolve(data.payload);
+                    window.removeEventListener("message", handler);
+                }
+            };
+            window.addEventListener("message", handler);
+        });
+    };
+    return Messenger;
+}());
+
+var Cartridge = /** @class */ (function () {
+    function Cartridge(scopes, options) {
+        var _this = this;
+        this.selector = "cartridge-messenger";
+        this.scopes = [];
+        this.url = "https://cartridge.gg";
+        this.origin = "https://cartridge.gg";
+        this.loading = true;
+        if (scopes) {
+            this.scopes = scopes;
+        }
+        if (options === null || options === void 0 ? void 0 : options.url) {
+            this.url = options.url;
+        }
+        if (options === null || options === void 0 ? void 0 : options.origin) {
+            this.origin = options.origin;
+        }
+        if (typeof document !== "undefined") {
+            this.ready_ = new Promise(function (resolve, reject) {
+                window.addEventListener("message", function (e) { return __awaiter(_this, void 0, void 0, function () {
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                if (!(e.data.target === "cartridge" &&
+                                    e.data.payload.method === "ready")) return [3 /*break*/, 2];
+                                return [4 /*yield*/, this.probe()];
+                            case 1:
+                                _a.sent();
+                                this.loading = false;
+                                resolve(true);
+                                _a.label = 2;
+                            case 2: return [2 /*return*/];
+                        }
+                    });
+                }); });
+            });
+        }
+        if (typeof document !== "undefined" && !this.messenger) {
+            var iframe = document.getElementById(this.selector);
+            if (!!iframe) {
+                if (!this.messenger) {
+                    this.messenger = new Messenger(iframe.contentWindow, this.origin);
+                }
+            }
+            else {
+                iframe = document.createElement("iframe");
+                iframe.id = this.selector;
+                iframe.src = "".concat(this.url, "/iframe");
+                iframe.style.opacity = "0";
+                iframe.style.height = "0";
+                iframe.style.width = "0";
+                iframe.sandbox.add("allow-scripts");
+                iframe.sandbox.add("allow-same-origin");
+                if (!!document.hasStorageAccess) {
+                    iframe.sandbox.add("allow-storage-access-by-user-activation");
+                }
+                document.body.appendChild(iframe);
+                this.messenger = new Messenger(iframe.contentWindow, this.origin);
+            }
+        }
+    }
+    Cartridge.prototype.ready = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                if (!this.loading)
+                    return [2 /*return*/, Promise.resolve(true)];
+                return [2 /*return*/, this.ready_];
+            });
+        });
+    };
+    Cartridge.prototype.probe = function () {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var prob;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.messenger.send({
+                            method: "probe",
+                        })];
+                    case 1:
+                        prob = _b.sent();
+                        if ((_a = prob.result) === null || _a === void 0 ? void 0 : _a.address) {
+                            this.account = new Account(prob.result.address, prob.result.scopes, this.messenger, {
+                                url: this.url,
+                            });
+                            return [2 /*return*/, this.account];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Cartridge.prototype.connect = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var id, ok, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        id = cuid__default["default"]();
+                        if (this.account) {
+                            return [2 /*return*/, this.account];
+                        }
+                        if (!!!document.hasStorageAccess) return [3 /*break*/, 3];
+                        return [4 /*yield*/, document.hasStorageAccess()];
+                    case 1:
+                        ok = _a.sent();
+                        if (!!ok) return [3 /*break*/, 3];
+                        return [4 /*yield*/, document.requestStorageAccess()];
+                    case 2:
+                        _a.sent();
+                        _a.label = 3;
+                    case 3:
+                        window.open("".concat(this.url, "/connect?").concat(qs__default["default"].stringify({
+                            id: id,
+                            origin: window.origin,
+                            scopes: JSON.stringify(this.scopes),
+                        })), "_blank", "height=650,width=400");
+                        return [4 /*yield*/, this.messenger.send({
+                                method: "connect",
+                                params: {
+                                    id: id,
+                                    scopes: this.scopes,
+                                },
+                            })];
+                    case 4:
+                        response = _a.sent();
+                        this.account = new Account(response.result.address, response.result.scopes, this.messenger, {
+                            url: this.url,
+                        });
+                        return [2 /*return*/, this.account];
+                }
+            });
+        });
+    };
+    return Cartridge;
+}());
+
+exports.Cartridge = Cartridge;
+exports.Messenger = Messenger;