react-native-rgb 0.2.0

package/lib/typescript/src/index.d.ts

@@ -0,0 +1,28 @@
+import * as Interfaces from './Interfaces';
+import { Wallet } from './Wallet';
+export * from './Interfaces';
+export * from './Wallet';
+export * from './RgbError';
+export { Interfaces, Wallet };
+/**
+ * Generates new keys for a wallet.
+ * @param bitcoinNetwork - The Bitcoin network to use (MAINNET, TESTNET, TESTNET4, REGTEST, SIGNET)
+ * @returns Promise resolving to Keys containing mnemonic, xpub, accountXpubVanilla, accountXpubColored, and masterFingerprint
+ * @throws {RgbError} Throws RgbError with a code from {@link RgbLibErrors} if:
+ *   - Invalid Bitcoin network
+ *   - Key generation fails
+ */
+export declare function generateKeys(bitcoinNetwork: Interfaces.BitcoinNetwork): Promise<Interfaces.Keys>;
+/**
+ * Restores a wallet from a mnemonic.
+ * @param bitcoinNetwork - The Bitcoin network to use (MAINNET, TESTNET, TESTNET4, REGTEST, SIGNET)
+ * @param mnemonic - The mnemonic to restore the wallet from
+ * @returns Promise resolving to Keys containing mnemonic, xpub, accountXpubVanilla, accountXpubColored, and masterFingerprint
+ * @throws {RgbError} Throws RgbError with a code from {@link RgbLibErrors} if:
+ *   - Invalid Bitcoin network
+ *   - Invalid mnemonic
+ *   - Key restoration fails
+ */
+export declare function restoreKeys(bitcoinNetwork: Interfaces.BitcoinNetwork, mnemonic: string): Promise<Interfaces.Keys>;
+export declare function decodeInvoice(invoice: string): Promise<Interfaces.InvoiceData>;
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;AAE9B;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAChC,cAAc,EAAE,UAAU,CAAC,cAAc,GACxC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAE1B;AAED;;;;;;;;;GASG;AACH,wBAAsB,WAAW,CAC/B,cAAc,EAAE,UAAU,CAAC,cAAc,EACzC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAE1B;AAED,wBAAsB,aAAa,CACjC,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAEjC"}

package/package.json

@@ -0,0 +1,174 @@
+{
+  "name": "react-native-rgb",
+  "version": "0.2.0",
+  "description": "React Native library for Bitcoin RGB Protocol",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!ios/rgb_libFFI.xcframework",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-rgb-example",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "postinstall": "node scripts/download-rgb-lib-ios.js",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "test": "jest",
+    "release": "release-it --only-version --ci --no-increment",
+    "codegen": "mkdir -p android/build/generated/source/codegen && node node_modules/@react-native/codegen/lib/cli/combine/combine-js-to-schema-cli.js android/build/generated/source/codegen/schema.json src/NativeRgb.ts && node node_modules/@react-native/codegen/lib/cli/generators/generate-all.js android/build/generated/source/codegen/schema.json RgbSpec android/build/generated/source/codegen com.rgb",
+    "prettier": "prettier --write \"**/*.{js,ts,tsx}\"",
+    "build:watch": "tsc -w"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Orbis-1/react-native-rgb.git"
+  },
+  "author": "Orbis1 <shashank@bithyve.com> (https://orbis1.io/)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://www.github.com/Orbis-1/react-native-rgb/issues"
+  },
+  "homepage": "https://www.github.com/Orbis-1/react-native-rgb#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@react-native/babel-preset": "0.83.0",
+    "@react-native/eslint-config": "0.83.0",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.2.0",
+    "commitlint": "^19.8.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^29.7.0",
+    "lefthook": "^2.0.3",
+    "prettier": "^2.8.8",
+    "react": "19.2.0",
+    "react-native": "0.83.0",
+    "react-native-builder-bob": "^0.40.17",
+    "release-it": "^19.0.4",
+    "turbo": "^2.5.6",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "RgbSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.rgb"
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "create-react-native-library": {
+    "type": "turbo-module",
+    "languages": "kotlin-objc",
+    "tools": [
+      "eslint",
+      "jest",
+      "lefthook",
+      "release-it"
+    ],
+    "version": "0.56.0"
+  }
+}

package/src/Interfaces.ts

@@ -0,0 +1,376 @@
+export type BitcoinNetwork =
+  | 'MAINNET'
+  | 'TESTNET'
+  | 'TESTNET4'
+  | 'REGTEST'
+  | 'SIGNET';
+
+export const BitcoinNetwork = {
+  MAINNET: 'MAINNET' as const,
+  TESTNET: 'TESTNET' as const,
+  TESTNET4: 'TESTNET4' as const,
+  REGTEST: 'REGTEST' as const,
+  SIGNET: 'SIGNET' as const,
+} as const;
+
+export type Keys = {
+  mnemonic: string;
+  xpub: string;
+  accountXpubVanilla: string;
+  accountXpubColored: string;
+  masterFingerprint: string;
+};
+
+export type Balance = {
+  settled: number;
+  future: number;
+  spendable: number;
+};
+
+export type BtcBalance = {
+  vanilla: Balance;
+  colored: Balance;
+};
+
+export type AssetSchema = 'NIA' | 'UDA' | 'CFA' | 'IFA';
+
+export const AssetSchema = {
+  NIA: 'NIA' as const,
+  UDA: 'UDA' as const,
+  CFA: 'CFA' as const,
+  IFA: 'IFA' as const,
+} as const;
+
+export type AssignmentType =
+  | 'FUNGIBLE'
+  | 'NON_FUNGIBLE'
+  | 'INFLATION_RIGHT'
+  | 'REPLACE_RIGHT'
+  | 'ANY';
+
+export type Assignment = {
+  type: AssignmentType;
+  amount?: number;
+};
+
+export type RefreshTransferStatus =
+  | 'WAITING_COUNTERPARTY'
+  | 'WAITING_CONFIRMATIONS';
+
+export type RefreshFilter = {
+  status: RefreshTransferStatus;
+  incoming: boolean;
+};
+
+export type WitnessData = {
+  amountSat: number;
+  blinding?: number;
+};
+
+export type Recipient = {
+  recipientId: string;
+  witnessData?: WitnessData;
+  assignment: Assignment;
+  transportEndpoints: string[];
+};
+
+export type Media = {
+  filePath: string;
+  mime: string;
+};
+
+export type AssetCfa = {
+  assetId: string;
+  name: string;
+  details?: string;
+  precision: number;
+  issuedSupply: number;
+  timestamp: number;
+  addedAt: number;
+  balance: Balance;
+  media?: Media;
+};
+
+export type AssetIfa = {
+  assetId: string;
+  ticker: string;
+  name: string;
+  details?: string;
+  precision: number;
+  initialSupply: number;
+  maxSupply: number;
+  knownCirculatingSupply: number;
+  timestamp: number;
+  addedAt: number;
+  balance: Balance;
+  media?: Media;
+  rejectListUrl?: string;
+};
+
+export type AssetNia = {
+  assetId: string;
+  ticker: string;
+  name: string;
+  precision: number;
+  amounts: number;
+  timestamp: number;
+  addedAt: number;
+  balance: Balance;
+};
+
+export type AssetUda = {
+  assetId: string;
+  ticker: string;
+  name: string;
+  details?: string;
+  precision: number;
+  timestamp: number;
+  addedAt: number;
+  balance: Balance;
+  media?: Media;
+  attachments: Array<{
+    filePath: string;
+    mime: string;
+  }>;
+};
+
+export type Assets = {
+  nia: AssetNia[];
+  uda: AssetUda[];
+  cfa: AssetCfa[];
+  ifa: AssetIfa[];
+};
+
+export type OperationResult = {
+  txid: string;
+  batchTransferIdx: number;
+};
+
+export type ReceiveData = {
+  invoice: string;
+  recipientId: string;
+  expirationTimestamp: number | null;
+  batchTransferIdx: number;
+};
+
+export type InvoiceData = {
+  invoice: string;
+  recipientId: string;
+  assetSchema: AssetSchema | null;
+  assetId: string | null;
+  assignment: Assignment;
+  assignmentName: string | null;
+  network: BitcoinNetwork;
+  expirationTimestamp: number | null;
+  transportEndpoints: string[];
+};
+
+export type Transaction = {
+  transactionType: 'RGB_SEND' | 'DRAIN' | 'CREATE_UTXOS' | 'USER';
+  txid: string;
+  received: number;
+  sent: number;
+  fee: number;
+  confirmationTime?: number;
+};
+
+export type Transfer = {
+  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;
+};
+
+export type Unspent = {
+  utxo: string;
+  vout: number;
+  amount: number;
+  colorable: string;
+  rgbAllocations: number;
+};
+
+export type RefreshedTransfer = {
+  updatedStatus?:
+    | 'WAITING_COUNTERPARTY'
+    | 'WAITING_CONFIRMATIONS'
+    | 'SETTLED'
+    | 'FAILED';
+  failure?: string;
+};
+
+export type WalletData = {
+  dataDir: string;
+  bitcoinNetwork: string;
+  databaseType: string;
+  maxAllocationsPerUtxo: number;
+  accountXpubVanilla: string;
+  accountXpubColored: string;
+  mnemonic?: string;
+  masterFingerprint: string;
+  vanillaKeychain?: number;
+  supportedSchemas: string[];
+};
+
+export type AssetMetadata = {
+  assetId: string;
+  name: string;
+  ticker?: string;
+  details?: string;
+  precision?: number;
+  issuedSupply?: number;
+  timestamp?: number;
+  amounts?: number[];
+  assetNia?: AssetNia;
+  assetUda?: AssetUda;
+  assetCfa?: AssetCfa;
+  assetIfa?: AssetIfa;
+};
+
+/**
+ * Error types that can be returned by RGB library methods.
+ * These correspond to the RgbLibError
+ * Errors with associated values are represented as objects with the error name and associated data.
+ */
+export type RgbLibErrors =
+  | 'AllocationsAlreadyAvailable'
+  | { type: 'AssetNotFound'; assetId: string }
+  | { type: 'BatchTransferNotFound'; idx: number }
+  | 'BitcoinNetworkMismatch'
+  | 'CannotChangeOnline'
+  | 'CannotDeleteBatchTransfer'
+  | 'CannotEstimateFees'
+  | 'CannotFailBatchTransfer'
+  | 'CannotFinalizePsbt'
+  | 'CannotUseIfaOnMainnet'
+  | { type: 'EmptyFile'; filePath: string }
+  | { type: 'FailedBdkSync'; details: string }
+  | { type: 'FailedBroadcast'; details: string }
+  | { type: 'FailedIssuance'; details: string }
+  | { type: 'FileAlreadyExists'; path: string }
+  | 'FingerprintMismatch'
+  | { type: 'Io'; details: string }
+  | { type: 'Inconsistency'; details: string }
+  | { type: 'Indexer'; details: string }
+  | 'InexistentDataDir'
+  | 'InsufficientAllocationSlots'
+  | { type: 'InsufficientAssignments'; assetId: string; available: unknown }
+  | { type: 'InsufficientBitcoins'; needed: number; available: number }
+  | { type: 'Internal'; details: string }
+  | { type: 'InvalidAddress'; details: string }
+  | 'InvalidAmountZero'
+  | { type: 'InvalidAssetId'; assetId: string }
+  | 'InvalidAssignment'
+  | { type: 'InvalidAttachments'; details: string }
+  | 'InvalidBitcoinKeys'
+  | { type: 'InvalidBitcoinNetwork'; network: string }
+  | { type: 'InvalidColoringInfo'; details: string }
+  | 'InvalidConsignment'
+  | { type: 'InvalidDetails'; details: string }
+  | { type: 'InvalidElectrum'; details: string }
+  | 'InvalidEstimationBlocks'
+  | { type: 'InvalidFeeRate'; details: string }
+  | { type: 'InvalidFilePath'; filePath: string }
+  | 'InvalidFingerprint'
+  | { type: 'InvalidIndexer'; details: string }
+  | { type: 'InvalidInvoice'; details: string }
+  | { type: 'InvalidMnemonic'; details: string }
+  | { type: 'InvalidName'; details: string }
+  | { type: 'InvalidPrecision'; details: string }
+  | { type: 'InvalidProxyProtocol'; version: string }
+  | { type: 'InvalidPsbt'; details: string }
+  | { type: 'InvalidPubkey'; details: string }
+  | { type: 'InvalidRecipientData'; details: string }
+  | 'InvalidRecipientId'
+  | 'InvalidRecipientNetwork'
+  | { type: 'InvalidRejectListUrl'; details: string }
+  | { type: 'InvalidTicker'; details: string }
+  | { type: 'InvalidTransportEndpoint'; details: string }
+  | { type: 'InvalidTransportEndpoints'; details: string }
+  | 'InvalidTxid'
+  | 'InvalidVanillaKeychain'
+  | { type: 'MaxFeeExceeded'; txid: string }
+  | { type: 'MinFeeNotMet'; txid: string }
+  | { type: 'Network'; details: string }
+  | 'NoConsignment'
+  | 'NoInflationAmounts'
+  | 'NoIssuanceAmounts'
+  | 'NoSupportedSchemas'
+  | 'NoValidTransportEndpoint'
+  | 'Offline'
+  | 'OnlineNeeded'
+  | 'OutputBelowDustLimit'
+  | { type: 'Proxy'; details: string }
+  | 'RecipientIdAlreadyUsed'
+  | 'RecipientIdDuplicated'
+  | { type: 'RejectListService'; details: string }
+  | { type: 'RestClientBuild'; details: string }
+  | 'TooHighInflationAmounts'
+  | 'TooHighIssuanceAmounts'
+  | { type: 'UnknownRgbSchema'; schemaId: string }
+  | { type: 'UnknownTransfer'; txid: string }
+  | { type: 'UnsupportedBackupVersion'; version: string }
+  | { type: 'UnsupportedInflation'; assetSchema: string }
+  | { type: 'UnsupportedLayer1'; layer1: string }
+  | { type: 'UnsupportedSchema'; assetSchema: string }
+  | 'UnsupportedTransportType'
+  | { type: 'WalletDirAlreadyExists'; path: string }
+  | 'WatchOnly'
+  | 'WrongPassword';
+
+/**
+ * Constants for all RGB library errors.
+ * Use these for error code comparison and type safety.
+ */
+export const RgbLibErrors = {
+  AllocationsAlreadyAvailable: 'AllocationsAlreadyAvailable' as const,
+  BitcoinNetworkMismatch: 'BitcoinNetworkMismatch' as const,
+  CannotChangeOnline: 'CannotChangeOnline' as const,
+  CannotDeleteBatchTransfer: 'CannotDeleteBatchTransfer' as const,
+  CannotEstimateFees: 'CannotEstimateFees' as const,
+  CannotFailBatchTransfer: 'CannotFailBatchTransfer' as const,
+  CannotFinalizePsbt: 'CannotFinalizePsbt' as const,
+  CannotUseIfaOnMainnet: 'CannotUseIfaOnMainnet' as const,
+  FingerprintMismatch: 'FingerprintMismatch' as const,
+  InexistentDataDir: 'InexistentDataDir' as const,
+  InsufficientAllocationSlots: 'InsufficientAllocationSlots' as const,
+  InvalidAmountZero: 'InvalidAmountZero' as const,
+  InvalidAssignment: 'InvalidAssignment' as const,
+  InvalidBitcoinKeys: 'InvalidBitcoinKeys' as const,
+  InvalidConsignment: 'InvalidConsignment' as const,
+  InvalidEstimationBlocks: 'InvalidEstimationBlocks' as const,
+  InvalidFingerprint: 'InvalidFingerprint' as const,
+  InvalidRecipientId: 'InvalidRecipientId' as const,
+  InvalidRecipientNetwork: 'InvalidRecipientNetwork' as const,
+  InvalidTxid: 'InvalidTxid' as const,
+  InvalidVanillaKeychain: 'InvalidVanillaKeychain' as const,
+  NoConsignment: 'NoConsignment' as const,
+  NoInflationAmounts: 'NoInflationAmounts' as const,
+  NoIssuanceAmounts: 'NoIssuanceAmounts' as const,
+  NoSupportedSchemas: 'NoSupportedSchemas' as const,
+  NoValidTransportEndpoint: 'NoValidTransportEndpoint' as const,
+  Offline: 'Offline' as const,
+  OnlineNeeded: 'OnlineNeeded' as const,
+  OutputBelowDustLimit: 'OutputBelowDustLimit' as const,
+  RecipientIdAlreadyUsed: 'RecipientIdAlreadyUsed' as const,
+  RecipientIdDuplicated: 'RecipientIdDuplicated' as const,
+  TooHighInflationAmounts: 'TooHighInflationAmounts' as const,
+  TooHighIssuanceAmounts: 'TooHighIssuanceAmounts' as const,
+  UnsupportedTransportType: 'UnsupportedTransportType' as const,
+  WatchOnly: 'WatchOnly' as const,
+  WrongPassword: 'WrongPassword' as const,
+} as const;