@bubolabs/wallet-wasm 0.1.0

package/README.md

@@ -0,0 +1,103 @@
+# @bubolabs/wallet-wasm
+
+Browser WASM package for the bubo wallet offline chain adapters.
+
+This package is intentionally separate from `@bubolabs/wallet-rn-sdk`.
+The chain implementation is shared in Rust, while this package only owns the
+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 `wasm-pack`, then run from this package directory:
+
+```bash
+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.
+
+## Usage
+
+```js
+import {
+  init,
+  aptos,
+  btc,
+  cardano,
+  cosmos,
+  dogecoin,
+  eth,
+  near,
+  polkadot,
+  solana,
+  starknet,
+  stellar,
+  sui,
+  ton,
+  tron,
+  xrpl,
+} from "@bubolabs/wallet-wasm";
+
+await init();
+
+const mnemonic =
+  "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
+const wallet = eth.deriveWallet({
+  mnemonic,
+});
+
+const supported = eth.verifyMessageSignature({
+  message: "hello",
+  address: wallet.address,
+  signatureHex: "0x...",
+});
+
+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 });
+```
+
+## Boundary
+
+- In scope: offline derivation, signing, transaction payload helpers, and
+  inspection helpers exposed by the shared Rust adapters.
+- Out of scope: RPC reads, transaction broadcast, online dApp/session
+  orchestration.
+- RN native packaging remains in `packages/rn-sdk` and is not affected by this
+  package.

package/index.d.ts

@@ -0,0 +1,289 @@
+export type SupportedChainInfo = {
+  chainId: string;
+  capabilities: string[];
+};
+
+export type ChainExtensionInfo = {
+  chainId: string;
+  methods: string[];
+};
+
+export type DerivedWallet = {
+  address: string;
+  privateKey: string;
+  privateKeyEncoding: string;
+  publicKey: string;
+  publicKeyEncoding: string;
+};
+
+export type TextEncoding = "utf8" | "text" | "hex" | "base64";
+export type PrivateKeyEncoding = "hex" | "base64" | "utf8" | "text";
+export type TonMnemonicType = "ton" | "bip39" | "bip-39";
+export type DogecoinNetwork = "mainnet" | "testnet";
+
+export type DeriveRequest = {
+  chainId: string;
+  mnemonic: string;
+  account?: number;
+  index?: number;
+  passphrase?: string | null;
+};
+
+export type PrivateKeyRequest = {
+  chainId: string;
+  privateKey: string;
+  privateKeyEncoding?: PrivateKeyEncoding;
+};
+
+export type BuildAndSignRequest = {
+  chainId: string;
+  mnemonic: string;
+  txPayload: string;
+};
+
+export type BuildAndSignFromPrivateKeyRequest = {
+  chainId: string;
+  privateKey: string;
+  privateKeyEncoding?: PrivateKeyEncoding;
+  txPayload: string;
+};
+
+export type SignMessageRequest = {
+  chainId: string;
+  mnemonic: string;
+  message: string;
+  messageEncoding?: TextEncoding;
+  account?: number;
+  index?: number;
+  passphrase?: string | null;
+  mode?: string | null;
+};
+
+export type SignMessageFromPrivateKeyRequest = {
+  chainId: string;
+  privateKey: string;
+  privateKeyEncoding?: PrivateKeyEncoding;
+  message: string;
+  messageEncoding?: TextEncoding;
+  mode?: string | null;
+};
+
+export type SignBytesRequest = {
+  chainId: string;
+  mnemonic: string;
+  bytes: string;
+  bytesEncoding?: "base64" | "hex" | "utf8" | "text";
+  account?: number;
+  index?: number;
+  passphrase?: string | null;
+};
+
+export type SignBytesFromPrivateKeyRequest = {
+  chainId: string;
+  privateKey: string;
+  privateKeyEncoding?: PrivateKeyEncoding;
+  bytes: string;
+  bytesEncoding?: "base64" | "hex" | "utf8" | "text";
+};
+
+export type SignTypedDataRequest = {
+  chainId: string;
+  mnemonic: string;
+  typedData: string;
+  typedDataEncoding?: TextEncoding;
+  account?: number;
+  index?: number;
+  passphrase?: string | null;
+};
+
+export type SignTypedDataFromPrivateKeyRequest = {
+  chainId: string;
+  privateKey: string;
+  privateKeyEncoding?: PrivateKeyEncoding;
+  typedData: string;
+  typedDataEncoding?: TextEncoding;
+};
+
+export type TonAddressFormat = {
+  encoding?: "user-friendly" | "raw";
+  bounceable?: boolean | null;
+  testOnly?: boolean;
+  urlSafe?: boolean;
+};
+
+export type TonDeriveRequest = Omit<DeriveRequest, "chainId"> & {
+  mnemonicType?: TonMnemonicType;
+  derivationPath?: string | null;
+  walletVersion?: "v4r2" | "v5r1";
+  addressFormat?: TonAddressFormat;
+};
+
+export type TonPrivateKeyRequest = Omit<PrivateKeyRequest, "chainId"> & {
+  keyEncoding?: PrivateKeyEncoding;
+  walletVersion?: "v4r2" | "v5r1";
+  addressFormat?: TonAddressFormat;
+};
+
+export type TonBuildAndSignRequest = Omit<BuildAndSignRequest, "chainId" | "txPayload"> & {
+  txPayload: string | unknown;
+  mnemonicType?: TonMnemonicType;
+  derivationPath?: string | null;
+};
+
+export type DogecoinDeriveRequest = Omit<DeriveRequest, "chainId"> & {
+  network?: DogecoinNetwork;
+};
+
+export type DogecoinPrivateKeyRequest = Omit<PrivateKeyRequest, "chainId"> & {
+  keyEncoding?: PrivateKeyEncoding | "wif";
+  network?: DogecoinNetwork;
+};
+
+export class WalletWasmError extends Error {
+  code: string;
+  details: string | null;
+}
+
+export function init(): Promise<void>;
+export function listSupportedChains(): SupportedChainInfo[];
+export function listChainExtensions(): ChainExtensionInfo[];
+export function invokeChainExtension(chainId: string, method: string, payload?: unknown): string;
+export function deriveAddress(request: DeriveRequest): string;
+export function deriveWallet(request: DeriveRequest): DerivedWallet;
+export function deriveAddressFromPrivateKey(request: PrivateKeyRequest): string;
+export function deriveWalletFromPrivateKey(request: PrivateKeyRequest): DerivedWallet;
+export function buildAndSign(request: BuildAndSignRequest): Uint8Array;
+export function buildAndSignFromPrivateKey(request: BuildAndSignFromPrivateKeyRequest): Uint8Array;
+export function signMessage(request: SignMessageRequest): Uint8Array;
+export function signMessageFromPrivateKey(request: SignMessageFromPrivateKeyRequest): Uint8Array;
+export function signBytes(request: SignBytesRequest): Uint8Array;
+export function signBytesFromPrivateKey(request: SignBytesFromPrivateKeyRequest): Uint8Array;
+export function signTypedData(request: SignTypedDataRequest): Uint8Array;
+export function signTypedDataFromPrivateKey(request: SignTypedDataFromPrivateKeyRequest): Uint8Array;
+
+export type DeriveNamespace = {
+  deriveAddress(request: Omit<DeriveRequest, "chainId">): string;
+  deriveWallet(request: Omit<DeriveRequest, "chainId">): DerivedWallet;
+  deriveAddressFromPrivateKey(request: Omit<PrivateKeyRequest, "chainId">): string;
+  deriveWalletFromPrivateKey(request: Omit<PrivateKeyRequest, "chainId">): DerivedWallet;
+};
+
+export type BuildAndSignNamespace = {
+  buildAndSign(request: Omit<BuildAndSignRequest, "chainId">): Uint8Array;
+  buildAndSignFromPrivateKey(request: Omit<BuildAndSignFromPrivateKeyRequest, "chainId">): Uint8Array;
+};
+
+export type SignMessageNamespace = {
+  signMessage(request: Omit<SignMessageRequest, "chainId">): Uint8Array;
+  signMessageFromPrivateKey(request: Omit<SignMessageFromPrivateKeyRequest, "chainId">): Uint8Array;
+};
+
+export type SignBytesNamespace = {
+  signBytes(request: Omit<SignBytesRequest, "chainId">): Uint8Array;
+  signBytesFromPrivateKey(request: Omit<SignBytesFromPrivateKeyRequest, "chainId">): Uint8Array;
+};
+
+export type SignTypedDataNamespace = {
+  signTypedData(request: Omit<SignTypedDataRequest, "chainId">): Uint8Array;
+  signTypedDataFromPrivateKey(request: Omit<SignTypedDataFromPrivateKeyRequest, "chainId">): Uint8Array;
+};
+
+export type JsonTxNamespace = {
+  buildTx(payload: unknown): unknown;
+  signTx(payload: unknown): unknown;
+  inspectSignedTx(payload: unknown): unknown;
+  decodeSignedTx(payload: unknown): unknown;
+};
+
+export const eth: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignTypedDataNamespace & {
+  buildTx(payload: unknown): string;
+  signTx(payload: unknown): string;
+  decodeSignedTx(payload: unknown): unknown;
+  ecrecover(payload: unknown): unknown;
+  recoverTypedDataSigner(payload: unknown): unknown;
+  verifyMessageSignature(payload: unknown): unknown;
+  verifyTypedDataSignature(payload: unknown): unknown;
+  buildEip1271IsValidSignatureCall(payload: unknown): unknown;
+  verifyEip1271IsValidSignatureResult(payload: unknown): unknown;
+  computeUserOperationHash(payload: unknown): unknown;
+  signUserOperation(payload: unknown): unknown;
+  recoverUserOperationSigner(payload: unknown): unknown;
+};
+
+export const btc: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & {
+  deriveAccountXpub(payload: unknown): unknown;
+  deriveAddressFromXpub(payload: unknown): unknown;
+  buildTx(payload: unknown): unknown;
+  signTx(payload: unknown): unknown;
+  buildPsbt(payload: unknown): unknown;
+  signPsbt(payload: unknown): unknown;
+  signPsbtWithSigners(payload: unknown): unknown;
+  partialSignPsbt(payload: unknown): unknown;
+  verifyPsbtFinalized(payload: unknown): unknown;
+  inspectPsbt(payload: unknown): unknown;
+  decodeSignedTx(payload: unknown): unknown;
+  verifyMessage(payload: unknown): unknown;
+  frostTrustedDealerKeygen(payload: unknown): unknown;
+  frostDkgRound1(payload: unknown): unknown;
+  frostDkgRound2(payload: unknown): unknown;
+  frostDkgFinalize(payload: unknown): unknown;
+  frostRound1Commit(payload: unknown): unknown;
+  frostBuildSigningPackage(payload: unknown): unknown;
+  frostRound2SignShare(payload: unknown): unknown;
+  frostAggregateSignature(payload: unknown): unknown;
+  frostTaprootComputeTweak(payload: unknown): unknown;
+  frostVerifySignatureShare(payload: unknown): unknown;
+  frostBuildTaprootPsbtSigningInputs(payload: unknown): unknown;
+  frostFinalizeTaprootPsbt(payload: unknown): unknown;
+  frostNonceSessionScope(payload: unknown): unknown;
+  frostResetNonceGuard(payload: unknown): unknown;
+};
+
+export const solana: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & {
+  buildTx(payload: unknown): string;
+  signTx(payload: unknown): string;
+  inspectSignedTx(payload: unknown): unknown;
+  decodeSignedTx(payload: unknown): unknown;
+  verifyMessageSignature(payload: unknown): unknown;
+  verifyBytesSignature(payload: unknown): unknown;
+};
+
+export const ton: {
+  deriveAddress(request: TonDeriveRequest): string;
+  deriveWallet(request: TonDeriveRequest): DerivedWallet;
+  deriveAddressFromPrivateKey(request: TonPrivateKeyRequest): string;
+  deriveWalletFromPrivateKey(request: TonPrivateKeyRequest): DerivedWallet;
+  buildAndSign(request: TonBuildAndSignRequest): Uint8Array;
+  buildAndSignFromPrivateKey(request: Omit<BuildAndSignFromPrivateKeyRequest, "chainId" | "txPayload"> & { txPayload: string | unknown }): Uint8Array;
+  buildWalletStateInit(payload: unknown): unknown;
+  buildWalletStateInitFromPrivateKey(payload: unknown): unknown;
+  buildTx(payload: unknown): unknown;
+  signTx(payload: unknown): unknown;
+  inspectSignedTx(payload: unknown): unknown;
+  decodeSignedTx(payload: unknown): unknown;
+};
+
+export const tron: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & {
+  buildTx(payload: unknown): unknown;
+  signTx(payload: unknown): unknown;
+  inspectSignedTx(payload: unknown): unknown;
+  decodeSignedTx(payload: unknown): unknown;
+};
+
+export const near: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace;
+export const cosmos: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace;
+export const cardano: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace;
+export const aptos: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace;
+export const polkadot: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace;
+export const dogecoin: BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace & {
+  deriveAddress(request: DogecoinDeriveRequest): string;
+  deriveWallet(request: DogecoinDeriveRequest): DerivedWallet;
+  deriveAddressFromPrivateKey(request: DogecoinPrivateKeyRequest): string;
+  deriveWalletFromPrivateKey(request: DogecoinPrivateKeyRequest): DerivedWallet;
+};
+export const starknet: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace & {
+  computeAccountAddress(payload: unknown): unknown;
+};
+export const stellar: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace;
+export const sui: DeriveNamespace & BuildAndSignNamespace & SignMessageNamespace & SignBytesNamespace & JsonTxNamespace;
+export const xrpl: DeriveNamespace & BuildAndSignNamespace & JsonTxNamespace;