@cartridge/controller 0.1.0

package/dist/messenger.d.ts

@@ -0,0 +1,17 @@
+import { Request, Response } from "./types";
+export declare type Message<T = Request | Response> = {
+    id?: string;
+    type: "request" | "response";
+    target: string;
+    payload: T;
+};
+export declare class Messenger {
+    private target;
+    private origin;
+    private pending;
+    private defaultHandler;
+    constructor(target?: Window, origin?: string);
+    onRequest(cb: (request: Request, reply: <T = Response>(response: T) => void) => void): void;
+    send<T = Response>(request: Request): Promise<T>;
+}
+//# sourceMappingURL=messenger.d.ts.map

package/dist/messenger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messenger.d.ts","sourceRoot":"","sources":["../src/messenger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAG5C,oBAAY,OAAO,CAAC,CAAC,GAAG,OAAO,GAAG,QAAQ,IAAI;IAC5C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,SAAS,GAAG,UAAU,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAuC;IAEtD,OAAO,CAAC,cAAc,CAOrB;gBAEW,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,GAAE,MAA+B;IAcpE,SAAS,CACP,EAAE,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,QAAQ,EAAE,QAAQ,EAAE,CAAC,KAAK,IAAI,KAAK,IAAI;IA8C5E,IAAI,CAAC,CAAC,GAAG,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CAiCjD"}

package/dist/signer.d.ts

@@ -0,0 +1,39 @@
+import { Abi, Invocation, InvocationsSignerDetails, SignerInterface, Signature, typedData } from "starknet";
+import { Messenger } from "./messenger";
+export declare class Signer implements SignerInterface {
+    private messenger;
+    private url;
+    constructor(messenger: Messenger, options?: {
+        url?: string;
+    });
+    /**
+   * Method to get the public key of the signer
+   *
+   * @returns public key of signer as hex string with 0x prefix
+   */
+    getPubKey(): Promise<string>;
+    /**
+     * 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
+     */
+    signMessage(typedData: typedData.TypedData, account: string): Promise<Signature>;
+    /**
+     * 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
+     */
+    signTransaction(transactions: Invocation[], transactionsDetail: InvocationsSignerDetails, abis?: Abi[]): Promise<Signature>;
+}
+//# sourceMappingURL=signer.d.ts.map

package/dist/signer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,GAAG,EACH,UAAU,EACV,wBAAwB,EACxB,eAAe,EACf,SAAS,EACT,SAAS,EACZ,MAAM,UAAU,CAAC;AAIlB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAMxC,qBAAa,MAAO,YAAW,eAAe;IAC1C,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,GAAG,CAAkC;gBAEjC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE;QACxC,GAAG,CAAC,EAAE,MAAM,CAAC;KAChB;IAQD;;;;KAIC;IACM,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAInC;;;;;;;;OAQG;IACU,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IA6B7F;;;;;;;;;;;OAWG;IACU,eAAe,CACxB,YAAY,EAAE,UAAU,EAAE,EAC1B,kBAAkB,EAAE,wBAAwB,EAC5C,IAAI,CAAC,EAAE,GAAG,EAAE,GACb,OAAO,CAAC,SAAS,CAAC;CA8BxB"}

package/dist/types.d.ts

@@ -0,0 +1,150 @@
+import { DeployContractPayload, DeployContractResponse as StarknetDeployContractResponse, Abi, Call, InvocationsDetails, typedData, InvokeFunctionResponse, Signature, Invocation } from "starknet";
+import { BigNumberish } from "starknet/dist/utils/number";
+import { EstimateFee } from "starknet/types/account";
+export declare type Approvals = {
+    [origin: string]: {
+        scopes: Scope[];
+        maxFee: BigNumberish;
+    };
+};
+export declare type Scope = {
+    target: string;
+    method?: string;
+};
+export interface ProbeRequest extends RawRequest {
+    method: "probe";
+}
+export interface ProbeResponse extends RawResponse {
+    method: "probe";
+    result?: {
+        address?: string;
+        scopes?: Scope[];
+    };
+}
+export interface ConnectRequest extends RawRequest {
+    method: "connect";
+    params: {
+        id: string;
+        scopes: Scope[];
+    };
+}
+export interface ConnectResponse extends RawResponse {
+    method: "connect";
+    result?: {
+        success: boolean;
+        address?: string;
+        scopes: Scope[];
+    };
+}
+export interface DeployContractRequest extends RawRequest {
+    method: "deploy-contract";
+    params: {
+        id: string;
+        payload: DeployContractPayload;
+        abi?: Abi;
+    };
+}
+export interface DeployContractResponse extends RawResponse {
+    method: "deploy-contract";
+    result?: StarknetDeployContractResponse;
+}
+export interface EstimateFeeRequest extends RawRequest {
+    method: "estimate-fee";
+    params: {
+        invocation: Invocation;
+    };
+}
+export interface EstimateFeeResponse extends RawResponse {
+    method: "estimate-fee";
+    result?: EstimateFee;
+}
+export interface ExecuteRequest extends RawRequest {
+    method: "execute";
+    params: {
+        id?: string;
+        transactions: Call | Call[];
+        abis?: Abi[];
+        transactionsDetail?: InvocationsDetails;
+    };
+}
+export interface ExecuteResponse extends RawResponse {
+    method: "execute";
+    result?: InvokeFunctionResponse;
+    scopes?: Scope[];
+}
+export interface SignTransactionRequest extends RawRequest {
+    method: "sign-transaction";
+    params: {
+        id: string;
+        transactions: Call | Call[];
+        abis?: Abi[];
+        transactionsDetail?: InvocationsDetails;
+    };
+}
+export interface SignTransactionResponse extends RawResponse {
+    method: "sign-transaction";
+    result?: Signature;
+}
+export interface SignMessageRequest extends RawRequest {
+    method: "sign-message";
+    params: {
+        id: string;
+        account?: string;
+        typedData: typedData.TypedData;
+    };
+}
+export interface SignMessageResponse extends RawResponse {
+    method: "sign-message";
+    result?: Signature;
+}
+export interface HashMessageRequest extends RawRequest {
+    method: "hash-message";
+    params: {
+        typedData: typedData.TypedData;
+    };
+}
+export interface HashMessageResponse extends RawResponse {
+    method: "hash-message";
+    result?: string;
+}
+export interface VerifyMessageRequest extends RawRequest {
+    method: "verify-message";
+    params: {
+        typedData: typedData.TypedData;
+        signature: Signature;
+    };
+}
+export interface VerifyMessageResponse extends RawResponse {
+    method: "verify-message";
+    result?: boolean;
+}
+export interface VerifyMessageHashRequest extends RawRequest {
+    method: "verify-message-hash";
+    params: {
+        hash: BigNumberish;
+        signature: Signature;
+    };
+}
+export interface VerifyMessageHashResponse extends RawResponse {
+    method: "verify-message-hash";
+    result?: boolean;
+}
+export interface GetNonceRequest extends RawRequest {
+    method: "get-nonce";
+}
+export interface GetNonceResponse extends RawResponse {
+    method: "get-nonce";
+    result?: string;
+}
+export declare type RawRequest = {
+    origin?: string;
+    method: string;
+    params?: object | any[];
+};
+export declare type Request = RawRequest | ProbeRequest | ConnectRequest | DeployContractRequest | EstimateFeeRequest | ExecuteRequest | SignMessageRequest | HashMessageRequest | VerifyMessageHashRequest | VerifyMessageRequest | GetNonceRequest;
+export declare type RawResponse = {
+    result?: any;
+    error?: unknown;
+};
+export declare type Response = RawResponse | ProbeResponse | DeployContractResponse | EstimateFeeResponse | ConnectResponse | SignMessageResponse | HashMessageResponse | VerifyMessageHashResponse | VerifyMessageResponse | GetNonceResponse;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,sBAAsB,IAAI,8BAA8B,EACxD,GAAG,EACH,IAAI,EACJ,kBAAkB,EAClB,SAAS,EACT,sBAAsB,EACtB,SAAS,EACT,UAAU,EACX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEpD,oBAAY,SAAS,GAAG;IACtB,CAAC,MAAM,EAAE,MAAM,GAAG;QAChB,MAAM,EAAE,KAAK,EAAE,CAAC;QAChB,MAAM,EAAE,YAAY,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,oBAAY,KAAK,GAAG;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,KAAK,EAAE,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,CAAC,EAAE;QACP,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,KAAK,EAAE,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,qBAAqB,CAAC;QAC/B,GAAG,CAAC,EAAE,GAAG,CAAC;KACX,CAAC;CACH;AAED,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,CAAC,EAAE,8BAA8B,CAAC;CACzC;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE;QACN,UAAU,EAAE,UAAU,CAAC;KACxB,CAAC;CACH;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,EAAE;QACN,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,YAAY,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;KACzC,CAAC;CACH;AAED,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,YAAY,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;KACzC,CAAC;CACH;AAED,MAAM,WAAW,uBAAwB,SAAQ,WAAW;IAC1D,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC;KAChC,CAAC;CACH;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE;QACN,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC;KAChC,CAAC;CACH;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,MAAM,EAAE,gBAAgB,CAAC;IACzB,MAAM,EAAE;QACN,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC;QAC/B,SAAS,EAAE,SAAS,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACxD,MAAM,EAAE,gBAAgB,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,MAAM,EAAE,qBAAqB,CAAC;IAC9B,MAAM,EAAE;QACN,IAAI,EAAE,YAAY,CAAC;QACnB,SAAS,EAAE,SAAS,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,yBAA0B,SAAQ,WAAW;IAC5D,MAAM,EAAE,qBAAqB,CAAC;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;CACzB,CAAC;AAEF,oBAAY,OAAO,GACf,UAAU,GACV,YAAY,GACZ,cAAc,GACd,qBAAqB,GACrB,kBAAkB,GAClB,cAAc,GACd,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,oBAAoB,GACpB,eAAe,CAAC;AAEpB,oBAAY,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,oBAAY,QAAQ,GAChB,WAAW,GACX,aAAa,GACb,sBAAsB,GACtB,mBAAmB,GACnB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,yBAAyB,GACzB,qBAAqB,GACrB,gBAAgB,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+import { Scope } from "./types";
+export declare function diff(a: Scope[], b: Scope[]): Scope[];
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAMpD"}

package/dist/webauthn.d.ts

@@ -0,0 +1,17 @@
+import { Abi, Invocation, InvocationsSignerDetails, Signature, SignerInterface, typedData } from "starknet";
+declare type Assertion = PublicKeyCredential & {
+    response: AuthenticatorAssertionResponse;
+};
+export declare class WebauthnSigner implements SignerInterface {
+    private credentialId;
+    private publicKey;
+    constructor(credentialId: string, publicKey: string);
+    getPubKey(): Promise<string>;
+    sign(hash: string): Promise<Assertion>;
+    formatAssertion(assertion: Assertion): Signature;
+    hashTransaction(transactions: Invocation[], transactionsDetail: InvocationsSignerDetails, abis?: Abi[]): string;
+    signTransaction(transactions: Invocation[], transactionsDetail: InvocationsSignerDetails, abis?: Abi[]): Promise<Signature>;
+    signMessage(td: typedData.TypedData, accountAddress: string): Promise<Signature>;
+}
+export {};
+//# sourceMappingURL=webauthn.d.ts.map

package/dist/webauthn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webauthn.d.ts","sourceRoot":"","sources":["../src/webauthn.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,UAAU,EACV,wBAAwB,EACxB,SAAS,EACT,eAAe,EAGf,SAAS,EAEV,MAAM,UAAU,CAAC;AAMlB,aAAK,SAAS,GAAG,mBAAmB,GAAG;IACrC,QAAQ,EAAE,8BAA8B,CAAC;CAC1C,CAAC;AA8BF,qBAAa,cAAe,YAAW,eAAe;IACpD,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,SAAS,CAAS;gBAEd,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAKtC,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAI5B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAuBnD,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS;IAwDzC,eAAe,CACpB,YAAY,EAAE,UAAU,EAAE,EAC1B,kBAAkB,EAAE,wBAAwB,EAC5C,IAAI,CAAC,EAAE,GAAG,EAAE,GACX,MAAM;IAuBI,eAAe,CAC1B,YAAY,EAAE,UAAU,EAAE,EAC1B,kBAAkB,EAAE,wBAAwB,EAC5C,IAAI,CAAC,EAAE,GAAG,EAAE,GACX,OAAO,CAAC,SAAS,CAAC;IA0BR,WAAW,CACtB,EAAE,EAAE,SAAS,CAAC,SAAS,EACvB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,SAAS,CAAC;CAKtB"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@cartridge/controller",
+  "version": "0.1.0",
+  "description": "Cartridge Controller",
+  "main": "dist/index.js",
+  "module": "dist/index.es.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rimraf ./dist && rollup -c",
+    "dev": "rollup -c -w",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "test:watch": "jest --watchAll",
+    "test": "jest --ci --runInBand"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@rollup/plugin-replace": "^4.0.0",
+    "@types/jest": "^26.0.18",
+    "@types/node": "^17.0.23",
+    "jest": "^26.6.3",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.61.1",
+    "rollup-plugin-typescript2": "^0.30.0",
+    "ts-jest": "^26.5.1",
+    "ts-node": "^10.4.0",
+    "tslib": "^2.3.1",
+    "typescript": "^4.5.4"
+  },
+  "jest": {
+    "setupFiles": [],
+    "moduleFileExtensions": [
+      "ts",
+      "js",
+      "json"
+    ],
+    "roots": [
+      "src",
+      "tests"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+    "moduleNameMapper": {}
+  },
+  "dependencies": {
+    "base64url": "^3.0.1",
+    "cuid": "^2.1.8",
+    "fast-deep-equal": "^3.1.3",
+    "query-string": "^7.1.1",
+    "starknet": "4.3.0"
+  }
+}