@cartridge/controller-wasm 0.1.0 → 0.1.2

package/package.json

@@ -1,9 +1,53 @@
 {
   "name": "@cartridge/controller-wasm",
-  "version": "0.1.0",
-  "files": "[\"*.js\", \"*.wasm\", \"*.d.ts\"]",
-  "main": "account_wasm.js",
-  "types": "account_wasm.d.ts",
+  "version": "0.1.2",
+  "description": "Wasm bindings for Cartridge Controller and Session Account",
+  "type": "module",
+  "main": "./pkg-controller/account_wasm.js",
+  "module": "./pkg-controller/account_wasm.js",
+  "types": "./pkg-controller/account_wasm.d.ts",
+  "scripts": {
+    "build:deps": "./build.sh"
+  },
+  "files": [
+    "./pkg-controller/account_wasm_bg.wasm",
+    "./pkg-controller/account_wasm.js",
+    "./pkg-controller/account_wasm_bg.js",
+    "./pkg-controller/account_wasm.d.ts",
+    "./pkg-controller/snippets/**/*",
+    "./pkg-session/session_wasm_bg.wasm",
+    "./pkg-session/session_wasm.js",
+    "./pkg-session/session_wasm_bg.js",
+    "./pkg-session/session_wasm.d.ts",
+    "./pkg-session/snippets/**/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./pkg-controller/account_wasm.d.ts",
+      "import": "./pkg-controller/account_wasm.js",
+      "require": "./pkg-controller/account_wasm.js"
+    },
+    "./controller": {
+      "types": "./pkg-controller/account_wasm.d.ts",
+      "import": "./pkg-controller/account_wasm.js",
+      "require": "./pkg-controller/account_wasm.js"
+    },
+    "./session": {
+      "types": "./pkg-session/session_wasm.d.ts",
+      "import": "./pkg-session/session_wasm.js",
+      "require": "./pkg-session/session_wasm.js"
+    }
+  },
+  "sideEffects": [
+    "./pkg-controller/account_wasm.js",
+    "./pkg-session/session_wasm.js",
+    "./pkg-controller/snippets/*",
+    "./pkg-session/snippets/*"
+  ],
+  "devDependencies": {
+    "wasm-pack": "^0.13.0"
+  },
+  "packageManager": "pnpm@9.12.3+sha512.cce0f9de9c5a7c95bef944169cc5dfe8741abfb145078c0d508b868056848a87c81e626246cb60967cbd7fd29a6c062ef73ff840d96b3c86c40ac92cf4a813ee",
   "repository": "https://github.com/cartridge-gg/controller-rs",
   "license": "MIT"
 }

package/pkg-controller/account_wasm.d.ts

@@ -0,0 +1,252 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Computes the Starknet contract address for a controller account without needing a full instance.
+ *
+ * # Arguments
+ *
+ * * `class_hash` - The class hash of the account contract (JsFelt).
+ * * `owner` - The owner configuration for the account.
+ * * `salt` - The salt used for address calculation (JsFelt).
+ *
+ * # Returns
+ *
+ * The computed Starknet contract address as a `JsFelt`.
+ */
+export function computeAccountAddress(class_hash: JsFelt, owner: Owner, salt: JsFelt): JsFelt;
+export enum ErrorCode {
+  StarknetFailedToReceiveTransaction = 1,
+  StarknetContractNotFound = 20,
+  StarknetBlockNotFound = 24,
+  StarknetInvalidTransactionIndex = 27,
+  StarknetClassHashNotFound = 28,
+  StarknetTransactionHashNotFound = 29,
+  StarknetPageSizeTooBig = 31,
+  StarknetNoBlocks = 32,
+  StarknetInvalidContinuationToken = 33,
+  StarknetTooManyKeysInFilter = 34,
+  StarknetContractError = 40,
+  StarknetTransactionExecutionError = 41,
+  StarknetClassAlreadyDeclared = 51,
+  StarknetInvalidTransactionNonce = 52,
+  StarknetInsufficientMaxFee = 53,
+  StarknetInsufficientAccountBalance = 54,
+  StarknetValidationFailure = 55,
+  StarknetCompilationFailed = 56,
+  StarknetContractClassSizeIsTooLarge = 57,
+  StarknetNonAccount = 58,
+  StarknetDuplicateTx = 59,
+  StarknetCompiledClassHashMismatch = 60,
+  StarknetUnsupportedTxVersion = 61,
+  StarknetUnsupportedContractClassVersion = 62,
+  StarknetUnexpectedError = 63,
+  StarknetNoTraceAvailable = 10,
+  SignError = 101,
+  StorageError = 102,
+  AccountFactoryError = 103,
+  PaymasterExecutionTimeNotReached = 104,
+  PaymasterExecutionTimePassed = 105,
+  PaymasterInvalidCaller = 106,
+  PaymasterRateLimitExceeded = 107,
+  PaymasterNotSupported = 108,
+  PaymasterHttp = 109,
+  PaymasterExcecution = 110,
+  PaymasterSerialization = 111,
+  CartridgeControllerNotDeployed = 112,
+  InsufficientBalance = 113,
+  OriginError = 114,
+  EncodingError = 115,
+  SerdeWasmBindgenError = 116,
+  CairoSerdeError = 117,
+  CairoShortStringToFeltError = 118,
+  DeviceCreateCredential = 119,
+  DeviceGetAssertion = 120,
+  DeviceBadAssertion = 121,
+  DeviceChannel = 122,
+  DeviceOrigin = 123,
+  AccountSigning = 124,
+  AccountProvider = 125,
+  AccountClassHashCalculation = 126,
+  AccountClassCompression = 127,
+  AccountFeeOutOfRange = 128,
+  ProviderRateLimited = 129,
+  ProviderArrayLengthMismatch = 130,
+  ProviderOther = 131,
+  SessionAlreadyRegistered = 132,
+  UrlParseError = 133,
+  Base64DecodeError = 134,
+  CoseError = 135,
+  PolicyChainIdMismatch = 136,
+}
+export interface JsCall {
+    contractAddress: JsFelt;
+    entrypoint: string;
+    calldata: JsFelt[];
+}
+
+export type JsPriceUnit = "WEI" | "FRI";
+
+export interface JsEstimateFeeDetails {
+    nonce: JsFelt;
+}
+
+export interface JsFeeEstimate {
+    gas_consumed: JsFelt;
+    gas_price: JsFelt;
+    overall_fee: JsFelt;
+    unit: JsPriceUnit;
+    data_gas_consumed: JsFelt;
+    data_gas_price: JsFelt;
+}
+
+export interface Owner {
+    signer?: Signer;
+    account?: JsFelt;
+}
+
+export interface CallPolicy {
+    target: JsFelt;
+    method: JsFelt;
+    authorized?: boolean;
+}
+
+export interface TypedDataPolicy {
+    scope_hash: JsFelt;
+    authorized?: boolean;
+}
+
+export type Policy = CallPolicy | TypedDataPolicy;
+
+export interface WebauthnSigner {
+    rpId: string;
+    credentialId: string;
+    publicKey: string;
+}
+
+export interface StarknetSigner {
+    privateKey: JsFelt;
+}
+
+export interface Eip191Signer {
+    address: string;
+}
+
+export interface Signer {
+    webauthn?: WebauthnSigner;
+    starknet?: StarknetSigner;
+    eip191?: Eip191Signer;
+}
+
+export type JsFelt = Felt;
+
+export type Felts = JsFelt[];
+
+export type JsFeeSource = "PAYMASTER" | "CREDITS";
+
+export interface AuthorizedSession {
+    session: Session;
+    authorization: JsFelt[] | null;
+    isRegistered: boolean;
+    expiresAt: number;
+    allowedPoliciesRoot: JsFelt;
+    metadataHash: JsFelt;
+    sessionKeyGuid: JsFelt;
+    guardianKeyGuid: JsFelt;
+}
+
+export interface Session {
+    policies: Policy[];
+    expiresAt: number;
+    metadataHash: JsFelt;
+    sessionKeyGuid: JsFelt;
+    guardianKeyGuid: JsFelt;
+}
+
+export interface Credentials {
+    authorization: JsFelt[];
+    privateKey: JsFelt;
+}
+
+export class CartridgeAccount {
+  private constructor();
+  free(): void;
+  /**
+   * Creates a new `CartridgeAccount` instance.
+   *
+   * # Parameters
+   * - `app_id`: Application identifier.
+   * - `rpc_url`: The URL of the JSON-RPC endpoint.
+   * - `chain_id`: Identifier of the blockchain network to interact with.
+   * - `address`: The blockchain address associated with the account.
+   * - `username`: Username associated with the account.
+   * - `owner`: A Owner struct containing the owner signer and associated data.
+   */
+  static new(app_id: string, class_hash: JsFelt, rpc_url: string, chain_id: JsFelt, address: JsFelt, username: string, owner: Owner): CartridgeAccountWithMeta;
+  static fromStorage(app_id: string): CartridgeAccountWithMeta | undefined;
+  disconnect(): Promise<void>;
+  registerSession(policies: Policy[], expires_at: bigint, public_key: JsFelt, max_fee?: JsFeeEstimate | null): Promise<any>;
+  registerSessionCalldata(policies: Policy[], expires_at: bigint, public_key: JsFelt): Promise<any>;
+  upgrade(new_class_hash: JsFelt): Promise<JsCall>;
+  login(expires_at: bigint): Promise<AuthorizedSession>;
+  createSession(policies: Policy[], expires_at: bigint): Promise<AuthorizedSession | undefined>;
+  skipSession(policies: Policy[]): Promise<void>;
+  estimateInvokeFee(calls: JsCall[]): Promise<JsFeeEstimate>;
+  execute(calls: JsCall[], max_fee?: JsFeeEstimate | null, fee_source?: JsFeeSource | null): Promise<any>;
+  executeFromOutsideV2(calls: JsCall[], fee_source?: JsFeeSource | null): Promise<any>;
+  executeFromOutsideV3(calls: JsCall[], fee_source?: JsFeeSource | null): Promise<any>;
+  isRegisteredSessionAuthorized(policies: Policy[], public_key?: JsFelt | null): Promise<AuthorizedSession | undefined>;
+  hasRequestedSession(policies: Policy[]): Promise<boolean>;
+  revokeSession(): void;
+  signMessage(typed_data: string): Promise<Felts>;
+  getNonce(): Promise<any>;
+  deploySelf(max_fee?: JsFeeEstimate | null): Promise<any>;
+  delegateAccount(): Promise<JsFelt>;
+  hasAuthorizedPoliciesForCalls(calls: JsCall[]): Promise<boolean>;
+  hasAuthorizedPoliciesForMessage(typed_data: string): Promise<boolean>;
+}
+/**
+ * A type for accessing fixed attributes of `CartridgeAccount`.
+ *
+ * This type exists as concurrent mutable and immutable calls to `CartridgeAccount` are guarded
+ * with `WasmMutex`, which only operates under an `async` context. If these getters were directly
+ * implemented under `CartridgeAccount`:
+ *
+ * - calls to them would unnecessarily have to be `async` as well;
+ * - there would be excessive locking.
+ *
+ * This type is supposed to only ever be borrowed immutably. So no concurrent access control would
+ * be needed.
+ */
+export class CartridgeAccountMeta {
+  private constructor();
+  free(): void;
+  appId(): string;
+  username(): string;
+  address(): string;
+  classHash(): string;
+  rpcUrl(): string;
+  chainId(): string;
+  ownerGuid(): JsFelt;
+  owner(): Owner;
+}
+/**
+ * A type used as the return type for constructing `CartridgeAccount` to provide an extra,
+ * separately borrowable `meta` field for synchronously accessing fixed fields.
+ *
+ * This type exists instead of simply having `CartridgeAccount::new()` return a tuple as tuples
+ * don't implement `IntoWasmAbi` which is needed for crossing JS-WASM boundary.
+ */
+export class CartridgeAccountWithMeta {
+  private constructor();
+  free(): void;
+  meta(): CartridgeAccountMeta;
+  intoAccount(): CartridgeAccount;
+}
+export class JsControllerError {
+  private constructor();
+  free(): void;
+  code: ErrorCode;
+  message: string;
+  get data(): string | undefined;
+  set data(value: string | null | undefined);
+}

package/pkg-controller/account_wasm.js

@@ -0,0 +1,4 @@
+import * as wasm from "./account_wasm_bg.wasm";
+export * from "./account_wasm_bg.js";
+import { __wbg_set_wasm } from "./account_wasm_bg.js";
+__wbg_set_wasm(wasm);