edge-currency-plugins 2.6.2 → 3.0.1

package/lib/src/common/utxobased/keymanager/types.d.ts

@@ -1,13 +1,13 @@
 import { Cleaner } from 'cleaners';
-import { InsufficientFundsError } from 'edge-core-js/types';
+import { EdgeTokenId, InsufficientFundsError } from 'edge-core-js/types';
 interface InsufficientFundsErrorOptsPlus {
-    currencyCode?: string;
+    tokenId: EdgeTokenId;
     networkFee?: string;
     networkFeeShortage?: string;
 }
 export declare class InsufficientFundsErrorPlus extends InsufficientFundsError {
     networkFeeShortage?: string;
-    constructor(opts?: InsufficientFundsErrorOptsPlus);
+    constructor(opts: InsufficientFundsErrorOptsPlus);
 }
 export declare const asMaybeInsufficientFundsErrorPlus: Cleaner<InsufficientFundsErrorPlus | undefined>;
 export {};

package/lib/src/common/utxobased/network/Blockbook.d.ts

@@ -1,31 +1,44 @@
 import { Cleaner } from 'cleaners';
 import { EdgeLog, EdgeTransaction } from 'edge-core-js/types';
 import { EngineEmitter } from '../../plugin/EngineEmitter';
-import { AddressResponse, AddresssMessageParams, AddressUtxosResponse, BroadcastTxResponse, InfoResponse, SubscribeAddressResponse, TransactionResponse } from './blockbookApi';
+import { AddressResponse, AddresssMessageParams, AddressUtxosResponse, BlockbookTask, BlockbookTransaction, BroadcastTxResponse, InfoResponse, SubscribeAddressResponse, TransactionResponse } from './blockbookApi';
 import Deferred from './Deferred';
-import { OnQueueSpaceCB } from './Socket';
+import { OnQueueSpaceCB, WsResponse, WsTask } from './Socket';
 import { SocketEmitter } from './SocketEmitter';
 export declare type WatchAddressesCB = (response: SubscribeAddressResponse) => void | Promise<void>;
 export declare type WatchBlocksCB = () => void | Promise<void>;
 export interface Blockbook {
     isConnected: boolean;
+    broadcastTx: (transaction: EdgeTransaction) => Promise<BroadcastTxResponse>;
     connect: () => Promise<void>;
     disconnect: () => Promise<void>;
-    onQueueSpace: (cb: OnQueueSpaceCB) => void;
-    fetchInfo: () => Promise<InfoResponse>;
     fetchAddress: (address: string, params?: AddresssMessageParams) => Promise<AddressResponse>;
-    watchAddresses: (addresses: string[], deferredAddressSub: Deferred<unknown>) => void;
-    watchBlocks: (deferredBlockSub: Deferred<unknown>) => void;
     fetchAddressUtxos: (account: string) => Promise<AddressUtxosResponse>;
+    fetchInfo: () => Promise<InfoResponse>;
     fetchTransaction: (hash: string) => Promise<TransactionResponse>;
-    broadcastTx: (transaction: EdgeTransaction) => Promise<BroadcastTxResponse>;
+    watchAddresses: (addresses: string[], deferredAddressSub: Deferred<unknown>) => void;
+    watchBlocks: (deferredBlockSub: Deferred<unknown>) => void;
+    onQueueSpace: (cb: OnQueueSpaceCB) => void;
+    promisifyWsMessage: <T>(message: BlockbookTask<T>) => Promise<T>;
+    addressQueryTask: (address: string, params: {
+        asBlockbookAddress?: Cleaner<string> | undefined;
+        lastQueriedBlockHeight: number;
+        page: number;
+    }, deferred: Deferred<AddressResponse>) => WsTask<AddressResponse>;
+    transactionQueryTask: (txId: string, deferred: Deferred<BlockbookTransaction>) => WsTask<BlockbookTransaction>;
+    transactionSpecialQueryTask: (txId: string, deferred: Deferred<unknown>) => WsTask<unknown>;
+    utxoListQueryTask: (address: string, params: {
+        asBlockbookAddress?: Cleaner<string> | undefined;
+    }, deferred: Deferred<AddressUtxosResponse>) => WsTask<AddressUtxosResponse>;
 }
 interface BlockbookConfig {
     asAddress?: Cleaner<string>;
+    asResponse?: Cleaner<WsResponse>;
     connectionUri: string;
     engineEmitter: EngineEmitter;
     log: EdgeLog;
     onQueueSpaceCB: OnQueueSpaceCB;
+    ping?: () => Promise<void>;
     socketEmitter: SocketEmitter;
     walletId: string;
 }

package/lib/src/common/utxobased/network/BlockbookElectrum.d.ts

@@ -0,0 +1,25 @@
+import { Cleaner } from 'cleaners';
+import { EdgeLog } from 'edge-core-js/types';
+import { EngineEmitter } from '../../plugin/EngineEmitter';
+import { PluginInfo } from '../../plugin/types';
+import { Blockbook } from './Blockbook';
+import { OnQueueSpaceCB } from './Socket';
+import { SocketEmitter } from './SocketEmitter';
+export interface BlockbookElectrumConfig {
+    asAddress?: Cleaner<string>;
+    connectionUri: string;
+    engineEmitter: EngineEmitter;
+    log: EdgeLog;
+    onQueueSpaceCB: OnQueueSpaceCB;
+    pluginInfo: PluginInfo;
+    socketEmitter: SocketEmitter;
+    walletId: string;
+}
+export interface ElectrumResponseMessage {
+    id: number;
+    data: unknown;
+    error: {
+        message: string;
+    } | undefined;
+}
+export declare function makeBlockbookElectrum(config: BlockbookElectrumConfig): Blockbook;

package/lib/src/common/utxobased/network/Socket.d.ts

@@ -29,6 +29,7 @@ export interface Socket {
 }
 export declare type OnQueueSpaceCB = (uri: string) => Promise<WsTask<unknown> | boolean | undefined>;
 interface SocketConfig {
+    asResponse?: Cleaner<WsResponse>;
     queueSize?: number;
     timeout?: number;
     walletId: string;
@@ -37,5 +38,15 @@ interface SocketConfig {
     healthCheck: () => Promise<void>;
     onQueueSpaceCB: OnQueueSpaceCB;
 }
+export declare type WsResponse = WsResponseMessage[];
+export interface WsResponseMessage {
+    id: string;
+    data?: unknown;
+    error?: {
+        message: string;
+    } | {
+        connected: string;
+    };
+}
 export declare function makeSocket(uri: string, config: SocketConfig): Socket;
 export {};

package/lib/src/common/utxobased/network/blockbookApi.d.ts

@@ -1,5 +1,4 @@
 import { Cleaner } from 'cleaners';
-import { EdgeTransaction } from 'edge-core-js/types';
 /**
  * Websocket Task
  */
@@ -103,7 +102,7 @@ export declare const transactionMessageSpecific: (hash: string) => BlockbookTask
 /**
  * Send Transaction
  */
-export declare const broadcastTxMessage: (transaction: EdgeTransaction) => BlockbookTask<BroadcastTxResponse>;
+export declare const broadcastTxMessage: (signedTx: string) => BlockbookTask<BroadcastTxResponse>;
 export declare type BroadcastTxResponse = ReturnType<typeof asBroadcastTxResponse>;
 export declare const asBroadcastTxResponse: import("cleaners").ObjectCleaner<{
     result: string;
@@ -133,20 +132,7 @@ export interface AddressResponse {
     totalPages: number;
     itemsOnPage: number;
 }
-export declare const asAddressResponse: (asAddress?: Cleaner<string>) => import("cleaners").ObjectCleaner<{
-    address: string;
-    balance: string;
-    totalReceived: string;
-    totalSent: string;
-    txs: number;
-    unconfirmedBalance: string;
-    unconfirmedTxs: number;
-    txids: string[];
-    transactions: BlockbookTransaction[];
-    page: number;
-    totalPages: number;
-    itemsOnPage: number;
-}>;
+export declare const asAddressResponse: (asAddress?: Cleaner<string>) => Cleaner<AddressResponse>;
 /**
  * Subscribe New Block
  */

package/lib/src/common/utxobased/network/electrumApi.d.ts

@@ -0,0 +1,90 @@
+import { Cleaner } from 'cleaners';
+/**
+ * Websocket Task
+ */
+export interface ElectrumTask<T> {
+    method: string;
+    params: unknown;
+    cleaner: Cleaner<T>;
+}
+export interface ElectrumUtxo {
+    tx_pos: number;
+    value: number;
+    tx_hash: string;
+    height: number;
+}
+export declare const asElectrumUtxo: Cleaner<ElectrumUtxo>;
+export interface ElectrumTransaction {
+    blockhash: string;
+    blocktime: number;
+    confirmations: number;
+    hash: string;
+    hex: string;
+    locktime: number;
+    size: number;
+    time: number;
+    txid: string;
+    version: number;
+    vin: Array<{
+        scriptSig: {
+            asm: string;
+            hex: string;
+        };
+        sequence: number;
+        txid: string;
+        vout: number;
+    }>;
+    vout: Array<{
+        n: number;
+        scriptPubKey: {
+            addresses: string[];
+            asm: string;
+            hex: string;
+            reqSigs: number;
+            type: string;
+        };
+        value: number;
+    }>;
+}
+export declare const asElectrumTransaction: (asAddress?: Cleaner<string>) => Cleaner<ElectrumTransaction>;
+/**
+ * Error Response
+ */
+export declare type ElectrumErrorResponse = ReturnType<typeof asElectrumErrorResponse>;
+export declare const asElectrumErrorResponse: import("cleaners").ObjectCleaner<{
+    error: {
+        message: any;
+    };
+}>;
+/**
+ * Electrum Response Generic
+ */
+export declare type ElectrumResponse<T> = T;
+export declare const asElectrumResponse: <T>(asT: Cleaner<T>) => Cleaner<T>;
+/**
+ * Ping Message
+ */
+export declare const pingMessage: () => ElectrumTask<PingResponse>;
+export declare type PingResponse = ReturnType<typeof asPingResponse>;
+export declare const asPingResponse: Cleaner<undefined>;
+/**
+ * List Unspent (Get UTXOs)
+ */
+export declare const listUnspentMessage: (scriptHash: string) => ElectrumTask<ListUnspentResponse>;
+export declare type ListUnspentResponse = ElectrumUtxo[];
+export declare const asListUnspentResponse: Cleaner<ListUnspentResponse>;
+/**
+ * Get Address Transactions
+ */
+export declare const addressTransactionsMessage: (scriptHash: string) => ElectrumTask<AddressTransactionsResponse>;
+export declare type AddressTransactionsResponse = ReturnType<typeof asAddressTransactionsResponse>;
+export declare const asAddressTransactionsResponse: Cleaner<{
+    height: number;
+    tx_hash: string;
+}[]>;
+/**
+ * Get Transaction
+ */
+export declare const transactionMessage: (txHash: string, asAddress?: Cleaner<string>) => ElectrumTask<TransactionResponse>;
+export declare type TransactionResponse = ElectrumTransaction;
+export declare const asTransactionResponse: (asAddress?: Cleaner<string>) => Cleaner<ElectrumTransaction>;

package/lib/src/index.d.ts

@@ -1,4 +1,8 @@
 import { EdgeCorePlugins } from 'edge-core-js/types';
 declare const plugins: EdgeCorePlugins;
+declare global {
+    interface Window {
+        addEdgeCorePlugins?: (plugins: EdgeCorePlugins) => void;
+    }
+}
 export default plugins;
-export { setMemletConfig } from 'memlet';

package/lib/src/react-native.d.ts

@@ -0,0 +1,10 @@
+import { MemletConfig } from 'memlet';
+export declare const pluginUri: string;
+export declare const debugUri = "http://localhost:8084/edge-currency-plugins.js";
+export interface EdgeCurrencyPluginIoOptions {
+    readonly memletConfig?: MemletConfig;
+}
+export interface EdgeCurrencyPluginNativeIo {
+    readonly memletConfig?: MemletConfig;
+}
+export declare function makePluginIo(options?: EdgeCurrencyPluginIoOptions): EdgeCurrencyPluginNativeIo;

package/lib/test/utils.d.ts

@@ -1,10 +1,14 @@
 import { Disklet } from 'disklet';
 import { EdgeIo, EdgeLog } from 'edge-core-js/types';
 import { PluginInfo } from '../src/common/plugin/types';
+import { EdgeCurrencyPluginNativeIo } from '../src/react-native';
 export declare const makeFakePluginInfo: () => PluginInfo;
 export declare const makeFakeLog: () => EdgeLog;
 interface FakeIoConfig {
     disklet?: Disklet;
 }
 export declare const makeFakeIo: (config?: FakeIoConfig | undefined) => EdgeIo;
+export declare const makeFakeNativeIo: () => {
+    'edge-currency-plugins': EdgeCurrencyPluginNativeIo;
+};
 export {};

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "edge-currency-plugins",
-  "version": "2.6.2",
+  "version": "3.0.1",
   "description": "Edge currency plugins to fetch and process wallet accounts, balances and transactions.",
+  "homepage": "https://edge.app/",
   "repository": "https://github.com/EdgeApp/edge-currency-plugins",
   "license": "MIT",
   "author": "Airbitz, Inc.",
@@ -9,25 +10,31 @@
   "browser": {
     "ws": false
   },
-  "types": "./lib/src/index.d.ts",
+  "types": "./edge-currency-plugins.d.ts",
   "files": [
+    "/android/build.gradle",
+    "/android/src/*",
+    "/edge-currency-plugins.d.ts",
+    "/edge-currency-plugins.podspec",
+    "ios/*",
     "lib/*",
-    "package.json",
-    "README.md"
+    "/LICENSE",
+    "/package.json",
+    "/README.md"
   ],
   "scripts": {
-    "clean": "rimraf lib",
+    "clean": "rimraf android/src/main/assets/edge-currency-plugins dist lib",
     "coverage": "nyc mocha && nyc report --reporter=cobertura --reporter=html",
     "fix": "eslint . --fix",
     "lib": "sucrase -q -t typescript,imports -d ./lib ./src",
     "lint": "eslint .",
     "precommit": "lint-staged && npm-run-all types test",
-    "prepare": "husky install && npm-run-all clean -p lib types",
-    "start": "node -r sucrase/register src/index.ts",
-    "start.dev": "nodemon",
+    "prepare": "husky install && npm-run-all clean lib types webpack",
+    "start": "webpack serve",
     "test": "mocha",
     "types": "tsc",
-    "verify": "npm-run-all lint types"
+    "webpack": "webpack && cp -r android/src/main/assets/edge-currency-plugins dist",
+    "verify": "npm-run-all prepare lint types test"
   },
   "lint-staged": {
     "*.{js,ts,json}": "eslint"
@@ -59,6 +66,7 @@
     "ws": "^7.4.6"
   },
   "devDependencies": {
+    "@sucrase/webpack-loader": "^2.0.0",
     "@types/base-x": "^3.0.6",
     "@types/bn.js": "^5.1.0",
     "@types/bs58": "^4.0.1",
@@ -79,7 +87,8 @@
     "base-x": "^4.0.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
-    "edge-core-js": "^1.6.0",
+    "edge-core-js": "^2.5.0",
+    "esbuild-loader": "^4.1.0",
     "eslint": "^7.14.0",
     "eslint-config-standard-kit": "0.15.1",
     "eslint-plugin-import": "^2.22.1",
@@ -105,6 +114,10 @@
     "rimraf": "^3.0.2",
     "sucrase": "^3.12.1",
     "typescript": "^4.1.2",
+    "webpack": "^5.91.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^5.0.4",
     "wif": "^2.0.6"
-  }
+  },
+  "react-native": "./lib/react-native.js"
 }

package/lib/src/types.d.ts

@@ -1,6 +0,0 @@
-import { EdgeCorePlugins } from 'edge-core-js/types';
-declare global {
-    interface Window {
-        addEdgeCorePlugins?: (plugins: EdgeCorePlugins) => void;
-    }
-}