react-native-rgb 0.2.0

package/src/NativeRgb.ts

@@ -0,0 +1,630 @@
+import { TurboModuleRegistry, type TurboModule } from 'react-native';
+import type { InvoiceData } from './Interfaces';
+
+export interface Spec extends TurboModule {
+  generateKeys(
+    bitcoinNetwork: 'MAINNET' | 'TESTNET' | 'TESTNET4' | 'REGTEST' | 'SIGNET'
+  ): Promise<{
+    mnemonic: string;
+    xpub: string;
+    accountXpubVanilla: string;
+    accountXpubColored: string;
+    masterFingerprint: string;
+  }>;
+  restoreKeys(
+    bitcoinNetwork: 'MAINNET' | 'TESTNET' | 'TESTNET4' | 'REGTEST' | 'SIGNET',
+    mnemonic: string
+  ): Promise<{
+    mnemonic: string;
+    xpub: string;
+    accountXpubVanilla: string;
+    accountXpubColored: string;
+    masterFingerprint: string;
+  }>;
+  initializeWallet(
+    network: string,
+    accountXpubVanilla: string,
+    accountXpubColored: string,
+    mnemonic: string,
+    masterFingerprint: string,
+    supportedSchemas: string[],
+    maxAllocationsPerUtxo: number,
+    vanillaKeychain: number
+  ): Promise<number>;
+  goOnline(
+    walletId: number,
+    skipConsistencyCheck: boolean,
+    indexerUrl: string
+  ): Promise<void>;
+  getBtcBalance(
+    walletId: number,
+    skipSync: boolean
+  ): Promise<{
+    vanilla: {
+      settled: number;
+      future: number;
+      spendable: number;
+    };
+    colored: {
+      settled: number;
+      future: number;
+      spendable: number;
+    };
+  }>;
+  walletClose(walletId: number): Promise<void>;
+  backup(walletId: number, backupPath: string, password: string): Promise<void>;
+  backupInfo(walletId: number): Promise<boolean>;
+  blindReceive(
+    walletId: number,
+    assetId: string | null,
+    assignment: {
+      type:
+        | 'FUNGIBLE'
+        | 'NON_FUNGIBLE'
+        | 'INFLATION_RIGHT'
+        | 'REPLACE_RIGHT'
+        | 'ANY';
+      amount?: number;
+    },
+    durationSeconds: number | null,
+    transportEndpoints: string[],
+    minConfirmations: number
+  ): Promise<{
+    invoice: string;
+    recipientId: string;
+    expirationTimestamp: number | null;
+    batchTransferIdx: number;
+  }>;
+  createUtxos(
+    walletId: number,
+    upTo: boolean,
+    num: number | null,
+    size: number | null,
+    feeRate: number,
+    skipSync: boolean
+  ): Promise<number>;
+  createUtxosBegin(
+    walletId: number,
+    upTo: boolean,
+    num: number | null,
+    size: number | null,
+    feeRate: number,
+    skipSync: boolean
+  ): Promise<string>;
+  createUtxosEnd(
+    walletId: number,
+    signedPsbt: string,
+    skipSync: boolean
+  ): Promise<number>;
+  deleteTransfers(
+    walletId: number,
+    batchTransferIdx: number | null,
+    noAssetOnly: boolean
+  ): Promise<boolean>;
+  drainTo(
+    walletId: number,
+    address: string,
+    destroyAssets: boolean,
+    feeRate: number
+  ): Promise<string>;
+  drainToBegin(
+    walletId: number,
+    address: string,
+    destroyAssets: boolean,
+    feeRate: number
+  ): Promise<string>;
+  drainToEnd(walletId: number, signedPsbt: string): Promise<string>;
+  failTransfers(
+    walletId: number,
+    batchTransferIdx: number | null,
+    noAssetOnly: boolean,
+    skipSync: boolean
+  ): Promise<boolean>;
+  finalizePsbt(walletId: number, signedPsbt: string): Promise<string>;
+  getAddress(walletId: number): Promise<string>;
+  getAssetBalance(
+    walletId: number,
+    assetId: string
+  ): Promise<{
+    settled: number;
+    future: number;
+    spendable: number;
+  }>;
+  getAssetMetadata(
+    walletId: number,
+    assetId: string
+  ): Promise<{
+    assetId: string;
+    name: string;
+    ticker?: string;
+    details?: string;
+    precision?: number;
+    issuedSupply?: number;
+    timestamp?: number;
+    amounts?: number[];
+    assetNia?: {
+      assetId: string;
+      ticker: string;
+      name: string;
+      precision: number;
+      amounts: number;
+      timestamp: number;
+      addedAt: number;
+      balance: {
+        settled: number;
+        future: number;
+        spendable: number;
+      };
+    };
+    assetUda?: {
+      assetId: string;
+      ticker: string;
+      name: string;
+      details?: string;
+      precision: number;
+      timestamp: number;
+      addedAt: number;
+      balance: {
+        settled: number;
+        future: number;
+        spendable: number;
+      };
+      media?: {
+        filePath: string;
+        mime: string;
+      };
+      attachments: Array<{
+        filePath: string;
+        mime: string;
+      }>;
+    };
+    assetCfa?: {
+      assetId: string;
+      name: string;
+      details?: string;
+      precision: number;
+      issuedSupply: number;
+      timestamp: number;
+      addedAt: number;
+      balance: {
+        settled: number;
+        future: number;
+        spendable: number;
+      };
+      media?: {
+        filePath: string;
+        mime: string;
+      };
+    };
+    assetIfa?: {
+      assetId: string;
+      ticker: string;
+      name: string;
+      details?: string;
+      precision: number;
+      initialSupply: number;
+      maxSupply: number;
+      knownCirculatingSupply: number;
+      timestamp: number;
+      addedAt: number;
+      balance: {
+        settled: number;
+        future: number;
+        spendable: number;
+      };
+      media?: {
+        filePath: string;
+        mime: string;
+      };
+      rejectListUrl?: string;
+    };
+  }>;
+  getFeeEstimation(walletId: number, blocks: number): Promise<number>;
+  getMediaDir(walletId: number): Promise<string>;
+  getWalletData(walletId: number): Promise<{
+    dataDir: string;
+    bitcoinNetwork: string;
+    databaseType: string;
+    maxAllocationsPerUtxo: number;
+    accountXpubVanilla: string;
+    accountXpubColored: string;
+    mnemonic?: string;
+    masterFingerprint: string;
+    vanillaKeychain?: number;
+    supportedSchemas: string[];
+  }>;
+  getWalletDir(walletId: number): Promise<string>;
+  inflate(
+    walletId: number,
+    assetId: string,
+    inflationAmounts: number[],
+    feeRate: number,
+    minConfirmations: number
+  ): Promise<{
+    txid: string;
+    batchTransferIdx: number;
+  }>;
+  inflateBegin(
+    walletId: number,
+    assetId: string,
+    inflationAmounts: number[],
+    feeRate: number,
+    minConfirmations: number
+  ): Promise<string>;
+  inflateEnd(
+    walletId: number,
+    signedPsbt: string
+  ): Promise<{
+    txid: string;
+    batchTransferIdx: number;
+  }>;
+  issueAssetCfa(
+    walletId: number,
+    name: string,
+    details: string | null,
+    precision: number,
+    amounts: number[],
+    filePath: string | null
+  ): Promise<{
+    assetId: string;
+    name: string;
+    details?: string;
+    precision: number;
+    issuedSupply: number;
+    timestamp: number;
+    addedAt: number;
+    balance: {
+      settled: number;
+      future: number;
+      spendable: number;
+    };
+    media?: {
+      filePath: string;
+      mime: string;
+    };
+  }>;
+  issueAssetIfa(
+    walletId: number,
+    ticker: string,
+    name: string,
+    precision: number,
+    amounts: number[],
+    inflationAmounts: number[],
+    replaceRightsNum: number,
+    rejectListUrl: string | null
+  ): Promise<{
+    assetId: string;
+    ticker: string;
+    name: string;
+    details?: string;
+    precision: number;
+    initialSupply: number;
+    maxSupply: number;
+    knownCirculatingSupply: number;
+    timestamp: number;
+    addedAt: number;
+    balance: {
+      settled: number;
+      future: number;
+      spendable: number;
+    };
+    media?: {
+      filePath: string;
+      mime: string;
+    };
+    rejectListUrl?: string;
+  }>;
+  issueAssetNia(
+    walletId: number,
+    ticker: string,
+    name: string,
+    precision: number,
+    amounts: number[]
+  ): Promise<{
+    assetId: string;
+    ticker: string;
+    name: string;
+    precision: number;
+    amounts: number;
+    timestamp: number;
+    addedAt: number;
+    balance: {
+      settled: number;
+      future: number;
+      spendable: number;
+    };
+  }>;
+  issueAssetUda(
+    walletId: number,
+    ticker: string,
+    name: string,
+    details: string | null,
+    precision: number,
+    mediaFilePath: string | null,
+    attachmentsFilePaths: string[]
+  ): Promise<{
+    assetId: string;
+    ticker: string;
+    name: string;
+    details?: string;
+    precision: number;
+    timestamp: number;
+    addedAt: number;
+    balance: {
+      settled: number;
+      future: number;
+      spendable: number;
+    };
+    media?: {
+      filePath: string;
+      mime: string;
+    };
+    attachments: Array<{
+      filePath: string;
+      mime: string;
+    }>;
+  }>;
+  listAssets(
+    walletId: number,
+    filterAssetSchemas: string[]
+  ): Promise<{
+    nia: Array<{
+      assetId: string;
+      ticker: string;
+      name: string;
+      precision: number;
+      amounts: number;
+      timestamp: number;
+      addedAt: number;
+      balance: {
+        settled: number;
+        future: number;
+        spendable: number;
+      };
+    }>;
+    uda: Array<{
+      assetId: string;
+      ticker: string;
+      name: string;
+      details?: string;
+      precision: number;
+      timestamp: number;
+      addedAt: number;
+      balance: {
+        settled: number;
+        future: number;
+        spendable: number;
+      };
+      media?: {
+        filePath: string;
+        mime: string;
+      };
+      attachments: Array<{
+        filePath: string;
+        mime: string;
+      }>;
+    }>;
+    cfa: Array<{
+      assetId: string;
+      name: string;
+      details?: string;
+      precision: number;
+      issuedSupply: number;
+      timestamp: number;
+      addedAt: number;
+      balance: {
+        settled: number;
+        future: number;
+        spendable: number;
+      };
+      media?: {
+        filePath: string;
+        mime: string;
+      };
+    }>;
+    ifa: Array<{
+      assetId: string;
+      ticker: string;
+      name: string;
+      details?: string;
+      precision: number;
+      initialSupply: number;
+      maxSupply: number;
+      knownCirculatingSupply: number;
+      timestamp: number;
+      addedAt: number;
+      balance: {
+        settled: number;
+        future: number;
+        spendable: number;
+      };
+      media?: {
+        filePath: string;
+        mime: string;
+      };
+      rejectListUrl?: string;
+    }>;
+  }>;
+  listTransactions(
+    walletId: number,
+    skipSync: boolean
+  ): Promise<
+    Array<{
+      transactionType: 'RGB_SEND' | 'DRAIN' | 'CREATE_UTXOS' | 'USER';
+      txid: string;
+      received: number;
+      sent: number;
+      fee: number;
+      confirmationTime?: number;
+    }>
+  >;
+  listTransfers(
+    walletId: number,
+    assetId: string | null
+  ): Promise<
+    Array<{
+      transferIdx: number;
+      batchTransferIdx: number;
+      createdAt: number;
+      updatedAt: number;
+      kind:
+        | 'ISSUANCE'
+        | 'RECEIVE_BLIND'
+        | 'RECEIVE_WITNESS'
+        | 'SEND'
+        | 'INFLATION';
+      status:
+        | 'WAITING_COUNTERPARTY'
+        | 'WAITING_CONFIRMATIONS'
+        | 'SETTLED'
+        | 'FAILED';
+      txid?: string;
+      recipientId?: string;
+      receiveUtxo?: number;
+      changeUtxo?: number;
+      expiration?: number;
+      transportEndpoints: string;
+      invoiceString?: string;
+      consignmentPath?: string;
+      assignments: number;
+    }>
+  >;
+  listUnspents(
+    walletId: number,
+    settledOnly: boolean,
+    skipSync: boolean
+  ): Promise<
+    Array<{
+      utxo: string;
+      vout: number;
+      amount: number;
+      colorable: string;
+      rgbAllocations: number;
+    }>
+  >;
+  refresh(
+    walletId: number,
+    assetId: string | null,
+    filter: Array<{
+      status: 'WAITING_COUNTERPARTY' | 'WAITING_CONFIRMATIONS';
+      incoming: boolean;
+    }>,
+    skipSync: boolean
+  ): Promise<{
+    [key: string]: {
+      updatedStatus?:
+        | 'WAITING_COUNTERPARTY'
+        | 'WAITING_CONFIRMATIONS'
+        | 'SETTLED'
+        | 'FAILED';
+      failure?: string;
+    };
+  }>;
+  send(
+    walletId: number,
+    recipientMap: {
+      [key: string]: Array<{
+        recipientId: string;
+        witnessData?: {
+          amountSat: number;
+          blinding?: number;
+        };
+        assignment: {
+          type:
+            | 'FUNGIBLE'
+            | 'NON_FUNGIBLE'
+            | 'INFLATION_RIGHT'
+            | 'REPLACE_RIGHT'
+            | 'ANY';
+          amount?: number;
+        };
+        transportEndpoints: string[];
+      }>;
+    },
+    donation: boolean,
+    feeRate: number,
+    minConfirmations: number,
+    skipSync: boolean
+  ): Promise<{
+    txid: string;
+    batchTransferIdx: number;
+  }>;
+  sendBegin(
+    walletId: number,
+    recipientMap: {
+      [key: string]: Array<{
+        recipientId: string;
+        witnessData?: {
+          amountSat: number;
+          blinding?: number;
+        };
+        assignment: {
+          type:
+            | 'FUNGIBLE'
+            | 'NON_FUNGIBLE'
+            | 'INFLATION_RIGHT'
+            | 'REPLACE_RIGHT'
+            | 'ANY';
+          amount?: number;
+        };
+        transportEndpoints: string[];
+      }>;
+    },
+    donation: boolean,
+    feeRate: number,
+    minConfirmations: number
+  ): Promise<string>;
+  sendBtc(
+    walletId: number,
+    address: string,
+    amount: number,
+    feeRate: number,
+    skipSync: boolean
+  ): Promise<string>;
+  sendBtcBegin(
+    walletId: number,
+    address: string,
+    amount: number,
+    feeRate: number,
+    skipSync: boolean
+  ): Promise<string>;
+  sendBtcEnd(
+    walletId: number,
+    signedPsbt: string,
+    skipSync: boolean
+  ): Promise<string>;
+  sendEnd(
+    walletId: number,
+    signedPsbt: string,
+    skipSync: boolean
+  ): Promise<{
+    txid: string;
+    batchTransferIdx: number;
+  }>;
+  signPsbt(walletId: number, unsignedPsbt: string): Promise<string>;
+  sync(walletId: number): Promise<void>;
+  witnessReceive(
+    walletId: number,
+    assetId: string | null,
+    assignment: {
+      type:
+        | 'FUNGIBLE'
+        | 'NON_FUNGIBLE'
+        | 'INFLATION_RIGHT'
+        | 'REPLACE_RIGHT'
+        | 'ANY';
+      amount?: number;
+    },
+    durationSeconds: number | null,
+    transportEndpoints: string[],
+    minConfirmations: number
+  ): Promise<{
+    invoice: string;
+    recipientId: string;
+    expirationTimestamp: number | null;
+    batchTransferIdx: number;
+  }>;
+  decodeInvoice(invoice: string): Promise<InvoiceData>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('Rgb');

package/src/RgbError.ts

@@ -0,0 +1,84 @@
+import { RgbLibErrors } from './Interfaces';
+
+/**
+ * Custom error class for RGB library errors.
+ * Provides structured error information with error codes and messages.
+ */
+export class RgbError extends Error {
+  /**
+   * Error code from the native module.
+   * This helps identify which operation failed.
+   */
+  public readonly code: RgbLibErrors;
+
+  /**
+   * Original error message from the native module.
+   */
+  public readonly nativeMessage: string;
+
+  constructor(
+    code: RgbLibErrors,
+    message: string,
+    public readonly originalError?: unknown
+  ) {
+    super(message);
+    this.name = 'RgbError';
+    this.code = code;
+    this.nativeMessage = message;
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, RgbError);
+    }
+  }
+
+  public isCode(code: RgbLibErrors): boolean {
+    if (typeof this.code === 'string' && typeof code === 'string') {
+      return this.code === code;
+    }
+    if (
+      typeof this.code === 'object' &&
+      typeof code === 'object' &&
+      code !== null
+    ) {
+      return (
+        'type' in this.code && 'type' in code && this.code.type === code.type
+      );
+    }
+    return false;
+  }
+
+  public toString(): string {
+    const codeStr =
+      typeof this.code === 'string'
+        ? this.code
+        : `[${this.code.type}] ${JSON.stringify(this.code)}`;
+    return `[${codeStr}] ${this.message}`;
+  }
+
+  /**
+   * Converts a React Native error to an RgbError.
+   * React Native errors from native modules typically have a code and message.
+   * @param error - The error from React Native
+   * @returns An RgbError instance, or the original error if it cannot be converted
+   */
+  public static fromReactNativeError(error: unknown): RgbError | Error {
+    // Check if it's already an RgbError
+    if (error instanceof RgbError) {
+      return error;
+    }
+
+    if (error instanceof Error && 'code' in error) {
+      const code = (error as any).code;
+      const message = error.message || 'Unknown error';
+      if (typeof code === 'string') {
+        return new RgbError(code as RgbLibErrors, message, error);
+      }
+    }
+
+    if (error instanceof Error) {
+      return error;
+    }
+
+    return new Error(String(error));
+  }
+}