@cartridge/controller-wasm 0.7.14-0df5a4c → 0.7.14-24e7b0f

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cartridge/controller-wasm",
-  "version": "0.7.14-0df5a4c",
+  "version": "0.7.14-24e7b0f",
   "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,5 +1,101 @@
 /* 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;
@@ -128,7 +224,6 @@ export interface Credentials {
     privateKey: JsFelt;
 }
 
-
 export class CartridgeAccount {
   private constructor();
   free(): void;
@@ -199,7 +294,19 @@ export class CartridgeAccount {
    */
   hasPoliciesForAppId(app_id: 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;
@@ -212,7 +319,13 @@ export class CartridgeAccountMeta {
   owner(): Owner;
   ownerGuid(): JsFelt;
 }
-
+/**
+ * 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;
@@ -220,7 +333,6 @@ export class CartridgeAccountWithMeta {
   meta(): CartridgeAccountMeta;
   intoAccount(): CartridgeAccount;
 }
-
 export class ControllerFactory {
   private constructor();
   free(): void;
@@ -260,83 +372,9 @@ export class ControllerFactory {
    */
   static apiLogin(username: string, class_hash: JsFelt, rpc_url: string, address: JsFelt, owner: Owner, cartridge_api_url: string): Promise<CartridgeAccountWithMeta>;
 }
-
-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,
-}
-
+/**
+ * JavaScript-friendly chain configuration
+ */
 export class JsChainConfig {
   free(): void;
   [Symbol.dispose](): void;
@@ -346,7 +384,6 @@ export class JsChainConfig {
   readonly owner: Owner;
   readonly address: JsFelt | undefined;
 }
-
 export class JsControllerError {
   private constructor();
   free(): void;
@@ -356,14 +393,15 @@ 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;
@@ -389,7 +427,9 @@ export class MultiChainAccount {
    */
   controller(chain_id: JsFelt): Promise<CartridgeAccount>;
 }
-
+/**
+ * Metadata for displaying multi-chain information
+ */
 export class MultiChainAccountMeta {
   private constructor();
   free(): void;
@@ -397,27 +437,3 @@ export class MultiChainAccountMeta {
   readonly username: string;
   readonly chains: JsFelt[];
 }
-
-/**
- * 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>;