@miden-sdk/miden-wallet-adapter-base 0.13.0

package/docs/interfaces/WalletAdapterProps.md

@@ -0,0 +1,106 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletAdapterProps
+
+# Interface: WalletAdapterProps\<Name\>
+
+## Extended by
+
+- [`SignerWalletAdapterProps`](SignerWalletAdapterProps.md)
+- [`MessageSignerWalletAdapterProps`](MessageSignerWalletAdapterProps.md)
+
+## Type Parameters
+
+### Name
+
+`Name` *extends* `string` = `string`
+
+## Properties
+
+### address
+
+> **address**: `string`
+
+***
+
+### connected
+
+> **connected**: `boolean`
+
+***
+
+### connecting
+
+> **connecting**: `boolean`
+
+***
+
+### icon
+
+> **icon**: `string`
+
+***
+
+### name
+
+> **name**: [`WalletName`](../type-aliases/WalletName.md)\<`Name`\>
+
+***
+
+### publicKey
+
+> **publicKey**: `Uint8Array`\<`ArrayBufferLike`\>
+
+***
+
+### readyState
+
+> **readyState**: [`WalletReadyState`](../enumerations/WalletReadyState.md)
+
+***
+
+### supportedTransactionVersions
+
+> **supportedTransactionVersions**: `ReadonlySet`
+
+***
+
+### url
+
+> **url**: `string`
+
+## Methods
+
+### connect()
+
+> **connect**(`privateDataPermission`, `network`, `allowedPrivateData?`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### privateDataPermission
+
+[`PrivateDataPermission`](../enumerations/PrivateDataPermission.md)
+
+##### network
+
+[`WalletAdapterNetwork`](../enumerations/WalletAdapterNetwork.md)
+
+##### allowedPrivateData?
+
+[`AllowedPrivateData`](../enumerations/AllowedPrivateData.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### disconnect()
+
+> **disconnect**(): `Promise`\<`void`\>
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/interfaces/WalletTransactionSuccessOutput.md

@@ -0,0 +1,19 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletTransactionSuccessOutput
+
+# Interface: WalletTransactionSuccessOutput
+
+## Properties
+
+### outputNotes
+
+> **outputNotes**: `string`[]
+
+***
+
+### txHash
+
+> **txHash**: `string`

package/docs/type-aliases/Adapter.md

@@ -0,0 +1,9 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / Adapter
+
+# Type Alias: Adapter
+
+> **Adapter** = [`WalletAdapter`](WalletAdapter.md) \| [`SignerWalletAdapter`](SignerWalletAdapter.md) \| [`MessageSignerWalletAdapter`](MessageSignerWalletAdapter.md)

package/docs/type-aliases/FungibleAssetDetails.md

@@ -0,0 +1,21 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / FungibleAssetDetails
+
+# Type Alias: FungibleAssetDetails
+
+> **FungibleAssetDetails** = `object`
+
+## Properties
+
+### amount
+
+> **amount**: `string`
+
+***
+
+### faucetId
+
+> **faucetId**: `string`

package/docs/type-aliases/InputNoteDetails.md

@@ -0,0 +1,45 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / InputNoteDetails
+
+# Type Alias: InputNoteDetails
+
+> **InputNoteDetails** = `object`
+
+## Properties
+
+### assets
+
+> **assets**: [`FungibleAssetDetails`](FungibleAssetDetails.md)[]
+
+***
+
+### noteId
+
+> **noteId**: `string`
+
+***
+
+### noteType
+
+> **noteType**: `NoteType` \| `undefined`
+
+***
+
+### nullifier
+
+> **nullifier**: `string`
+
+***
+
+### senderAccountId
+
+> **senderAccountId**: `string` \| `undefined`
+
+***
+
+### state
+
+> **state**: `InputNoteState`

package/docs/type-aliases/MessageSignerWalletAdapter.md

@@ -0,0 +1,15 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / MessageSignerWalletAdapter
+
+# Type Alias: MessageSignerWalletAdapter\<Name\>
+
+> **MessageSignerWalletAdapter**\<`Name`\> = [`WalletAdapter`](WalletAdapter.md)\<`Name`\> & [`MessageSignerWalletAdapterProps`](../interfaces/MessageSignerWalletAdapterProps.md)\<`Name`\>
+
+## Type Parameters
+
+### Name
+
+`Name` *extends* `string` = `string`

package/docs/type-aliases/NoteTypeString.md

@@ -0,0 +1,9 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / NoteTypeString
+
+# Type Alias: NoteTypeString
+
+> **NoteTypeString** = `"public"` \| `"private"`

package/docs/type-aliases/SignKind.md

@@ -0,0 +1,9 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / SignKind
+
+# Type Alias: SignKind
+
+> **SignKind** = `"word"` \| `"signingInputs"`

package/docs/type-aliases/SignerWalletAdapter.md

@@ -0,0 +1,15 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / SignerWalletAdapter
+
+# Type Alias: SignerWalletAdapter\<Name\>
+
+> **SignerWalletAdapter**\<`Name`\> = [`WalletAdapter`](WalletAdapter.md)\<`Name`\> & [`SignerWalletAdapterProps`](../interfaces/SignerWalletAdapterProps.md)\<`Name`\>
+
+## Type Parameters
+
+### Name
+
+`Name` *extends* `string` = `string`

package/docs/type-aliases/SupportedTransactionVersions.md

@@ -0,0 +1,9 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / SupportedTransactionVersions
+
+# Type Alias: SupportedTransactionVersions
+
+> **SupportedTransactionVersions** = `ReadonlySet`\<`any`\> \| `null`

package/docs/type-aliases/TransactionOrVersionedTransaction.md

@@ -0,0 +1,15 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / TransactionOrVersionedTransaction
+
+# Type Alias: TransactionOrVersionedTransaction\<S\>
+
+> **TransactionOrVersionedTransaction**\<`S`\> = `S` *extends* `null` ? `any` : `any` \| `any`
+
+## Type Parameters
+
+### S
+
+`S` *extends* [`SupportedTransactionVersions`](SupportedTransactionVersions.md)

package/docs/type-aliases/TransactionPayload.md

@@ -0,0 +1,9 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / TransactionPayload
+
+# Type Alias: TransactionPayload
+
+> **TransactionPayload** = [`MidenSendTransaction`](../interfaces/MidenSendTransaction.md) \| [`MidenConsumeTransaction`](../interfaces/MidenConsumeTransaction.md) \| [`MidenCustomTransaction`](../interfaces/MidenCustomTransaction.md)

package/docs/type-aliases/WalletAdapter.md

@@ -0,0 +1,15 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletAdapter
+
+# Type Alias: WalletAdapter\<Name\>
+
+> **WalletAdapter**\<`Name`\> = [`WalletAdapterProps`](../interfaces/WalletAdapterProps.md)\<`Name`\> & [`EventEmitter`](../classes/EventEmitter.md)\<[`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)\>
+
+## Type Parameters
+
+### Name
+
+`Name` *extends* `string` = `string`

package/docs/type-aliases/WalletName.md

@@ -0,0 +1,21 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletName
+
+# Type Alias: WalletName\<T\>
+
+> **WalletName**\<`T`\> = `T` & `object`
+
+## Type declaration
+
+### \_\_brand\_\_
+
+> **\_\_brand\_\_**: `"WalletName"`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `string` = `string`

package/docs/type-aliases/WalletTransactionOutput.md

@@ -0,0 +1,9 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletTransactionOutput
+
+# Type Alias: WalletTransactionOutput
+
+> **WalletTransactionOutput** = [`WalletTransactionSuccessOutput`](../interfaces/WalletTransactionSuccessOutput.md) \| [`IFailedTransactionOutput`](../interfaces/IFailedTransactionOutput.md)

package/errors.ts

@@ -0,0 +1,97 @@
+export class WalletError extends Error {
+    error: any;
+
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    constructor(message?: string, error?: any) {
+        super(message);
+        this.error = error;
+    }
+}
+
+export class WalletNotReadyError extends WalletError {
+    name = 'WalletNotReadyError';
+}
+
+export class WalletLoadError extends WalletError {
+    name = 'WalletLoadError';
+}
+
+export class WalletConfigError extends WalletError {
+    name = 'WalletConfigError';
+}
+
+export class WalletConnectionError extends WalletError {
+    name = 'WalletConnectionError';
+}
+
+export class WalletNotSelectedError extends WalletError {
+    name = 'WalletNotSelectedError';
+}
+
+export class WalletDisconnectedError extends WalletError {
+    name = 'WalletDisconnectedError';
+}
+
+export class WalletDisconnectionError extends WalletError {
+    name = 'WalletDisconnectionError';
+}
+
+export class WalletAccountError extends WalletError {
+    name = 'WalletAccountError';
+}
+
+export class WalletAddressError extends WalletError {
+    name = 'WalletAddressError';
+}
+
+export class WalletKeypairError extends WalletError {
+    name = 'WalletKeypairError';
+}
+
+export class WalletNotConnectedError extends WalletError {
+    name = 'WalletNotConnectedError';
+}
+
+export class WalletSendTransactionError extends WalletError {
+    name = 'WalletSendTransactionError';
+}
+
+export class WalletSignMessageError extends WalletError {
+    name = 'WalletSignMessageError';
+}
+
+export class WalletSignTransactionError extends WalletError {
+    name = 'WalletSignTransactionError';
+}
+
+export class WalletTimeoutError extends WalletError {
+    name = 'WalletTimeoutError';
+}
+
+export class WalletWindowBlockedError extends WalletError {
+    name = 'WalletWindowBlockedError';
+}
+
+export class WalletWindowClosedError extends WalletError {
+    name = 'WalletWindowClosedError';
+}
+
+export class WalletDecryptionNotAllowedError extends WalletError {
+    name = 'WalletDecryptionNotAllowedError';
+}
+
+export class WalletPrivateDataPermissionError extends WalletError {
+    name = 'WalletPrivateDataPermissionError';
+}
+
+export class WalletDecryptionError extends WalletError {
+    name = 'WalletDecryptionError';
+}
+
+export class WalletRecordsError extends WalletError {
+    name = 'WalletRecordsError';
+}
+
+export class WalletTransactionError extends WalletError {
+    name = 'WalletTransactionError';
+}

package/helpers.ts

@@ -0,0 +1,28 @@
+// Encode a Uint8Array to base64
+export function u8ToB64(u8: Uint8Array): string {
+  // Prefer browser builtins (no polyfills)
+  if (typeof globalThis.btoa === 'function') {
+    let s = '';
+    for (let i = 0; i < u8.length; i++) s += String.fromCharCode(u8[i]);
+    return globalThis.btoa(s);
+  }
+  // Node/Buffer fallback (won’t be bundled if never executed in browsers)
+  const Buf: any = (globalThis as any).Buffer;
+  if (Buf) return Buf.from(u8).toString('base64');
+  throw new Error('No base64 encoder available in this environment');
+}
+
+// Decode base64 to Uint8Array
+export function b64ToU8(b64: string): Uint8Array {
+  // Prefer browser builtins (no polyfills)
+  if (typeof globalThis.atob === 'function') {
+    const bin = globalThis.atob(b64);
+    const out = new Uint8Array(bin.length);
+    for (let i = 0; i < bin.length; i++) out[i] = bin.charCodeAt(i);
+    return out;
+  }
+  // Node/Buffer fallback (won’t be bundled if never executed in browsers)
+  const Buf: any = (globalThis as any).Buffer;
+  if (Buf) return new Uint8Array(Buf.from(b64, 'base64'));
+  throw new Error('No base64 decoder available in this environment');
+}

package/index.ts

@@ -0,0 +1,6 @@
+export * from './adapter';
+export * from './errors';
+export * from './signer';
+export * from './types';
+export * from './transaction';
+export * from './helpers';

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@miden-sdk/miden-wallet-adapter-base",
+  "version": "0.13.0",
+  "description": "Core infrastructure for connecting Miden-compatible wallets to your dApp.",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist/ node_modules/",
+    "doc": "typedoc --disableSources --tsconfig ./tsconfig.json --plugin typedoc-plugin-markdown --entryPoints index.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/demox-labs/miden-wallet-adapter.git"
+  },
+  "author": "Demox Labs",
+  "license": "MIT",
+  "dependencies": {
+    "eventemitter3": "^5.0.1"
+  }
+}

package/signer.ts

@@ -0,0 +1,71 @@
+import type { NoteFilterTypes } from '@miden-sdk/miden-sdk';
+import type { WalletAdapter, WalletAdapterProps } from './adapter';
+import { BaseWalletAdapter } from './adapter';
+import {
+  MidenConsumeTransaction,
+  MidenSendTransaction,
+  MidenTransaction,
+} from './transaction';
+import { Asset, InputNoteDetails, SignKind, TransactionOutput } from './types';
+
+export type Adapter =
+  | WalletAdapter
+  | SignerWalletAdapter
+  | MessageSignerWalletAdapter;
+
+export interface SignerWalletAdapterProps<Name extends string = string>
+  extends WalletAdapterProps<Name> {}
+
+export type SignerWalletAdapter<Name extends string = string> =
+  WalletAdapter<Name> & SignerWalletAdapterProps<Name>;
+
+export abstract class BaseSignerWalletAdapter<Name extends string = string>
+  extends BaseWalletAdapter<Name>
+  implements SignerWalletAdapter<Name> {}
+
+export interface MessageSignerWalletAdapterProps<Name extends string = string>
+  extends WalletAdapterProps<Name> {
+  requestTransaction(transaction: MidenTransaction): Promise<string>;
+  requestAssets(): Promise<Asset[]>;
+  requestPrivateNotes(
+    noteFilterType: NoteFilterTypes,
+    noteIds?: string[]
+  ): Promise<InputNoteDetails[]>;
+  signBytes(data: Uint8Array, kind: SignKind): Promise<Uint8Array>;
+  importPrivateNote(note: Uint8Array): Promise<string>;
+  requestConsumableNotes(): Promise<InputNoteDetails[]>;
+  waitForTransaction(
+    txId: string,
+    timeout?: number
+  ): Promise<TransactionOutput>;
+  requestSend(transaction: MidenSendTransaction): Promise<string>;
+  requestConsume(transaction: MidenConsumeTransaction): Promise<string>;
+}
+
+export type MessageSignerWalletAdapter<Name extends string = string> =
+  WalletAdapter<Name> & MessageSignerWalletAdapterProps<Name>;
+
+export abstract class BaseMessageSignerWalletAdapter<
+    Name extends string = string
+  >
+  extends BaseSignerWalletAdapter<Name>
+  implements MessageSignerWalletAdapter<Name>
+{
+  abstract requestSend(transaction: MidenSendTransaction): Promise<string>;
+  abstract requestConsume(
+    transaction: MidenConsumeTransaction
+  ): Promise<string>;
+  abstract requestTransaction(transaction: MidenTransaction): Promise<string>;
+  abstract requestAssets(): Promise<Asset[]>;
+  abstract requestPrivateNotes(
+    noteFilterType: NoteFilterTypes,
+    noteIds?: string[]
+  ): Promise<InputNoteDetails[]>;
+  abstract signBytes(data: Uint8Array, kind: SignKind): Promise<Uint8Array>;
+  abstract importPrivateNote(note: Uint8Array): Promise<string>;
+  abstract requestConsumableNotes(): Promise<InputNoteDetails[]>;
+  abstract waitForTransaction(
+    txId: string,
+    timeout?: number
+  ): Promise<TransactionOutput>;
+}