@bubolabs/wallet-wasm 0.1.0 → 0.1.1

package/README.md

@@ -9,39 +9,63 @@ browser binding and distribution layer.
 Current browser targets: ETH, BTC, Solana, TON, TRON, NEAR, Cosmos,
 Cardano, Aptos, Polkadot, Dogecoin, Starknet, Stellar, Sui, and XRPL.
 
-## Build
+## Install
 
-Install `wasm-pack`, then run from this package directory:
+For a browser app, install the published npm package:
 
 ```bash
-npm run build
+npm install @bubolabs/wallet-wasm
 ```
 
-The build writes generated WASM artifacts to:
-
-- `pkg/` for the core module: all supported browser chains except Cardano
-- `pkg-cardano/` for Cardano
-
-Cardano is packaged as a separate WASM module because upstream
-`cardano-serialization-lib` and Solana's wasm-enabled crates both export a
-`Transaction` class through `wasm-bindgen`, which causes duplicate linker
-symbols when they are placed in one `.wasm` file. The JavaScript wrapper keeps
-one public API and routes Cardano calls to the Cardano module internally.
-BTC support uses the `bitcoin` crate's secp256k1 backend. On macOS, install
-LLVM via Homebrew if Apple's clang cannot compile `wasm32-unknown-unknown`:
+or:
 
 ```bash
-brew install llvm
+yarn add @bubolabs/wallet-wasm
+pnpm add @bubolabs/wallet-wasm
 ```
 
-The package build script automatically uses `/opt/homebrew/opt/llvm/bin/clang`
-or `/usr/local/opt/llvm/bin/clang` when present.
+Consumers do not need to compile Rust or run `wasm-pack`. The published package
+already includes the generated `.wasm` files.
 
 ## Usage
 
+Use the package from a browser bundler that supports WebAssembly assets, such
+as Vite, Webpack, or Rollup.
+
+```js
+import { init, eth, ton, tron } from "@bubolabs/wallet-wasm";
+
+await init();
+
+const mnemonic =
+  "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
+
+const ethWallet = eth.deriveWallet({
+  mnemonic,
+  account: 0,
+  index: 0,
+});
+
+const tonAddress = ton.deriveAddress({
+  mnemonic,
+  account: 0,
+  index: 0,
+  walletVersion: "v5r1",
+});
+
+const tronAddress = tron.deriveAddress({
+  mnemonic,
+  account: 0,
+  index: 0,
+});
+
+console.log({ ethWallet, tonAddress, tronAddress });
+```
+
+All supported chains are exported as namespaces:
+
 ```js
 import {
-  init,
   aptos,
   btc,
   cardano,
@@ -58,39 +82,88 @@ import {
   tron,
   xrpl,
 } from "@bubolabs/wallet-wasm";
+```
 
-await init();
+Most chains support the same core calls where available:
 
-const mnemonic =
-  "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
-const wallet = eth.deriveWallet({
+```js
+const wallet = solana.deriveWallet({ mnemonic, account: 0, index: 0 });
+const signature = solana.signBytes({
   mnemonic,
+  account: 0,
+  index: 0,
+  bytes: "00112233445566778899aabbccddeeff",
+  bytesEncoding: "hex",
 });
+```
 
-const supported = eth.verifyMessageSignature({
-  message: "hello",
-  address: wallet.address,
-  signatureHex: "0x...",
-});
+## Build From Source
 
-const btcAddress = btc.deriveAddress({ mnemonic });
-const solanaAddress = solana.deriveAddress({ mnemonic });
-const tonAddress = ton.deriveAddress({ mnemonic });
-const tonStateInit = ton.buildWalletStateInit({
-  mnemonic,
-  walletVersion: "v5r1",
-});
-const tronAddress = tron.deriveAddress({ mnemonic });
-const nearAddress = near.deriveAddress({ mnemonic });
-const cosmosAddress = cosmos.deriveAddress({ mnemonic });
-const cardanoAddress = cardano.deriveAddress({ mnemonic });
-const aptosAddress = aptos.deriveAddress({ mnemonic });
-const polkadotAddress = polkadot.deriveAddress({ mnemonic });
-const dogecoinAddress = dogecoin.deriveAddress({ mnemonic });
-const starknetAddress = starknet.deriveAddress({ mnemonic });
-const stellarAddress = stellar.deriveAddress({ mnemonic });
-const suiAddress = sui.deriveAddress({ mnemonic });
-const xrplAddress = xrpl.deriveAddress({ mnemonic });
+Only build from source when developing this repository or changing Rust chain
+code. From `packages/wasm-sdk`:
+
+```bash
+npm install
+npm run build
+```
+
+The build writes generated WASM artifacts to:
+
+- `pkg/` for the core module: all supported browser chains except Cardano
+- `pkg-cardano/` for Cardano
+
+Cardano is packaged as a separate WASM module because upstream
+`cardano-serialization-lib` and Solana's wasm-enabled crates both export a
+`Transaction` class through `wasm-bindgen`, which causes duplicate linker
+symbols when they are placed in one `.wasm` file. The JavaScript wrapper keeps
+one public API and routes Cardano calls to the Cardano module internally.
+BTC support uses the `bitcoin` crate's secp256k1 backend. On macOS, install
+LLVM via Homebrew if Apple's clang cannot compile `wasm32-unknown-unknown`:
+
+```bash
+brew install llvm
+```
+
+The package build script automatically uses `/opt/homebrew/opt/llvm/bin/clang`
+or `/usr/local/opt/llvm/bin/clang` when present.
+
+## Example Project
+
+This repository includes a browser example in `example-wasm`.
+
+For local repository development, the example uses a file dependency:
+
+```json
+{
+  "dependencies": {
+    "@bubolabs/wallet-wasm": "file:../packages/wasm-sdk"
+  }
+}
+```
+
+That lets the example consume the local package output. Build the WASM package
+first, then run the example:
+
+```bash
+cd packages/wasm-sdk
+npm install
+npm run build
+
+cd ../../example-wasm
+npm install
+npm run dev
+```
+
+Open:
+
+```text
+http://127.0.0.1:4180/
+```
+
+In a real app, use the published package instead:
+
+```bash
+npm install @bubolabs/wallet-wasm
 ```
 
 ## Boundary

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bubolabs/wallet-wasm",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Browser WASM SDK for bubo wallet offline chain adapters",
   "type": "module",
   "main": "index.js",