@cartridge/controller 0.1.0

package/dist/account.d.ts

@@ -0,0 +1,89 @@
+import { AccountInterface, DeployContractPayload, Abi, Call, DeployContractResponse as StarknetDeployContractResponse, InvocationsDetails, Signature, typedData, number, Provider, Invocation, SignerInterface, InvokeFunctionResponse } from "starknet";
+import { EstimateFee } from "starknet/types/account";
+import { Messenger } from "./messenger";
+import { Scope } from "./types";
+export declare class Account extends Provider implements AccountInterface {
+    address: string;
+    private messenger;
+    private url;
+    private _scopes;
+    signer: SignerInterface;
+    constructor(address: string, scopes: Scope[], messenger: Messenger, options?: {
+        url?: string;
+    });
+    /**
+     * 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
+     */
+    deployContract(payload: DeployContractPayload, abi?: Abi): Promise<StarknetDeployContractResponse>;
+    /**
+     * 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
+     */
+    estimateFee(invocation: Invocation): Promise<EstimateFee>;
+    /**
+     * 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
+     */
+    execute(transactions: Call | Call[], abis?: Abi[], transactionsDetail?: InvocationsDetails): Promise<InvokeFunctionResponse>;
+    /**
+     * 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
+     */
+    signMessage(typedData: typedData.TypedData): Promise<Signature>;
+    /**
+     * 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
+     */
+    hashMessage(typedData: typedData.TypedData): Promise<string>;
+    /**
+     * 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
+     */
+    verifyMessage(typedData: typedData.TypedData, signature: Signature): Promise<boolean>;
+    /**
+     * 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
+     */
+    verifyMessageHash(hash: number.BigNumberish, signature: Signature): Promise<boolean>;
+    getNonce(): Promise<string>;
+}
+//# sourceMappingURL=account.d.ts.map

package/dist/account.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,GAAG,EACH,IAAI,EACJ,sBAAsB,IAAI,8BAA8B,EACxD,kBAAkB,EAClB,SAAS,EACT,SAAS,EACT,MAAM,EACN,QAAQ,EACR,UAAU,EACV,eAAe,EACf,sBAAsB,EACvB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAIpD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EACL,KAAK,EAUN,MAAM,SAAS,CAAC;AAGjB,qBAAa,OAAQ,SAAQ,QAAS,YAAW,gBAAgB;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,GAAG,CAAkC;IAC7C,OAAO,CAAC,OAAO,CAAe;IAEvB,MAAM,EAAE,eAAe,CAAC;gBAG7B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,KAAK,EAAO,EACpB,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAaH;;;;;;;;;OASG;IACG,cAAc,CAClB,OAAO,EAAE,qBAAqB,EAC9B,GAAG,CAAC,EAAE,GAAG,GACR,OAAO,CAAC,8BAA8B,CAAC;IA2B1C;;;;;;;;;;OAUG;IACG,WAAW,CACf,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,WAAW,CAAC;IAevB;;;;;;;;;;;OAWG;IACG,OAAO,CACX,YAAY,EAAE,IAAI,GAAG,IAAI,EAAE,EAC3B,IAAI,CAAC,EAAE,GAAG,EAAE,EACZ,kBAAkB,CAAC,EAAE,kBAAkB,GACtC,OAAO,CAAC,sBAAsB,CAAC;IAgDlC;;;;;;;OAOG;IACG,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IA4BrE;;;;;;;OAOG;IACG,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAelE;;;;;;;OAOG;IACG,aAAa,CACjB,SAAS,EAAE,SAAS,CAAC,SAAS,EAC9B,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;OAQG;IACG,iBAAiB,CACrB,IAAI,EAAE,MAAM,CAAC,YAAY,EACzB,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC,OAAO,CAAC;IAgBb,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;CAWlC"}

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { Message, Messenger } from "./messenger";
+import { Scope } from "./types";
+import { AccountInterface } from "starknet";
+export declare class Cartridge {
+    private selector;
+    private messenger?;
+    private scopes;
+    private url;
+    private origin;
+    private loading;
+    private ready_;
+    private account;
+    constructor(scopes?: Scope[], options?: {
+        url?: string;
+        origin?: string;
+    });
+    ready(): Promise<boolean>;
+    probe(): Promise<AccountInterface>;
+    connect(): Promise<AccountInterface>;
+}
+export { Message, Messenger };
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAkD,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhF,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,SAAS,CAAC,CAAY;IAC9B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,GAAG,CAAkC;IAC7C,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,OAAO,CAAmB;gBAGhC,MAAM,CAAC,EAAE,KAAK,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAuDG,KAAK;IAKL,KAAK;IAmBL,OAAO;CA2Cd;AAED,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAC9B,cAAc,SAAS,CAAC"}