@atomicfinance/types 2.5.0 → 3.0.1

package/lib/models/Input.ts

@@ -1,21 +1,20 @@
-import { bitcoin as bT } from '@liquality/types';
-
+import * as bT from '../bitcoin';
 import Amount from './Amount';
 import Utxo from './Utxo';
 
 /**
- * Class for interfacing with inputs/utxos in Liquality ChainAbstractionLayer
- * https://github.com/liquality/chainabstractionlayer
+ * Class for interfacing with inputs/utxos in Liquality Chainify
+ * https://github.com/liquality/chainify
  *
  * These inputs can have different fields for value
- * satoshis (sats): https://github.com/liquality/chainabstractionlayer/blob/dev/packages/bitcoin-esplora-api-provider/lib/BitcoinEsploraApiProvider.js#L65
- * amount (btc): https://github.com/liquality/chainabstractionlayer/blob/dev/packages/bitcoin-esplora-api-provider/lib/BitcoinEsploraApiProvider.js#L74
- * value (sats): https://github.com/liquality/chainabstractionlayer/blob/dev/packages/bitcoin-wallet-provider/lib/BitcoinWalletProvider.js#L331
+ * satoshis (sats): https://github.com/liquality/chainify/blob/dev/packages/bitcoin-esplora-api-provider/lib/BitcoinEsploraApiProvider.js#L65
+ * amount (btc): https://github.com/liquality/chainify/blob/dev/packages/bitcoin-esplora-api-provider/lib/BitcoinEsploraApiProvider.js#L74
+ * value (sats): https://github.com/liquality/chainify/blob/dev/packages/bitcoin-wallet-provider/lib/BitcoinWalletProvider.js#L331
  *
  * This will be fixed once typescript branch is merged:
- * https://github.com/liquality/chainabstractionlayer/tree/typescript
+ * https://github.com/liquality/chainify/tree/typescript
  * satoshis and amount will not be necessary, only value
- * https://github.com/liquality/chainabstractionlayer/blob/typescript/packages/types/lib/bitcoin.ts#L46
+ * https://github.com/liquality/chainify/blob/typescript/packages/types/lib/bitcoin.ts#L46
  */
 export default class Input {
   constructor(

package/lib/network.ts

@@ -0,0 +1,5 @@
+export interface Network {
+  name: string;
+  coinType: string;
+  isTestnet: boolean;
+}

package/lib/transaction.ts

@@ -0,0 +1,28 @@
+export interface Transaction<T = any> {
+  // Transaction hash
+  hash: string;
+  // The value of the transaction
+  value: number;
+  // transaction status
+  status?: TxStatus;
+  // Hash of the block containing the transaction
+  blockHash?: string;
+  // The block number containing the trnasaction
+  blockNumber?: number;
+  // The number of confirmations of the transaction
+  confirmations?: number;
+  // The price per unit of fee
+  feePrice?: number;
+  // The total fee paid for the transaction
+  fee?: number;
+  // Secret of a HTLC
+  secret?: string;
+  // The raw transaction object
+  _raw: T;
+}
+
+export enum TxStatus {
+  Pending = 'PENDING',
+  Failed = 'FAILED',
+  Success = 'SUCCESS',
+}

package/lib/wallet.ts

@@ -1,5 +1,114 @@
+import { Address } from './address';
+import Input from './models/Input';
+import Output from './models/Output';
+
 export interface finalizePSBTResponse {
   psbt: string;
   hex?: string;
   complete: boolean;
 }
+
+export interface WalletProvider {
+  /**
+   * Get addresses/accounts of the user.
+   * @param {number} [startingIndex] - Index to start
+   * @param {number} [numAddresses] - Number of addresses to retrieve
+   * @param {boolean} [change] - True for change addresses
+   * @return {Promise<Address[], InvalidProviderResponseError>} Resolves with a list
+   *  of addresses.
+   *  Rejects with InvalidProviderResponseError if provider's response is invalid.
+   */
+  getAddresses(
+    startingIndex?: number,
+    numAddresses?: number,
+    change?: boolean,
+  ): Promise<Address[]>;
+
+  /**
+   * Get used addresses/accounts of the user.
+   * @param {number} [numAddressPerCall] - Number of addresses to retrieve per call
+   * @return {Promise<Address[], InvalidProviderResponseError>} Resolves with a list
+   *  of addresses.
+   *  Rejects with InvalidProviderResponseError if provider's response is invalid.
+   */
+  getUsedAddresses(numAddressPerCall?: number): Promise<Address[]>;
+
+  /**
+   * findAddress is an optimized version of upstream CAL's findAddress.
+   *
+   * It searches through both change and non-change addresses (if change arg is not provided) each iteration.
+   *
+   * This is in contrast to the original findAddress function which searches
+   * through all non-change addresses before moving on to change addresses.
+   *
+   * @param addresses
+   * @returns {Promise<Address>}
+   */
+  findAddress(addresses: string[]): Promise<Address>;
+
+  /**
+   * Get unused address/account of the user.
+   * @param {boolean} [change] - True for change addresses
+   * @param {number} [numAddressPerCall] - Number of addresses to retrieve per call
+   * @return {Promise<Address, InvalidProviderResponseError>} Resolves with a address
+   *  object.
+   *  Rejects with InvalidProviderResponseError if provider's response is invalid.
+   */
+  getUnusedAddress(
+    change?: boolean,
+    numAddressPerCall?: number,
+  ): Promise<Address>;
+
+  /**
+   * Sign a message.
+   * @param {!string} message - Message to be signed.
+   * @param {!string} from - The address from which the message is signed.
+   * @return {Promise<string>} Resolves with a signed message.
+   */
+  signMessage(message: string, from: string): Promise<string>;
+
+  /**
+   * Retrieve the network connected to by the wallet
+   * @return {Promise<any>} Resolves with the network object
+   */
+  getConnectedNetwork(): Promise<any>;
+
+  /**
+   * Retrieve the availability status of the wallet
+   * @return {Promise<Boolean>} True if the wallet is available to use
+   */
+  isWalletAvailable(): Promise<boolean>;
+
+  /**
+   * Flag indicating if the wallet allows apps to update transaction fees
+   * @return {Promise<Boolean>} True if wallet accepts fee updating
+   */
+  canUpdateFee?: boolean | (() => boolean);
+
+  /**
+   * Exports the private key for the account
+   * for BTC, https://en.bitcoin.it/wiki/Wallet_import_format
+   * for ETH, the privateKey
+   * for NEAR, the secretKey
+   * @return {Promise<string>} Resolves with the key as a string
+   */
+  exportPrivateKey?: () => Promise<string>;
+
+  buildSweepTransactionWithSetOutputs(
+    externalChangeAddress: string,
+    feePerByte: number,
+    _outputs: Output[],
+    fixedInputs: Input[],
+  );
+
+  getUnusedAddressesBlacklist();
+
+  setUnusedAddressesBlacklist(unusedAddressesBlacklist);
+
+  sendSweepTransactionWithSetOutputs(
+    externalChangeAddress: string,
+    feePerByte: number,
+    _outputs: Output[],
+    fixedInputs: Input[],
+  );
+}

package/package.json

@@ -1,23 +1,21 @@
 {
   "name": "@atomicfinance/types",
   "umdName": "Types",
-  "version": "2.5.0",
-  "description": "CAL Finance Types",
+  "version": "3.0.1",
+  "description": "Bitcoin Abstraction Layer Types",
   "author": "Atomic Finance <info@atomic.finance>",
   "homepage": "",
   "license": "ISC",
   "main": "dist/index.js",
   "scripts": {
-    "build": "../../node_modules/.bin/swc lib --out-dir=dist --config-file=../../.swcrc",
+    "build": "../../node_modules/.bin/tsc --project tsconfig.json",
     "prepublishOnly": "yarn run build",
     "test": "yarn run build",
     "lint": "../../node_modules/.bin/eslint --ignore-path ../../.eslintignore  -c ../../.eslintrc.js .",
     "lint:fix": "../../node_modules/.bin/eslint --fix --ignore-path ../../.eslintignore  -c ../../.eslintrc.js ."
   },
   "dependencies": {
-    "@liquality/provider": "1.1.5",
-    "@liquality/types": "1.1.5",
-    "@node-dlc/messaging": "0.18.3",
+    "@node-dlc/messaging": "0.19.1",
     "@node-lightning/bitcoin": "0.26.1",
     "@node-lightning/noise": "0.26.1",
     "lodash": "^4.17.20"
@@ -28,6 +26,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "021537d74a46eb5bd578a7c4b122555e6b0a310f"
+  }
 }