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

package/transaction.ts

@@ -0,0 +1,178 @@
+import type { TransactionRequest } from '@miden-sdk/miden-sdk';
+import { u8ToB64 } from './helpers';
+
+export type NoteTypeString = 'public' | 'private';
+
+export interface MidenSendTransaction {
+  senderAddress: string;
+  recipientAddress: string;
+  faucetId: string;
+  noteType: NoteTypeString;
+  amount: number;
+  recallBlocks?: number;
+}
+
+export class SendTransaction implements MidenSendTransaction {
+  senderAddress: string;
+  recipientAddress: string;
+  faucetId: string;
+  noteType: NoteTypeString;
+  amount: number;
+  recallBlocks?: number;
+
+  constructor(
+    sender: string,
+    recipient: string,
+    faucetId: string,
+    noteType: NoteTypeString,
+    amount: number,
+    recallBlocks?: number
+  ) {
+    this.senderAddress = sender;
+    this.recipientAddress = recipient;
+    this.faucetId = faucetId;
+    this.noteType = noteType;
+    this.amount = amount;
+    this.recallBlocks = recallBlocks;
+  }
+}
+
+export interface MidenConsumeTransaction {
+  faucetId: string;
+  noteId: string;
+  noteType: NoteTypeString;
+  amount: number;
+  noteBytes?: string;
+}
+
+export class ConsumeTransaction implements MidenConsumeTransaction {
+  faucetId: string;
+  noteId: string;
+  noteType: NoteTypeString;
+  amount: number;
+  noteBytes?: string;
+
+  constructor(
+    faucetId: string,
+    noteId: string,
+    noteType: NoteTypeString,
+    amount: number,
+    noteBytes?: Uint8Array
+  ) {
+    this.faucetId = faucetId;
+    this.noteId = noteId;
+    this.noteType = noteType;
+    this.amount = amount;
+    this.noteBytes = noteBytes ? u8ToB64(noteBytes) : undefined;
+  }
+}
+
+export interface MidenCustomTransaction {
+  address: string;
+  recipientAddress: string;
+  transactionRequest: string;
+  inputNoteIds?: string[];
+  importNotes?: string[];
+}
+
+export class CustomTransaction implements MidenCustomTransaction {
+  address: string;
+  recipientAddress: string;
+  transactionRequest: string;
+  inputNoteIds?: string[];
+  importNotes?: string[];
+
+  constructor(
+    address: string,
+    recipientAddress: string,
+    transactionRequest: TransactionRequest,
+    inputNotesIds?: string[],
+    inputNoteBytes?: Uint8Array[]
+  ) {
+    this.address = address;
+    this.recipientAddress = recipientAddress;
+    const requestBytes = transactionRequest.serialize();
+    const base64 = u8ToB64(requestBytes);
+    this.transactionRequest = base64;
+    this.inputNoteIds = inputNotesIds;
+    this.importNotes = inputNoteBytes?.map((note) => u8ToB64(note));
+  }
+}
+
+export enum TransactionType {
+  Send = 'send',
+  Consume = 'consume',
+  Custom = 'custom',
+}
+export type TransactionPayload =
+  | MidenSendTransaction
+  | MidenConsumeTransaction
+  | MidenCustomTransaction;
+
+export interface MidenTransaction {
+  type: TransactionType;
+  payload: TransactionPayload;
+}
+
+export class Transaction implements MidenTransaction {
+  type: TransactionType;
+  payload: TransactionPayload;
+
+  constructor(type: TransactionType, payload: TransactionPayload) {
+    this.type = type;
+    this.payload = payload;
+  }
+
+  static createSendTransaction(
+    sender: string,
+    recipient: string,
+    faucetId: string,
+    noteType: NoteTypeString,
+    amount: number,
+    recallBlocks?: number
+  ) {
+    const sendTransaction = new SendTransaction(
+      sender,
+      recipient,
+      faucetId,
+      noteType,
+      amount,
+      recallBlocks
+    );
+    return new Transaction(TransactionType.Send, sendTransaction);
+  }
+
+  static createConsumeTransaction(
+    faucetId: string,
+    noteId: string,
+    noteType: NoteTypeString,
+    amount: number,
+    noteBytes?: Uint8Array
+  ) {
+    const consumeTransaction = new ConsumeTransaction(
+      faucetId,
+      noteId,
+      noteType,
+      amount,
+      noteBytes
+    );
+    return new Transaction(TransactionType.Consume, consumeTransaction);
+  }
+
+  static createCustomTransaction(
+    address: string,
+    recipientAddress: string,
+    transactionRequest: TransactionRequest,
+    inputNoteIds?: string[],
+    noteBytes?: Uint8Array[]
+  ) {
+    const transactionBytes = new CustomTransaction(
+      address,
+      recipientAddress,
+      transactionRequest,
+      inputNoteIds,
+      noteBytes
+    );
+    return new Transaction(TransactionType.Custom, transactionBytes);
+  }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "declaration": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true
+  },
+  "exclude": ["node_modules", "dist"]
+}

package/types.ts

@@ -0,0 +1,68 @@
+import type { InputNoteState, Note, NoteType } from '@miden-sdk/miden-sdk';
+
+export enum WalletAdapterNetwork {
+  Testnet = 'testnet',
+  Localnet = 'localnet',
+}
+
+export type SupportedTransactionVersions = ReadonlySet<any> | null;
+
+export type TransactionOrVersionedTransaction<
+  S extends SupportedTransactionVersions
+> = S extends null ? any : any | any;
+
+export enum PrivateDataPermission {
+  UponRequest = 'UPON_REQUEST', // The App must ask for permission to access private data every time
+  Auto = 'AUTO', // The App can access private data without confirmation
+}
+
+export enum AllowedPrivateData {
+  None = 0,
+  Assets = 1 << 0, // 1
+  Notes = 1 << 1, // 2
+  Storage = 1 << 2, // 4
+  All = (1 << 16) - 1, // 65535 (allows for new permissions without requiring a migration)
+}
+
+export type SignKind = 'word' | 'signingInputs';
+
+export interface Asset {
+  faucetId: string;
+  amount: string;
+}
+
+export type InputNoteDetails = {
+  noteId: string;
+  senderAccountId: string | undefined;
+  assets: FungibleAssetDetails[];
+  noteType: NoteType | undefined;
+  nullifier: string;
+  state: InputNoteState;
+};
+
+export type FungibleAssetDetails = {
+  amount: string;
+  faucetId: string;
+};
+
+// Developer-facing transaction output interface
+// Errors from the wallet are thrown as exceptions
+export interface TransactionOutput {
+  txHash: string;
+  outputNotes: Note[];
+}
+
+export interface IFailedTransactionOutput {
+  errorMessage: string;
+}
+
+// Internal wallet response format - uses serialized note data (string[])
+// Converted to Note objects for the public API (TransactionOutput)
+export interface WalletTransactionSuccessOutput {
+  txHash: string;
+  outputNotes: string[];
+}
+
+export type WalletTransactionOutput =
+  | WalletTransactionSuccessOutput
+  | IFailedTransactionOutput;