@sovereign-sdk/universal-wallet-wasm 0.1.3 → 0.1.4

package/README.md

@@ -1,19 +1,76 @@
 # @sovereign-sdk/universal-wallet-wasm
 
-To install dependencies:
+[![npm version](https://img.shields.io/npm/v/@sovereign-sdk/universal-wallet-wasm.svg)](https://www.npmjs.com/package/@sovereign-sdk/universal-wallet-wasm)
+[![CI](https://github.com/Sovereign-Labs/sovereign-sdk-web3-js/actions/workflows/ci.yaml/badge.svg)](https://github.com/Sovereign-Labs/sovereign-sdk-web3-js/actions/workflows/ci.yaml)
+
+WebAssembly bindings for Sovereign SDK's universal wallet, providing schema validation and serialization utilities.
+
+## Installation
 
 ```bash
-pnpm install
+npm install @sovereign-sdk/universal-wallet-wasm
 ```
 
-Compile to wasm and build JavaScript packages:
+## Features
 
-```bash
-pnpm run build
+- 🔄 JSON to Borsh serialization of rollup types
+- 📝 Schema validation
+- 📄 Human-readable display of Borsh bytes
+
+## Usage
+
+```typescript
+import { Schema, KnownTypeId } from '@sovereign-sdk/universal-wallet-wasm';
+
+// Initialize schema from JSON outputted during rollup compilation
+const schema = Schema.fromJSON(JSON.stringify(yourSchemaJson));
+
+// Convert JSON to Borsh bytes
+const runtimeCall = { value_setter: { set_many_values: [4, 6] } };
+const borshBytes = schema.jsonToBorsh(
+  schema.knownTypeIndex(KnownTypeId.RuntimeCall),
+  JSON.stringify(runtimeCall)
+);
+
+// Display Borsh bytes as human-readable string
+const displayed = schema.display(
+  schema.knownTypeIndex(KnownTypeId.RuntimeCall),
+  borshBytes
+);
 ```
 
-Run tests (must compile first):
+## Development Guide
 
-```bash
-pnpm run test
+This package uses [wasm-pack](https://rustwasm.github.io/wasm-pack/) to compile Rust code to WebAssembly and generate JavaScript bindings.
+
+### Prerequisites
+
+1. Install Rust (version 1.79 or later)
+2. Install Node.js dependencies: `pnpm install`
+
+### Build Commands
+
+- `pnpm build` - Builds both Node.js and ESM targets
+- `pnpm compile:node` - Builds Node.js target only
+- `pnpm compile:esm` - Builds ESM target only
+- `pnpm test` - Runs tests
+
+### Project Structure
+
+```
+universal-wallet-wasm/
+├── src/           # Rust source code
+├── tests/         # TypeScript tests
+├── dist/         # Compiled outputs (generated)
+│   ├── node/     # Node.js target
+│   └── esm/      # ESM target
+└── Cargo.toml    # Rust dependencies
+└── package.json  # NPM package configuration
 ```
+
+### Making Changes
+
+1. Edit Rust code in `src/lib.rs`
+2. Run `pnpm build` to compile
+3. Add tests in `tests/` directory
+4. Run `pnpm test` to verify changes

package/dist/esm/README.md

@@ -1,19 +1,76 @@
 # @sovereign-sdk/universal-wallet-wasm
 
-To install dependencies:
+[![npm version](https://img.shields.io/npm/v/@sovereign-sdk/universal-wallet-wasm.svg)](https://www.npmjs.com/package/@sovereign-sdk/universal-wallet-wasm)
+[![CI](https://github.com/Sovereign-Labs/sovereign-sdk-web3-js/actions/workflows/ci.yaml/badge.svg)](https://github.com/Sovereign-Labs/sovereign-sdk-web3-js/actions/workflows/ci.yaml)
+
+WebAssembly bindings for Sovereign SDK's universal wallet, providing schema validation and serialization utilities.
+
+## Installation
 
 ```bash
-pnpm install
+npm install @sovereign-sdk/universal-wallet-wasm
 ```
 
-Compile to wasm and build JavaScript packages:
+## Features
 
-```bash
-pnpm run build
+- 🔄 JSON to Borsh serialization of rollup types
+- 📝 Schema validation
+- 📄 Human-readable display of Borsh bytes
+
+## Usage
+
+```typescript
+import { Schema, KnownTypeId } from '@sovereign-sdk/universal-wallet-wasm';
+
+// Initialize schema from JSON outputted during rollup compilation
+const schema = Schema.fromJSON(JSON.stringify(yourSchemaJson));
+
+// Convert JSON to Borsh bytes
+const runtimeCall = { value_setter: { set_many_values: [4, 6] } };
+const borshBytes = schema.jsonToBorsh(
+  schema.knownTypeIndex(KnownTypeId.RuntimeCall),
+  JSON.stringify(runtimeCall)
+);
+
+// Display Borsh bytes as human-readable string
+const displayed = schema.display(
+  schema.knownTypeIndex(KnownTypeId.RuntimeCall),
+  borshBytes
+);
 ```
 
-Run tests (must compile first):
+## Development Guide
 
-```bash
-pnpm run test
+This package uses [wasm-pack](https://rustwasm.github.io/wasm-pack/) to compile Rust code to WebAssembly and generate JavaScript bindings.
+
+### Prerequisites
+
+1. Install Rust (version 1.79 or later)
+2. Install Node.js dependencies: `pnpm install`
+
+### Build Commands
+
+- `pnpm build` - Builds both Node.js and ESM targets
+- `pnpm compile:node` - Builds Node.js target only
+- `pnpm compile:esm` - Builds ESM target only
+- `pnpm test` - Runs tests
+
+### Project Structure
+
+```
+universal-wallet-wasm/
+├── src/           # Rust source code
+├── tests/         # TypeScript tests
+├── dist/         # Compiled outputs (generated)
+│   ├── node/     # Node.js target
+│   └── esm/      # ESM target
+└── Cargo.toml    # Rust dependencies
+└── package.json  # NPM package configuration
 ```
+
+### Making Changes
+
+1. Edit Rust code in `src/lib.rs`
+2. Run `pnpm build` to compile
+3. Add tests in `tests/` directory
+4. Run `pnpm test` to verify changes

package/dist/esm/wallet_wasm.d.ts

@@ -1,13 +1,26 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
+* Well-known ids of types utilized in the rollup.
 */
 export enum KnownTypeId {
+/**
+* The type id of the transaction.
+*/
   Transaction = 0,
+/**
+* The type id of the unsigned transaction.
+*/
   UnsignedTransaction = 1,
+/**
+* The type id of the runtime call.
+*/
   RuntimeCall = 2,
 }
 /**
+* A rollup schema is a description of the types that are utilized in the rollup.
+* It is used to serialize and deserialize the types.
+* As well as display them in a human-readable way that is verified by the rollup.
 */
 export class Schema {
   free(): void;
@@ -37,4 +50,8 @@ export class Schema {
 * @returns {number}
 */
   knownTypeIndex(known_type_id: KnownTypeId): number;
+/**
+* Returns the JSON descriptor that was used to create this schema instance.
+*/
+  readonly descriptor: string;
 }

package/dist/esm/wallet_wasm_bg.js

@@ -132,13 +132,29 @@ function passArray8ToWasm0(arg, malloc) {
     return ptr;
 }
 /**
+* Well-known ids of types utilized in the rollup.
 */
-export const KnownTypeId = Object.freeze({ Transaction:0,"0":"Transaction",UnsignedTransaction:1,"1":"UnsignedTransaction",RuntimeCall:2,"2":"RuntimeCall", });
+export const KnownTypeId = Object.freeze({
+/**
+* The type id of the transaction.
+*/
+Transaction:0,"0":"Transaction",
+/**
+* The type id of the unsigned transaction.
+*/
+UnsignedTransaction:1,"1":"UnsignedTransaction",
+/**
+* The type id of the runtime call.
+*/
+RuntimeCall:2,"2":"RuntimeCall", });
 
 const SchemaFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_schema_free(ptr >>> 0, 1));
 /**
+* A rollup schema is a description of the types that are utilized in the rollup.
+* It is used to serialize and deserialize the types.
+* As well as display them in a human-readable way that is verified by the rollup.
 */
 export class Schema {
 
@@ -184,6 +200,26 @@ export class Schema {
         }
     }
     /**
+    * Returns the JSON descriptor that was used to create this schema instance.
+    * @returns {string}
+    */
+    get descriptor() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.schema_descriptor(retptr, this.__wbg_ptr);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            deferred1_0 = r0;
+            deferred1_1 = r1;
+            return getStringFromWasm0(r0, r1);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
     * Converts the provided JSON to borsh according to the provided schema.
     * @param {number} type_index
     * @param {string} input

package/dist/esm/wallet_wasm_bg.wasm.d.ts

@@ -3,6 +3,7 @@
 export const memory: WebAssembly.Memory;
 export function __wbg_schema_free(a: number, b: number): void;
 export function schema_fromJSON(a: number, b: number, c: number): void;
+export function schema_descriptor(a: number, b: number): void;
 export function schema_jsonToBorsh(a: number, b: number, c: number, d: number, e: number): void;
 export function schema_display(a: number, b: number, c: number, d: number, e: number): void;
 export function schema_knownTypeIndex(a: number, b: number, c: number): void;

package/dist/node/README.md

@@ -1,19 +1,76 @@
 # @sovereign-sdk/universal-wallet-wasm
 
-To install dependencies:
+[![npm version](https://img.shields.io/npm/v/@sovereign-sdk/universal-wallet-wasm.svg)](https://www.npmjs.com/package/@sovereign-sdk/universal-wallet-wasm)
+[![CI](https://github.com/Sovereign-Labs/sovereign-sdk-web3-js/actions/workflows/ci.yaml/badge.svg)](https://github.com/Sovereign-Labs/sovereign-sdk-web3-js/actions/workflows/ci.yaml)
+
+WebAssembly bindings for Sovereign SDK's universal wallet, providing schema validation and serialization utilities.
+
+## Installation
 
 ```bash
-pnpm install
+npm install @sovereign-sdk/universal-wallet-wasm
 ```
 
-Compile to wasm and build JavaScript packages:
+## Features
 
-```bash
-pnpm run build
+- 🔄 JSON to Borsh serialization of rollup types
+- 📝 Schema validation
+- 📄 Human-readable display of Borsh bytes
+
+## Usage
+
+```typescript
+import { Schema, KnownTypeId } from '@sovereign-sdk/universal-wallet-wasm';
+
+// Initialize schema from JSON outputted during rollup compilation
+const schema = Schema.fromJSON(JSON.stringify(yourSchemaJson));
+
+// Convert JSON to Borsh bytes
+const runtimeCall = { value_setter: { set_many_values: [4, 6] } };
+const borshBytes = schema.jsonToBorsh(
+  schema.knownTypeIndex(KnownTypeId.RuntimeCall),
+  JSON.stringify(runtimeCall)
+);
+
+// Display Borsh bytes as human-readable string
+const displayed = schema.display(
+  schema.knownTypeIndex(KnownTypeId.RuntimeCall),
+  borshBytes
+);
 ```
 
-Run tests (must compile first):
+## Development Guide
 
-```bash
-pnpm run test
+This package uses [wasm-pack](https://rustwasm.github.io/wasm-pack/) to compile Rust code to WebAssembly and generate JavaScript bindings.
+
+### Prerequisites
+
+1. Install Rust (version 1.79 or later)
+2. Install Node.js dependencies: `pnpm install`
+
+### Build Commands
+
+- `pnpm build` - Builds both Node.js and ESM targets
+- `pnpm compile:node` - Builds Node.js target only
+- `pnpm compile:esm` - Builds ESM target only
+- `pnpm test` - Runs tests
+
+### Project Structure
+
+```
+universal-wallet-wasm/
+├── src/           # Rust source code
+├── tests/         # TypeScript tests
+├── dist/         # Compiled outputs (generated)
+│   ├── node/     # Node.js target
+│   └── esm/      # ESM target
+└── Cargo.toml    # Rust dependencies
+└── package.json  # NPM package configuration
 ```
+
+### Making Changes
+
+1. Edit Rust code in `src/lib.rs`
+2. Run `pnpm build` to compile
+3. Add tests in `tests/` directory
+4. Run `pnpm test` to verify changes

package/dist/node/wallet_wasm.d.ts

@@ -1,13 +1,26 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
+* Well-known ids of types utilized in the rollup.
 */
 export enum KnownTypeId {
+/**
+* The type id of the transaction.
+*/
   Transaction = 0,
+/**
+* The type id of the unsigned transaction.
+*/
   UnsignedTransaction = 1,
+/**
+* The type id of the runtime call.
+*/
   RuntimeCall = 2,
 }
 /**
+* A rollup schema is a description of the types that are utilized in the rollup.
+* It is used to serialize and deserialize the types.
+* As well as display them in a human-readable way that is verified by the rollup.
 */
 export class Schema {
   free(): void;
@@ -37,4 +50,8 @@ export class Schema {
 * @returns {number}
 */
   knownTypeIndex(known_type_id: KnownTypeId): number;
+/**
+* Returns the JSON descriptor that was used to create this schema instance.
+*/
+  readonly descriptor: string;
 }

package/dist/node/wallet_wasm.js

@@ -128,13 +128,29 @@ function passArray8ToWasm0(arg, malloc) {
     return ptr;
 }
 /**
+* Well-known ids of types utilized in the rollup.
 */
-module.exports.KnownTypeId = Object.freeze({ Transaction:0,"0":"Transaction",UnsignedTransaction:1,"1":"UnsignedTransaction",RuntimeCall:2,"2":"RuntimeCall", });
+module.exports.KnownTypeId = Object.freeze({
+/**
+* The type id of the transaction.
+*/
+Transaction:0,"0":"Transaction",
+/**
+* The type id of the unsigned transaction.
+*/
+UnsignedTransaction:1,"1":"UnsignedTransaction",
+/**
+* The type id of the runtime call.
+*/
+RuntimeCall:2,"2":"RuntimeCall", });
 
 const SchemaFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_schema_free(ptr >>> 0, 1));
 /**
+* A rollup schema is a description of the types that are utilized in the rollup.
+* It is used to serialize and deserialize the types.
+* As well as display them in a human-readable way that is verified by the rollup.
 */
 class Schema {
 
@@ -180,6 +196,26 @@ class Schema {
         }
     }
     /**
+    * Returns the JSON descriptor that was used to create this schema instance.
+    * @returns {string}
+    */
+    get descriptor() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.schema_descriptor(retptr, this.__wbg_ptr);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            deferred1_0 = r0;
+            deferred1_1 = r1;
+            return getStringFromWasm0(r0, r1);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
     * Converts the provided JSON to borsh according to the provided schema.
     * @param {number} type_index
     * @param {string} input

package/dist/node/wallet_wasm_bg.wasm.d.ts

@@ -3,6 +3,7 @@
 export const memory: WebAssembly.Memory;
 export function __wbg_schema_free(a: number, b: number): void;
 export function schema_fromJSON(a: number, b: number, c: number): void;
+export function schema_descriptor(a: number, b: number): void;
 export function schema_jsonToBorsh(a: number, b: number, c: number, d: number, e: number): void;
 export function schema_display(a: number, b: number, c: number, d: number, e: number): void;
 export function schema_knownTypeIndex(a: number, b: number, c: number): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sovereign-sdk/universal-wallet-wasm",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "files": [
     "dist/**/*",
     "!dist/**/.gitignore",