mainnet-js 3.1.7 → 4.0.0-next.10

package/src/wallet/Wif.watchOnly.test.ts

@@ -1,58 +0,0 @@
-import { RegTestWallet, TestNetWallet, Wallet } from "./Wif";
-import { initProviders, disconnectProviders } from "../network/Connection";
-
-beforeAll(async () => {
-  await initProviders();
-});
-afterAll(async () => {
-  await disconnectProviders();
-});
-
-describe(`Test creation of wallet from walletId`, () => {
-  test("Get a regtest wallet from string id", async () => {
-    const ADDRESS = "bchreg:qpttdv3qg2usm4nm7talhxhl05mlhms3ys43u76rn0";
-    const ADDRESS_TOKEN = "bchreg:zpttdv3qg2usm4nm7talhxhl05mlhms3ysjm0q59vu";
-
-    let w = await RegTestWallet.fromId(
-      "wif:regtest:cNfsPtqN2bMRS7vH5qd8tR8GMvgXyL5BjnGAKgZ8DYEiCrCCQcP6"
-    );
-
-    expect(w.cashaddr!.startsWith("bchreg:")).toBeTruthy();
-    expect(w.cashaddr!).toBe(ADDRESS);
-    expect(w.cashaddr!).toBe(ADDRESS);
-    expect(w.tokenaddr!).toBe(ADDRESS_TOKEN);
-    let w2 = await RegTestWallet.watchOnly(w.cashaddr!);
-
-    expect(w2.cashaddr!).toBe(ADDRESS);
-    expect(w2.cashaddr!).toBe(ADDRESS);
-    expect(w2.tokenaddr!).toBe(ADDRESS_TOKEN);
-
-    let w3 = await RegTestWallet.watchOnly(ADDRESS_TOKEN);
-    expect(w3.cashaddr!).toBe(ADDRESS);
-    expect(w3.cashaddr!).toBe(ADDRESS);
-    expect(w3.tokenaddr!).toBe(ADDRESS_TOKEN);
-  });
-
-  test("Get create a p2sh32 watch address", async () => {
-    const ADDRESS =
-      "bitcoincash:pvykylj7uk385669fjse37r2eknx35ngaalx805q2hul62lmx2fq2v5dx6g8w";
-
-    let w = await Wallet.watchOnly(
-      "bitcoincash:pvykylj7uk385669fjse37r2eknx35ngaalx805q2hul62lmx2fq2v5dx6g8w"
-    );
-
-    expect(w.cashaddr!.startsWith("bitcoincash:")).toBeTruthy();
-    expect(w.cashaddr!).toBe(ADDRESS);
-  });
-
-  test("Get create a p2sh watch address", async () => {
-    const ADDRESS = "bitcoincash:pzvts0uztwg32yvrx7xz9lp572dgnt20sy0dj993vx";
-
-    let w = await Wallet.watchOnly(
-      "bitcoincash:pzvts0uztwg32yvrx7xz9lp572dgnt20sy0dj993vx"
-    );
-
-    expect(w.cashaddr!.startsWith("bitcoincash:")).toBeTruthy();
-    expect(w.cashaddr!).toBe(ADDRESS);
-  });
-});

package/src/wallet/createWallet.ts

@@ -1,238 +0,0 @@
-import { prefixFromNetworkMap } from "../enum.js";
-import { getNamedWalletId } from "./Base.js";
-import { HDWallet, RegTestHDWallet, TestNetHDWallet } from "./HDWallet.js";
-import {
-  RegTestWatchWallet,
-  TestNetWatchWallet,
-  WatchWallet,
-} from "./Watch.js";
-import {
-  RegTestWallet,
-  RegTestWifWallet,
-  TestNetWallet,
-  TestNetWifWallet,
-  Wallet,
-  WifWallet,
-} from "./Wif.js";
-import { WalletRequestI, WalletResponseI } from "./interface.js";
-
-// Convenience map to access classes by types and network
-export const walletClassMap = {
-  wif: {
-    mainnet: () => {
-      return WifWallet;
-    },
-    testnet: () => {
-      return TestNetWifWallet;
-    },
-    regtest: () => {
-      return RegTestWifWallet;
-    },
-  },
-  seed: {
-    mainnet: () => {
-      return Wallet;
-    },
-    testnet: () => {
-      return TestNetWallet;
-    },
-    regtest: () => {
-      return RegTestWallet;
-    },
-  },
-  watch: {
-    mainnet: () => {
-      return WatchWallet;
-    },
-    testnet: () => {
-      return TestNetWatchWallet;
-    },
-    regtest: () => {
-      return RegTestWatchWallet;
-    },
-  },
-  hd: {
-    mainnet: () => {
-      return HDWallet;
-    },
-    testnet: () => {
-      return TestNetHDWallet;
-    },
-    regtest: () => {
-      return RegTestHDWallet;
-    },
-  },
-};
-
-/**
- * Check wallet type and network of a requested wallet for mismatches against retrieved from DB
- */
-function checkWalletTypeAndNetwork(wallet: Wallet, walletType, networkType) {
-  if (wallet.network != networkType) {
-    throw Error(
-      `A wallet already exists with name ${wallet.name}, but with network ${wallet.network} not ${networkType}, per request`
-    );
-  }
-  if (wallet.walletType != walletType) {
-    throw Error(
-      `A wallet already exists with name ${wallet.name}, but with type ${wallet.walletType} not ${walletType}, per request`
-    );
-  }
-}
-
-/**
- * Check if wallet exists
- * @param body A wallet request object
- * @returns A promise to the check result
- */
-export async function namedWalletExists(body): Promise<boolean> {
-  const walletType = body.type ? body.type : "seed";
-  const networkType = body.network ? body.network : "mainnet";
-  const name = body.name;
-
-  return await walletClassMap[walletType][networkType]().namedExists(name);
-}
-
-/**
- * Get or create a named wallet
- * @param name user friendly wallet alias
- * @param walletType wallet type
- * @param networkType wallet network type
- * @returns A promise to a new wallet object
- */
-export async function namedWallet(
-  name,
-  walletType,
-  networkType
-): Promise<Wallet> {
-  // Named wallets are saved in the database
-  if (!name) {
-    throw Error(`Wallet name is required for this operation`);
-  }
-
-  let wallet;
-  const dbName = prefixFromNetworkMap[networkType];
-  if (walletClassMap[walletType] !== undefined) {
-    wallet = await walletClassMap[walletType][networkType]().named(name);
-    checkWalletTypeAndNetwork(wallet, walletType, networkType);
-  } else {
-    const walletId = await getNamedWalletId(name, dbName);
-    if (walletId !== undefined) {
-      wallet = await walletFromId(walletId);
-      wallet.name = name;
-    } else {
-      throw Error(
-        "A named wallet, without wallet type, was passed but there was no corresponding record for the named wallet in the database."
-      );
-    }
-  }
-
-  return wallet;
-}
-
-/**
- * Replace or create a named wallet with a walletId
- * @param body A wallet request object
- * @returns A promise to a new wallet object
- */
-export async function replaceNamedWallet(body): Promise<Wallet> {
-  let wallet;
-  const walletType = body.type ? body.type : "seed";
-  const networkType = body.network ? body.network : "mainnet";
-  const name = body.name;
-  const walletId = body.walletId;
-
-  // Named wallets are saved in the database
-  if (!name || !walletId) {
-    throw Error(`Wallet name and walletId are required for this operation`);
-  }
-
-  wallet = await walletClassMap[walletType][networkType]().replaceNamed(
-    name,
-    walletId
-  );
-  return wallet;
-}
-
-/**
- * Create a new wallet
- * @param body A wallet request object
- * @returns A promise to a new wallet object
- */
-export async function createWallet(body: WalletRequestI): Promise<Wallet> {
-  const walletType = body.type ? body.type : "seed";
-  const networkType = body.network ? body.network : "mainnet";
-
-  // Named wallets are saved in the database
-  if (body.name && body.name.length > 0) {
-    const wallet = await namedWallet(body.name, walletType, networkType);
-    return wallet;
-  }
-  // This handles unsaved/unnamed wallets
-  else {
-    const walletClass = walletClassMap[walletType][networkType]();
-    const wallet = new walletClass();
-    wallet.walletType = walletType;
-    return wallet.initialize();
-  }
-}
-
-/**
- * Create a new wallet
- * @param walletRequest A wallet request object
- * @returns A new wallet object
- */
-export async function createWalletResponse(
-  walletRequest: WalletRequestI
-): Promise<WalletResponseI> {
-  const wallet = await createWallet(walletRequest);
-  if (wallet) {
-    return asJsonResponse(wallet);
-  } else {
-    throw Error("Error creating wallet");
-  }
-}
-
-/**
- * asJsonResponse return a wallet as json
- * @param wallet A wallet object
- * @returns A json wallet response
- */
-function asJsonResponse(wallet: Wallet): WalletResponseI {
-  if (wallet.mnemonic) {
-    return {
-      name: wallet.name,
-      cashaddr: wallet.cashaddr as string,
-      walletId: wallet.toString(),
-      ...wallet.getSeed(),
-      network: wallet.network as any,
-    };
-  } else {
-    return {
-      name: wallet.name,
-      cashaddr: wallet.cashaddr as string,
-      walletId: wallet.toString(),
-      network: wallet.network as any,
-    };
-  }
-}
-
-/**
- * walletFromId - get a wallet from a serialized wallet
- * @param {string} walletId A serialized wallet object
- * @returns A wallet
- */
-export async function walletFromId(walletId: string): Promise<any> {
-  const [walletType, network, name]: string[] = walletId.split(":");
-
-  if (walletType === "named") {
-    return await namedWallet(name, walletType, network);
-  }
-
-  const walletClass = walletClassMap[walletType][network]();
-  const wallet = new walletClass();
-  wallet.walletType = walletType;
-
-  await (wallet as any).fromId(walletId);
-  return wallet;
-}

package/src/wallet/enum.ts

@@ -1,18 +0,0 @@
-export enum WalletTypeEnum {
-  Named = "named",
-  Wif = "wif",
-  Seed = "seed",
-  Hd = "hd",
-  Watch = "watch",
-  PrivateKey = "privkey",
-}
-
-export enum FeePaidByEnum {
-  change = "change",
-  first = "firstOutput",
-  any = "anyOutputs",
-  last = "lastOutput",
-  changeThenFirst = "changeThenFirst",
-  changeThenAny = "changeThenAny",
-  changeThenLast = "changeThenLast",
-}

package/src/wallet/interface.ts

@@ -1,102 +0,0 @@
-import { WalletTypeEnum, FeePaidByEnum } from "./enum.js";
-import { NetworkEnum } from "../enum.js";
-import { ElectrumRawTransaction } from "../network/interface.js";
-import { Utxo } from "../interface.js";
-
-export interface WalletRequestI {
-  name?: string;
-  network?: string;
-  type?: WalletTypeEnum;
-  platform?: string;
-  walletId?: string;
-}
-
-export interface WalletResponseI {
-  name: string;
-  cashaddr?: string;
-  address?: string;
-  walletId: string;
-  network?: NetworkEnum;
-  wif?: string;
-  privkey?: string;
-  seed?: string;
-  derivationPath?: string;
-  parentDerivationPath?: string;
-}
-
-export interface WalletInfoI {
-  cashaddr?: string;
-  tokenaddr?: string;
-  isTestnet?: boolean;
-  name?: string;
-  network: NetworkEnum;
-  seed?: string;
-  derivationPath?: string;
-  parentDerivationPath?: string;
-  parentXPubKey?: string;
-  publicKey?: string;
-  publicKeyHash?: string;
-  privateKey?: string;
-  privateKeyWif?: string;
-  walletId: string;
-  walletDbEntry: string;
-}
-
-export interface SendRequestOptionsI {
-  utxoIds?: string[] | Utxo[];
-  changeAddress?: string;
-  slpSemiAware?: boolean; // a flag which requires an utxo to have more than 546 sats to be spendable and counted in the balance
-  queryBalance?: boolean;
-  awaitTransactionPropagation?: boolean;
-  feePaidBy?: FeePaidByEnum;
-  checkTokenQuantities?: boolean; // true
-  tokenOperation?: "send" | "genesis" | "mint" | "burn"; // undefined. internal use only
-  ensureUtxos?: Utxo[]; // ensure these inputs will be consumed in the transaction
-  buildUnsigned?: boolean; // false
-}
-
-export interface MnemonicI {
-  seed: string;
-  derivationPath: string;
-  parentDerivationPath: string;
-}
-
-export interface WalletI {
-  // Accessors
-  getDepositAddress(): string;
-  getTokenDepositAddress(): string;
-  // getSeed(): MnemonicI;
-  // getNetworkProvider(network: NetworkType): any;
-  // generate(): Promise<this>;
-
-  // Serialization
-  toString(): string;
-  toDbString(): string;
-
-  // Static constructors
-  // fromId(walletId: string): Promise<this>;
-  // fromSeed(mnemonic: string, derivationPath?: string): Promise<this>;
-  // newRandom(name: string, dbName?: string): Promise<this>;
-  // watchOnly(address: string): Promise<this>;
-  // named(name: string, dbName?: string, forceNew?: boolean): Promise<this>;
-  // namedExists(name: string, dbName?: string): Promise<boolean>;
-
-  // Funds
-  getBalance(): Promise<any>;
-  getMaxAmountToSend(params?: any): Promise<any>;
-  send(requests: any, options?: any): Promise<any>;
-  sendMax(address: string, options?: any): Promise<any>;
-}
-
-export interface WaitForTransactionOptions {
-  getTransactionInfo?: boolean;
-  getBalance?: boolean;
-  txHash?: string;
-}
-
-export interface WaitForTransactionResponse {
-  transactionInfo?: ElectrumRawTransaction;
-  balance?: bigint;
-}
-
-export type CancelFn = () => Promise<void>;

package/src/wallet/model.test.ts

@@ -1,24 +0,0 @@
-import { UtxoId } from "../interface";
-import { fromUtxoId, toUtxoId } from "./model";
-
-test("Should serialize utxo", () => {
-  const utxo = toUtxoId({
-    txid: "this",
-    vout: 42,
-  }).toString();
-  expect(utxo).toBe("this:42");
-});
-
-test("Should deserialize utxo", () => {
-  const utxo = fromUtxoId("this:42:1");
-  expect(utxo.txid).toBe("this");
-  expect(utxo.vout).toBe(42);
-});
-
-test("Should deserialize utxo", () => {
-  const u = {
-    txid: "this",
-    vout: 42,
-  } as UtxoId;
-  expect(toUtxoId(u)).toBe("this:42");
-});