mainnet-js 3.1.7 → 4.0.0-next.10

package/src/cache/MemoryCache.ts

@@ -1,32 +0,0 @@
-import { CacheProvider } from "./interface";
-
-let cache: Record<string, string> = {};
-export class MemoryCache implements CacheProvider {
-  async init() {
-    return;
-  }
-  async setItem(key: string, value: string) {
-    cache[key] = value;
-  }
-  async getItem(key: string) {
-    return cache[key] ?? null;
-  }
-  async getItems(keys: string[]): Promise<Map<string, string | null>> {
-    const results = new Map<string, string | null>();
-    for (const key of keys) {
-      results.set(key, cache[key] ?? null);
-    }
-    return results;
-  }
-  async setItems(entries: [string, string][]): Promise<void> {
-    for (const [key, value] of entries) {
-      cache[key] = value;
-    }
-  }
-  async removeItem(key: string) {
-    delete cache[key];
-  }
-  async clear() {
-    cache = {};
-  }
-}

package/src/cache/WebStorageCache.test.ts

@@ -1,15 +0,0 @@
-import { WebStorageCache } from "./WebStorageCache";
-
-describe("WebStorageCache Tests", () => {
-  test("test", async () => {
-    const cache = new WebStorageCache();
-    await cache.init();
-    await cache.setItem("key", "value");
-    const value = await cache.getItem("key");
-    expect(value).toBe("value");
-
-    await cache.removeItem("key");
-    const value2 = await cache.getItem("key");
-    expect(value2).toBeNull();
-  });
-});

package/src/cache/WebStorageCache.ts

@@ -1,38 +0,0 @@
-import { CacheProvider } from "./interface";
-
-// super thin wrapper around localStorage
-export class WebStorageCache implements CacheProvider {
-  async init() {
-    return;
-  }
-
-  async setItem(key: string, value: string): Promise<void> {
-    localStorage.setItem(key, value);
-  }
-
-  async getItem(key: string): Promise<string | null> {
-    return localStorage.getItem(key);
-  }
-
-  async getItems(keys: string[]): Promise<Map<string, string | null>> {
-    const results = new Map<string, string | null>();
-    for (const key of keys) {
-      results.set(key, localStorage.getItem(key));
-    }
-    return results;
-  }
-
-  async setItems(entries: [string, string][]): Promise<void> {
-    for (const [key, value] of entries) {
-      localStorage.setItem(key, value);
-    }
-  }
-
-  async removeItem(key: string): Promise<void> {
-    localStorage.removeItem(key);
-  }
-
-  async clear(): Promise<void> {
-    localStorage.clear();
-  }
-}

package/src/cache/index.ts

@@ -1,2 +0,0 @@
-export * from "./interface.js";
-export * from "./walletCache.js";

package/src/cache/interface.ts

@@ -1,9 +0,0 @@
-export interface CacheProvider {
-  init(): Promise<void>;
-  setItem(key: string, value: string): Promise<void>;
-  getItem(key: string): Promise<string | null>;
-  getItems(keys: string[]): Promise<Map<string, string | null>>;
-  setItems(entries: [string, string][]): Promise<void>;
-  removeItem(key: string): Promise<void>;
-  clear(): Promise<void>;
-}

package/src/cache/walletCache.ts

@@ -1,254 +0,0 @@
-import {
-  assertSuccess,
-  binToHex,
-  CashAddressNetworkPrefix,
-  CashAddressType,
-  deriveHdPathRelative,
-  encodeCashAddress,
-  hash160,
-  HdPrivateNodeValid,
-  HdPublicNodeValid,
-  hexToBin,
-  secp256k1,
-} from "@bitauth/libauth";
-import { Config } from "../config.js";
-import { TxI, Utxo } from "../interface.js";
-import { IndexedDbCache } from "./IndexedDbCache.js";
-import { CacheProvider } from "./interface.js";
-import { MemoryCache } from "./MemoryCache.js";
-import { WebStorageCache } from "./WebStorageCache.js";
-
-export const stringify = (_: any) =>
-  JSON.stringify(_, (key, value) => {
-    if (key.includes("Key")) return binToHex(value);
-    return typeof value === "bigint" ? value.toString() + "n" : value;
-  });
-export const parse = (data: string) =>
-  JSON.parse(data, (key, value) => {
-    if (key.includes("Key") && typeof value === "string") {
-      return hexToBin(value);
-    }
-
-    if (typeof value === "string" && /^\d+n$/.test(value)) {
-      return BigInt(value.slice(0, -1));
-    }
-    return value;
-  });
-
-export interface WalletCacheEntry {
-  address: string;
-  tokenAddress: string;
-  privateKey: Uint8Array | undefined;
-  publicKey: Uint8Array;
-  publicKeyHash: Uint8Array;
-  index: number;
-  change: boolean;
-  status: string | null;
-  utxos: Utxo[];
-  rawHistory: TxI[];
-  // Top block height of confirmed history items, used for incremental fetching
-  lastConfirmedHeight: number;
-}
-
-// Minimal interface for use in transaction signing
-export interface WalletCache {
-  get(address: string): { privateKey: Uint8Array | undefined } | undefined;
-}
-
-// Full interface for wallet cache management
-export interface WalletCacheI extends WalletCache {
-  init(): Promise<void>;
-  persist(): Promise<void>;
-  get(address: string): WalletCacheEntry | undefined;
-  getByIndex(addressIndex: number, change: boolean): WalletCacheEntry;
-  setStatusAndUtxos(
-    address: string,
-    status: string | null,
-    utxos: Utxo[],
-    rawHistory: TxI[],
-    lastConfirmedHeight: number
-  ): void;
-}
-
-export class PersistentWalletCache implements WalletCacheI {
-  private _storage: CacheProvider | undefined;
-  private walletCache: Record<string, WalletCacheEntry> = {};
-  private indexCache: Record<
-    string,
-    {
-      index: number;
-      change: boolean;
-    }
-  > = {};
-  private debounceTimer: ReturnType<typeof setTimeout> | undefined;
-
-  get storage(): CacheProvider | undefined {
-    if (
-      !Config.UseMemoryCache &&
-      !Config.UseLocalStorageCache &&
-      !Config.UseIndexedDBCache
-    ) {
-      this._storage = undefined;
-      return this._storage;
-    }
-
-    if (Config.UseMemoryCache && !(this._storage instanceof MemoryCache)) {
-      this._storage = new MemoryCache();
-      return this._storage;
-    }
-
-    if (
-      Config.UseLocalStorageCache &&
-      !(this._storage instanceof WebStorageCache)
-    ) {
-      this._storage = new WebStorageCache();
-      return this._storage;
-    }
-
-    if (
-      Config.UseIndexedDBCache &&
-      !(this._storage instanceof IndexedDbCache)
-    ) {
-      this._storage = new IndexedDbCache("WalletCache");
-      return this._storage;
-    }
-
-    return this._storage;
-  }
-
-  constructor(
-    public walletId: string,
-    public hdNode: HdPublicNodeValid | HdPrivateNodeValid,
-    public networkPrefix: string,
-    public writeTimeout: number = 2000
-  ) {
-    if (!this.hdNode) {
-      throw new Error("HDNode is undefined");
-    }
-  }
-
-  public async init() {
-    await this.storage?.init();
-    const data = await this.storage?.getItem(`walletCache-${this.walletId}`);
-    if (data) {
-      try {
-        const parsed = parse(data);
-        this.walletCache = parsed.walletCache || {};
-        this.indexCache = parsed.indexCache || {};
-      } catch (e) {
-        // ignore
-      }
-    }
-  }
-
-  private schedulePersist() {
-    if (this.debounceTimer) clearTimeout(this.debounceTimer);
-    this.debounceTimer = setTimeout(() => {
-      this.persist().catch(() => {});
-    }, this.writeTimeout);
-  }
-
-  public async persist() {
-    if (this.debounceTimer) clearTimeout(this.debounceTimer);
-    this.debounceTimer = undefined;
-
-    this.storage?.setItem(
-      `walletCache-${this.walletId}`,
-      stringify({
-        walletCache: this.walletCache,
-        indexCache: this.indexCache,
-      })
-    );
-  }
-
-  public getByIndex(addressIndex: number, change: boolean) {
-    const id = `${this.walletId}-${addressIndex}-${change}`;
-    if (!this.walletCache[id]) {
-      const node = deriveHdPathRelative(
-        this.hdNode,
-        `${change ? 1 : 0}/${addressIndex}`
-      );
-
-      const privateKey = "privateKey" in node ? node.privateKey : undefined;
-      const publicKey =
-        "publicKey" in node
-          ? node.publicKey
-          : assertSuccess(secp256k1.derivePublicKeyUncompressed(privateKey!));
-      const publicKeyCompressed = assertSuccess(
-        secp256k1.compressPublicKey(publicKey)
-      );
-      const publicKeyHash = hash160(publicKeyCompressed);
-
-      const address = encodeCashAddress({
-        throwErrors: true,
-        prefix: this.networkPrefix as CashAddressNetworkPrefix,
-        type: CashAddressType.p2pkh,
-        payload: publicKeyHash,
-      }).address;
-
-      const tokenAddress = encodeCashAddress({
-        throwErrors: true,
-        prefix: this.networkPrefix as CashAddressNetworkPrefix,
-        type: CashAddressType.p2pkhWithTokens,
-        payload: publicKeyHash,
-      }).address;
-
-      this.walletCache[id] = {
-        address,
-        tokenAddress,
-        privateKey: privateKey,
-        publicKey,
-        publicKeyHash,
-        index: addressIndex,
-        change,
-        status: null,
-        utxos: [],
-        rawHistory: [],
-        lastConfirmedHeight: 0,
-      };
-
-      this.indexCache[address] = {
-        index: addressIndex,
-        change,
-      };
-
-      this.schedulePersist();
-    }
-
-    return this.walletCache[id];
-  }
-
-  public get(address: string) {
-    const { index, change } = this.indexCache[address] || {};
-    if (index === undefined || change === undefined) {
-      return undefined;
-    }
-    return this.getByIndex(index, change);
-  }
-
-  public setStatusAndUtxos(
-    address: string,
-    status: string | null,
-    utxos: Utxo[],
-    rawHistory: TxI[],
-    lastConfirmedHeight: number
-  ) {
-    const entry = this.get(address);
-    if (!entry) {
-      return;
-    }
-
-    const { index, change } = this.indexCache[address] || {};
-    if (index === undefined || change === undefined) {
-      return;
-    }
-
-    const key = `${this.walletId}-${index}-${change}`;
-    this.walletCache[key].status = status;
-    this.walletCache[key].utxos = utxos;
-    this.walletCache[key].rawHistory = rawHistory;
-    this.walletCache[key].lastConfirmedHeight = lastConfirmedHeight;
-
-    this.schedulePersist();
-  }
-}

package/src/chain.ts

@@ -1,3 +0,0 @@
-export const bchParam = {
-  subUnits: 100000000n,
-};

package/src/cli.ts

@@ -1,32 +0,0 @@
-import { createWallet } from "../src/wallet/createWallet.js";
-import { WalletTypeEnum } from "./wallet/enum.js";
-import { walletFromId } from "../src/wallet/createWallet.js";
-
-let args = process.argv.slice(); // remove ts-node
-args.shift(); // remove ts-node
-args.shift(); // remove cli.ts
-
-// This is an UNSUPPORTED feature for developers
-// Please upstream any additions you find useful.
-// There is ZERO support for this feature
-
-(async () => {
-  let command = args.shift();
-  let w;
-  switch (command) {
-    case "wallet/create":
-      let response = await createWallet({
-        name: args[0],
-        type: args[1] as WalletTypeEnum,
-        network: args[2],
-      });
-      console.log(response);
-      break;
-    case "wallet/deposit_address":
-      w = await walletFromId(args[0]);
-      console.log(w.depositAddress());
-      break;
-    default:
-      console.log(`${command} not implemented`);
-  }
-})();

package/src/config.ts

@@ -1,23 +0,0 @@
-export class Config {
-  // enforces all token-related methods to specify tokenaddr as recepient and change cashaddr
-  static EnforceCashTokenReceiptAddresses = false;
-  static DefaultParentDerivationPath = "m/44'/0'/0'";
-  static DefaultIpfsGateway = "https://dweb.link/ipfs/";
-  // default currency for balance and rate conversions
-  static DefaultCurrency = "usd";
-  // caches the raw transactions in browser's local storage instead of memory
-  static UseLocalStorageCache = false;
-  // caches the raw transactions in browser's indexedDB instead of memory
-  static UseIndexedDBCache = false;
-  // caches the raw transactions in browser's memory
-  static UseMemoryCache = false;
-
-  public static setIpfsGateway(ipfsGateway: string) {
-    this.DefaultIpfsGateway = ipfsGateway;
-  }
-
-  // custom exchange rate function
-  public static GetExchangeRateFn:
-    | ((symbol: string) => Promise<number>)
-    | undefined = undefined;
-}

package/src/constant.ts

@@ -1,27 +0,0 @@
-export const DELIMITER = ":";
-
-// Min amount utxo can be to be accepted by the network
-export const DUST_UTXO_THRESHOLD = 546n;
-
-// Current chained tx limit
-export const MEMPOOL_CHAIN_LIMIT = 50;
-
-// time in milliseconds to cache the usd exchange rate
-export const EXCHANGE_RATE_TTL = 250000;
-
-// list of common derivation paths
-// a la: https://github.com/Electron-Cash/Electron-Cash/blob/1de24c509992cfebc22217a2a77c862c2b02bc54/electroncash_gui/qt/installwizard.py#L624
-export const DERIVATION_PATHS = [
-  "m/0",
-  "m/0'",
-  "m/0'/0",
-  "m/0'/0'",
-  "m/0'/0'/0'",
-  "m/44'/0'/0'",
-  "m/44'/0'/0'/0",
-  "m/44'/145'/0'",
-  "m/44'/145'/0'/0",
-  "m/44'/245'/0",
-  "m/44'/245'/0'",
-  "m/44'/245'/0'/0",
-];

package/src/db/ExchangeRateProvider.ts

@@ -1,28 +0,0 @@
-import { ExchangeRateI } from "./interface.js";
-
-export default class ExchangeRateProvider {
-  /*
-   *   Exchange Rate functions
-   */
-
-  public async getRate(symbol: string): Promise<ExchangeRateI | undefined> {
-    const valueString = localStorage.getItem(`rate-${symbol}`);
-    if (valueString) {
-      return JSON.parse(valueString) as ExchangeRateI;
-    }
-
-    return undefined;
-  }
-
-  public async setRate(
-    symbol: string,
-    rate: number,
-    ttl: number
-  ): Promise<boolean> {
-    localStorage.setItem(
-      `rate-${symbol}`,
-      JSON.stringify({ symbol: symbol, rate: rate, ttl: ttl })
-    );
-    return true;
-  }
-}

package/src/db/StorageProvider.ts

@@ -1,64 +0,0 @@
-import { WalletDbEntryI } from "./interface.js";
-
-export default abstract class StorageProvider {
-  public constructor(...args: any[]) {
-    throw new Error("StorageProvider is abstract and cannot be instantiated");
-  }
-
-  /**
-   * Ensure the database exists and is open
-   * @throws {Error} If the wallet could not be opened.
-   * @returns the storage provider
-   */
-  abstract init(): Promise<StorageProvider>;
-
-  /**
-   * Manually close the database
-   * @throws {Error} If the wallet could not be opened.
-   * @returns the storage provider
-   */
-  abstract close(): Promise<StorageProvider>;
-
-  /**
-   * Returns information about the storage provider
-   * @throws {Error} If there is no info
-   * @returns string
-   */
-  abstract getInfo(): string;
-
-  /**
-   * Add a wallet to the database
-   * @param name A user defined name for the wallet, and the walletId.
-   * @param walletId String used to reconstruct the wallet.
-   * @throws {Error} If the wallet could not be saved.
-   * @returns if the operation was successful.
-   */
-  abstract addWallet(name: string, walletId: string): Promise<boolean>;
-
-  /**
-   * @returns All saved wallets.
-   */
-  abstract getWallets(): Promise<Array<WalletDbEntryI>>;
-
-  /**
-   * Get a named wallet from the database
-   * @param name A user defined name for the wallet.
-   * @throws {Error} If the wallet could not be saved.
-   * @returns The requested wallet.
-   */
-  abstract getWallet(name: string): Promise<WalletDbEntryI | undefined>;
-
-  /**
-   * Update named wallet in the database
-   * @param name A user defined name for the wallet, and the walletId.
-   * @param walletId String used to reconstruct the wallet.
-   * @throws {Error} If the wallet could not be saved.
-   */
-  abstract updateWallet(name: string, walletId: string): Promise<void>;
-
-  /**
-   * Check if wallet exists in the database
-   * @param name A user defined name for the wallet, and the walletId.
-   */
-  abstract walletExists(name: string): Promise<boolean>;
-}

package/src/db/index.ts

@@ -1,2 +0,0 @@
-export { default as StorageProvider } from "./StorageProvider.js";
-export * from "./interface.js";

package/src/db/interface.ts

@@ -1,11 +0,0 @@
-export interface WalletDbEntryI {
-  id?: number;
-  name: string;
-  wallet: string;
-}
-
-export interface ExchangeRateI {
-  symbol: string;
-  rate: number;
-  ttl: number;
-}

package/src/enum.ts

@@ -1,34 +0,0 @@
-import { CashAddressNetworkPrefix } from "@bitauth/libauth";
-
-export enum NetworkType {
-  Mainnet = "mainnet",
-  Testnet = "testnet",
-  Regtest = "regtest",
-}
-
-export enum NetworkEnum {
-  Mainnet = <any>"mainnet",
-  Testnet = <any>"testnet",
-  Regtest = <any>"regtest",
-}
-
-export const networkPrefixMap = {
-  bitcoincash: "mainnet",
-  bchtest: "testnet",
-  bchreg: "regtest",
-};
-
-export const prefixFromNetworkMap = {
-  mainnet: CashAddressNetworkPrefix.mainnet,
-  testnet: CashAddressNetworkPrefix.testnet,
-  regtest: CashAddressNetworkPrefix.regtest,
-};
-
-const literal = <L extends string>(l: L): L => l;
-
-export const UnitEnum = {
-  BCH: literal("bch"),
-  USD: literal("usd"),
-  SAT: literal("sat"),
-};
-export type UnitEnum = typeof UnitEnum[keyof typeof UnitEnum];