@cartridge/controller-wasm 0.8.0 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cartridge/controller-wasm",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Wasm bindings for Cartridge Controller and Session Account",
   "type": "module",
   "main": "./pkg-controller/account_wasm.js",

package/pkg-controller/account_wasm.d.ts

@@ -1,123 +1,5 @@
 /* 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;
-/**
- * Subscribes to the creation of a session for a given controller, session_key_guid and cartridge api url.
- * The goal of this function is to know from any place when the register session flow has been completed, and to
- * get the authorization.
- */
-export function subscribeCreateSession(session_key_guid: JsFelt, cartridge_api_url: string): Promise<JsSubscribeSessionResult>;
-export function signerToGuid(signer: Signer): 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,
-  StarknetReplacementTransactionUnderpriced = 64,
-  StarknetFeeBelowMinimum = 65,
-  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,
-  AccountFeeOutOfRange = 128,
-  ProviderRateLimited = 129,
-  ProviderArrayLengthMismatch = 130,
-  ProviderOther = 131,
-  SessionAlreadyRegistered = 132,
-  UrlParseError = 133,
-  Base64DecodeError = 134,
-  CoseError = 135,
-  PolicyChainIdMismatch = 136,
-  InvalidOwner = 137,
-  GasPriceTooHigh = 138,
-  TransactionTimeout = 139,
-  ConversionError = 140,
-  InvalidChainId = 141,
-  SessionRefreshRequired = 142,
-  ManualExecutionRequired = 143,
-  ForbiddenEntrypoint = 144,
-  GasAmountTooHigh = 145,
-  ApproveExecutionRequired = 146,
-}
-export interface JsCall {
-    contractAddress: JsFelt;
-    entrypoint: string;
-    calldata: JsFelt[];
-}
-
-export type JsPriceUnit = "WEI" | "FRI";
-
-export interface JsEstimateFeeDetails {
-    nonce: JsFelt;
-}
-
-export interface JsFeeEstimate {
-    l1_gas_consumed: number;
-    l1_gas_price: number;
-    l2_gas_consumed: number;
-    l2_gas_price: number;
-    l1_data_gas_consumed: number;
-    l1_data_gas_price: number;
-    overall_fee: number;
-}
-
 /**
  * JavaScript-friendly OutsideExecution V3 structure
  */
@@ -137,6 +19,18 @@ export interface JsSignedOutsideExecution {
     signature: JsFelt[];
 }
 
+export type JsFeeSource = "PAYMASTER" | "CREDITS";
+
+export type Felts = JsFelt[];
+
+export type JsFelt = Felt;
+
+export interface JsCall {
+    contractAddress: JsFelt;
+    entrypoint: string;
+    calldata: JsFelt[];
+}
+
 export interface Owner {
     signer?: Signer;
     account?: JsFelt;
@@ -161,9 +55,7 @@ export interface ApprovalPolicy {
 
 export type Policy = CallPolicy | TypedDataPolicy | ApprovalPolicy;
 
-export type JsRegister = RegisterInput;
-
-export type JsRegisterResponse = ResponseData;
+export type JsAddSignerInput = SignerInput;
 
 export interface WebauthnSigner {
     rpId: string;
@@ -171,14 +63,6 @@ export interface WebauthnSigner {
     publicKey: string;
 }
 
-export interface StarknetSigner {
-    privateKey: JsFelt;
-}
-
-export interface Eip191Signer {
-    address: string;
-}
-
 export interface Signer {
     webauthns?: WebauthnSigner[];
     webauthn?: WebauthnSigner;
@@ -186,19 +70,32 @@ export interface Signer {
     eip191?: Eip191Signer;
 }
 
-export type JsAddSignerInput = SignerInput;
-
 export type JsRemoveSignerInput = SignerInput;
 
-export type JsFelt = Felt;
+export interface StarknetSigner {
+    privateKey: JsFelt;
+}
 
-export type Felts = JsFelt[];
+export interface Eip191Signer {
+    address: string;
+}
 
-export type JsFeeSource = "PAYMASTER" | "CREDITS";
+export type JsRevokableSession = RevokableSession;
 
-export type JsSubscribeSessionResult = SubscribeCreateSessionSubscribeCreateSession;
+export interface Session {
+    policies: Policy[];
+    expiresAt: number;
+    metadataHash: JsFelt;
+    sessionKeyGuid: JsFelt;
+    guardianKeyGuid: JsFelt;
+}
 
-export type JsRevokableSession = RevokableSession;
+export interface Credentials {
+    authorization: JsFelt[];
+    privateKey: JsFelt;
+}
+
+export type JsSubscribeSessionResult = SubscribeCreateSessionSubscribeCreateSession;
 
 export interface AuthorizedSession {
     session: Session;
@@ -211,33 +108,34 @@ export interface AuthorizedSession {
     guardianKeyGuid: JsFelt;
 }
 
-export interface Session {
-    policies: Policy[];
-    expiresAt: number;
-    metadataHash: JsFelt;
-    sessionKeyGuid: JsFelt;
-    guardianKeyGuid: JsFelt;
+export interface JsFeeEstimate {
+    l1_gas_consumed: number;
+    l1_gas_price: number;
+    l2_gas_consumed: number;
+    l2_gas_price: number;
+    l1_data_gas_consumed: number;
+    l1_data_gas_price: number;
+    overall_fee: number;
 }
 
-export interface Credentials {
-    authorization: JsFelt[];
-    privateKey: JsFelt;
+export type JsPriceUnit = "WEI" | "FRI";
+
+export interface JsEstimateFeeDetails {
+    nonce: JsFelt;
 }
 
+export type JsRegister = RegisterInput;
+
+export type JsRegisterResponse = ResponseData;
+
+
 export class CartridgeAccount {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
-  /**
-   * Creates a new `CartridgeAccount` instance.
-   *
-   * # Parameters
-   * - `rpc_url`: The URL of the JSON-RPC endpoint.
-   * - `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(class_hash: JsFelt, rpc_url: string, address: JsFelt, username: string, owner: Owner, cartridge_api_url: string): Promise<CartridgeAccountWithMeta>;
+  disconnect(): Promise<void>;
+  deploySelf(max_fee?: JsFeeEstimate | null): Promise<any>;
+  static fromStorage(cartridge_api_url: string): Promise<CartridgeAccountWithMeta | undefined>;
   /**
    * Creates a new `CartridgeAccount` instance with a randomly generated Starknet signer.
    * The controller address is computed internally based on the generated signer.
@@ -247,32 +145,31 @@ export class CartridgeAccount {
    * - `username`: Username associated with the account.
    */
   static newHeadless(class_hash: JsFelt, rpc_url: string, username: string, cartridge_api_url: string): Promise<CartridgeAccountWithMeta>;
-  static fromStorage(cartridge_api_url: string): Promise<CartridgeAccountWithMeta | undefined>;
-  disconnect(): Promise<void>;
-  registerSession(app_id: string, 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>;
-  register(register: JsRegister): Promise<JsRegisterResponse>;
-  createSession(app_id: string, policies: Policy[], expires_at: bigint, authorize_user_execution?: boolean | null): Promise<AuthorizedSession | undefined>;
-  skipSession(app_id: string, policies: Policy[]): Promise<void>;
-  addOwner(owner?: Signer | null, signer_input?: JsAddSignerInput | null, rp_id?: string | null): Promise<void>;
   removeOwner(signer: JsRemoveSignerInput): Promise<void>;
-  createPasskeySigner(rp_id: string): Promise<JsAddSignerInput>;
-  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>;
-  trySessionExecute(app_id: string, calls: JsCall[], fee_source?: JsFeeSource | null): Promise<any>;
-  isRegisteredSessionAuthorized(policies: Policy[], public_key?: JsFelt | null): Promise<AuthorizedSession | undefined>;
-  hasRequestedSession(app_id: string, policies: Policy[]): Promise<boolean>;
+  signMessage(typed_data: string): Promise<Felts>;
+  skipSession(app_id: string, policies: Policy[]): Promise<void>;
+  createSession(app_id: string, policies: Policy[], expires_at: bigint, authorize_user_execution?: boolean | null): Promise<AuthorizedSession | undefined>;
   revokeSession(session: JsRevokableSession): Promise<void>;
   revokeSessions(sessions: JsRevokableSession[]): Promise<void>;
-  signMessage(typed_data: string): Promise<Felts>;
-  getNonce(): Promise<any>;
-  deploySelf(max_fee?: JsFeeEstimate | null): Promise<any>;
   delegateAccount(): Promise<JsFelt>;
-  hasAuthorizedPoliciesForCalls(app_id: string, calls: JsCall[]): Promise<boolean>;
-  hasAuthorizedPoliciesForMessage(app_id: string, typed_data: string): Promise<boolean>;
+  registerSession(app_id: string, policies: Policy[], expires_at: bigint, public_key: JsFelt, max_fee?: JsFeeEstimate | null): Promise<any>;
+  estimateInvokeFee(calls: JsCall[]): Promise<JsFeeEstimate>;
+  trySessionExecute(app_id: string, calls: JsCall[], fee_source?: JsFeeSource | null): Promise<any>;
+  createPasskeySigner(rp_id: string): Promise<JsAddSignerInput>;
+  hasRequestedSession(app_id: string, policies: Policy[]): Promise<boolean>;
+  executeFromOutsideV2(calls: JsCall[], fee_source?: JsFeeSource | null): Promise<any>;
+  executeFromOutsideV3(calls: JsCall[], fee_source?: JsFeeSource | null): Promise<any>;
+  /**
+   * Checks if there are stored policies for a given app_id.
+   *
+   * # Parameters
+   * - `app_id`: The application identifier to check for stored policies
+   *
+   * # Returns
+   * `true` if policies exist for the given app_id, `false` otherwise
+   */
+  hasPoliciesForAppId(app_id: string): Promise<boolean>;
+  registerSessionCalldata(policies: Policy[], expires_at: bigint, public_key: JsFelt): Promise<any>;
   /**
    * Signs an OutsideExecution V3 transaction and returns both the OutsideExecution object and its signature.
    *
@@ -283,56 +180,47 @@ export class CartridgeAccount {
    * A `JsSignedOutsideExecution` containing the OutsideExecution V3 object and its signature
    */
   signExecuteFromOutside(calls: JsCall[]): Promise<JsSignedOutsideExecution>;
+  isRegisteredSessionAuthorized(policies: Policy[], public_key?: JsFelt | null): Promise<AuthorizedSession | undefined>;
+  hasAuthorizedPoliciesForCalls(app_id: string, calls: JsCall[]): Promise<boolean>;
+  hasAuthorizedPoliciesForMessage(app_id: string, typed_data: string): Promise<boolean>;
   /**
-   * Checks if there are stored policies for a given app_id.
+   * Creates a new `CartridgeAccount` instance.
    *
    * # Parameters
-   * - `app_id`: The application identifier to check for stored policies
-   *
-   * # Returns
-   * `true` if policies exist for the given app_id, `false` otherwise
+   * - `rpc_url`: The URL of the JSON-RPC endpoint.
+   * - `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.
    */
-  hasPoliciesForAppId(app_id: string): Promise<boolean>;
+  static new(class_hash: JsFelt, rpc_url: string, address: JsFelt, username: string, owner: Owner, cartridge_api_url: string): Promise<CartridgeAccountWithMeta>;
+  execute(calls: JsCall[], max_fee?: JsFeeEstimate | null, fee_source?: JsFeeSource | null): Promise<any>;
+  upgrade(new_class_hash: JsFelt): Promise<JsCall>;
+  register(register: JsRegister): Promise<JsRegisterResponse>;
+  addOwner(owner?: Signer | null, signer_input?: JsAddSignerInput | null, rp_id?: string | null): Promise<void>;
+  getNonce(): Promise<any>;
 }
-/**
- * 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;
   [Symbol.dispose](): void;
-  username(): string;
-  address(): string;
   classHash(): string;
+  ownerGuid(): JsFelt;
+  owner(): Owner;
+  address(): string;
   rpcUrl(): string;
   chainId(): string;
-  owner(): Owner;
-  ownerGuid(): JsFelt;
+  username(): string;
 }
-/**
- * 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;
   [Symbol.dispose](): void;
-  meta(): CartridgeAccountMeta;
   intoAccount(): CartridgeAccount;
+  meta(): CartridgeAccountMeta;
 }
+
 export class ControllerFactory {
   private constructor();
   free(): void;
@@ -372,18 +260,93 @@ export class ControllerFactory {
    */
   static apiLogin(username: string, class_hash: JsFelt, rpc_url: string, address: JsFelt, owner: Owner, cartridge_api_url: string): Promise<CartridgeAccountWithMeta>;
 }
-/**
- * JavaScript-friendly chain configuration
- */
+
+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,
+  StarknetReplacementTransactionUnderpriced = 64,
+  StarknetFeeBelowMinimum = 65,
+  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,
+  AccountFeeOutOfRange = 128,
+  ProviderRateLimited = 129,
+  ProviderArrayLengthMismatch = 130,
+  ProviderOther = 131,
+  SessionAlreadyRegistered = 132,
+  UrlParseError = 133,
+  Base64DecodeError = 134,
+  CoseError = 135,
+  PolicyChainIdMismatch = 136,
+  InvalidOwner = 137,
+  GasPriceTooHigh = 138,
+  TransactionTimeout = 139,
+  ConversionError = 140,
+  InvalidChainId = 141,
+  SessionRefreshRequired = 142,
+  ManualExecutionRequired = 143,
+  ForbiddenEntrypoint = 144,
+  GasAmountTooHigh = 145,
+  ApproveExecutionRequired = 146,
+}
+
 export class JsChainConfig {
   free(): void;
   [Symbol.dispose](): void;
   constructor(class_hash: JsFelt, rpc_url: string, owner: Owner, address?: JsFelt | null);
   readonly class_hash: JsFelt;
-  readonly rpc_url: string;
   readonly owner: Owner;
   readonly address: JsFelt | undefined;
+  readonly rpc_url: string;
 }
+
 export class JsControllerError {
   private constructor();
   free(): void;
@@ -393,47 +356,68 @@ export class JsControllerError {
   get data(): string | undefined;
   set data(value: string | null | undefined);
 }
+
 export class LoginResult {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
   intoValues(): Array<any>;
 }
-/**
- * WASM bindings for MultiChainController
- */
+
 export class MultiChainAccount {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
   /**
-   * Creates a new MultiChainAccount with multiple chain configurations
+   * Gets an account instance for a specific chain
    */
-  static create(username: string, chain_configs: JsChainConfig[], cartridge_api_url: string): Promise<MultiChainAccount>;
+  controller(chain_id: JsFelt): Promise<CartridgeAccount>;
   /**
    * Loads a MultiChainAccount from storage
    */
   static fromStorage(cartridge_api_url: string): Promise<MultiChainAccount | undefined>;
-  /**
-   * Adds a new chain configuration
-   */
-  addChain(config: JsChainConfig): Promise<void>;
   /**
    * Removes a chain configuration
    */
   removeChain(chain_id: JsFelt): Promise<void>;
   /**
-   * Gets an account instance for a specific chain
+   * Creates a new MultiChainAccount with multiple chain configurations
    */
-  controller(chain_id: JsFelt): Promise<CartridgeAccount>;
+  static create(username: string, chain_configs: JsChainConfig[], cartridge_api_url: string): Promise<MultiChainAccount>;
+  /**
+   * Adds a new chain configuration
+   */
+  addChain(config: JsChainConfig): Promise<void>;
 }
-/**
- * Metadata for displaying multi-chain information
- */
+
 export class MultiChainAccountMeta {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
-  readonly username: string;
   readonly chains: JsFelt[];
+  readonly username: string;
 }
+
+/**
+ * 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 function signerToGuid(signer: Signer): JsFelt;
+
+/**
+ * Subscribes to the creation of a session for a given controller, session_key_guid and cartridge api url.
+ * The goal of this function is to know from any place when the register session flow has been completed, and to
+ * get the authorization.
+ */
+export function subscribeCreateSession(session_key_guid: JsFelt, cartridge_api_url: string): Promise<JsSubscribeSessionResult>;