@shapeshiftoss/unchained-client 10.13.0 → 10.14.1

package/dist/utxo/litecoin/parser/__tests__/litecoin.test.js

@@ -0,0 +1,209 @@
+import { ltcAssetId, ltcChainId } from '@shapeshiftoss/caip';
+import { describe, expect, it, vi } from 'vitest';
+import { TransferType, TxStatus } from '../../../../types';
+import { TransactionParser } from '../index';
+import standardNoChange from './mockData/standardNoChange';
+import standardWithChange from './mockData/standardWithChange';
+const mocks = vi.hoisted(() => ({
+    get: vi.fn(),
+}));
+vi.mock('axios', () => {
+    const mockAxios = {
+        create: vi.fn(() => ({
+            get: mocks.get,
+        })),
+    };
+    return {
+        default: mockAxios,
+    };
+});
+const txParser = new TransactionParser({ chainId: ltcChainId, assetId: ltcAssetId, midgardUrl: '' });
+describe('parseTx', () => {
+    describe('standard', () => {
+        it('should be able to parse standard send with no change mempool', async () => {
+            const { txMempool } = standardNoChange;
+            const address = 'LZSEtkn8TLr5EpremqDq49CSUS1xGnkbX9';
+            const expected = {
+                txid: txMempool.txid,
+                blockHeight: txMempool.blockHeight,
+                blockTime: txMempool.timestamp,
+                confirmations: txMempool.confirmations,
+                status: TxStatus.Pending,
+                address,
+                chainId: ltcChainId,
+                fee: {
+                    assetId: ltcAssetId,
+                    value: '100000',
+                },
+                transfers: [
+                    {
+                        type: TransferType.Send,
+                        from: 'LZSEtkn8TLr5EpremqDq49CSUS1xGnkbX9',
+                        to: 'MVZSZBDqUsvzDZSvupJyPun2fb8UZKhSi7',
+                        assetId: ltcAssetId,
+                        totalValue: '340524408',
+                        components: [{ value: '340524408' }],
+                    },
+                ],
+            };
+            const actual = await txParser.parse(txMempool, address);
+            expect(expected).toEqual(actual);
+        });
+        it('should be able to parse standard send with no change', async () => {
+            const { tx } = standardNoChange;
+            const address = 'LZSEtkn8TLr5EpremqDq49CSUS1xGnkbX9';
+            const expected = {
+                txid: tx.txid,
+                blockHash: tx.blockHash,
+                blockHeight: tx.blockHeight,
+                blockTime: tx.timestamp,
+                confirmations: tx.confirmations,
+                status: TxStatus.Confirmed,
+                address,
+                chainId: ltcChainId,
+                fee: {
+                    assetId: ltcAssetId,
+                    value: '100000',
+                },
+                transfers: [
+                    {
+                        type: TransferType.Send,
+                        from: 'LZSEtkn8TLr5EpremqDq49CSUS1xGnkbX9',
+                        to: 'MVZSZBDqUsvzDZSvupJyPun2fb8UZKhSi7',
+                        assetId: ltcAssetId,
+                        totalValue: '340524408',
+                        components: [{ value: '340524408' }],
+                    },
+                ],
+            };
+            const actual = await txParser.parse(tx, address);
+            expect(expected).toEqual(actual);
+        });
+        it('should be able to parse standard receive with no change mempool', async () => {
+            const { txMempool } = standardNoChange;
+            const address = 'MVZSZBDqUsvzDZSvupJyPun2fb8UZKhSi7';
+            const expected = {
+                txid: txMempool.txid,
+                blockHeight: txMempool.blockHeight,
+                blockTime: txMempool.timestamp,
+                confirmations: txMempool.confirmations,
+                status: TxStatus.Pending,
+                address,
+                chainId: ltcChainId,
+                transfers: [
+                    {
+                        type: TransferType.Receive,
+                        from: 'LZSEtkn8TLr5EpremqDq49CSUS1xGnkbX9',
+                        to: 'MVZSZBDqUsvzDZSvupJyPun2fb8UZKhSi7',
+                        assetId: ltcAssetId,
+                        totalValue: '340424408',
+                        components: [{ value: '340424408' }],
+                    },
+                ],
+            };
+            const actual = await txParser.parse(txMempool, address);
+            expect(expected).toEqual(actual);
+        });
+        it('should be able to parse standard receive with no change', async () => {
+            const { tx } = standardNoChange;
+            const address = 'MVZSZBDqUsvzDZSvupJyPun2fb8UZKhSi7';
+            const expected = {
+                txid: tx.txid,
+                blockHash: tx.blockHash,
+                blockHeight: tx.blockHeight,
+                blockTime: tx.timestamp,
+                confirmations: tx.confirmations,
+                status: TxStatus.Confirmed,
+                address,
+                chainId: ltcChainId,
+                transfers: [
+                    {
+                        type: TransferType.Receive,
+                        from: 'LZSEtkn8TLr5EpremqDq49CSUS1xGnkbX9',
+                        to: 'MVZSZBDqUsvzDZSvupJyPun2fb8UZKhSi7',
+                        assetId: ltcAssetId,
+                        totalValue: '340424408',
+                        components: [{ value: '340424408' }],
+                    },
+                ],
+            };
+            const actual = await txParser.parse(tx, address);
+            expect(expected).toEqual(actual);
+        });
+        it('should be able to parse standard send with change mempool', async () => {
+            const { txMempool } = standardWithChange;
+            const address = 'LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef';
+            const expected = {
+                txid: txMempool.txid,
+                blockHeight: txMempool.blockHeight,
+                blockTime: txMempool.timestamp,
+                confirmations: txMempool.confirmations,
+                status: TxStatus.Pending,
+                address,
+                chainId: ltcChainId,
+                fee: {
+                    assetId: ltcAssetId,
+                    value: '100000',
+                },
+                transfers: [
+                    {
+                        type: TransferType.Send,
+                        to: 'LXPf92CJycUi5JogY3NXEgYqZygTkEXrsy',
+                        from: 'LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef',
+                        assetId: ltcAssetId,
+                        totalValue: '147680075',
+                        components: [{ value: '147680075' }],
+                    },
+                    {
+                        type: TransferType.Receive,
+                        to: 'LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef',
+                        from: 'LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef',
+                        assetId: ltcAssetId,
+                        totalValue: '31465800',
+                        components: [{ value: '31465800' }],
+                    },
+                ],
+            };
+            const actual = await txParser.parse(txMempool, address);
+            expect(expected).toEqual(actual);
+        });
+        it('should be able to parse standard send with change', async () => {
+            const { tx } = standardWithChange;
+            const address = 'LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef';
+            const expected = {
+                txid: tx.txid,
+                blockHash: tx.blockHash,
+                blockHeight: tx.blockHeight,
+                blockTime: tx.timestamp,
+                confirmations: tx.confirmations,
+                status: TxStatus.Confirmed,
+                address,
+                chainId: ltcChainId,
+                fee: {
+                    assetId: ltcAssetId,
+                    value: '100000',
+                },
+                transfers: [
+                    {
+                        type: TransferType.Send,
+                        to: 'LXPf92CJycUi5JogY3NXEgYqZygTkEXrsy',
+                        from: 'LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef',
+                        assetId: ltcAssetId,
+                        totalValue: '147680075',
+                        components: [{ value: '147680075' }],
+                    },
+                    {
+                        type: TransferType.Receive,
+                        to: 'LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef',
+                        from: 'LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef',
+                        assetId: ltcAssetId,
+                        totalValue: '31465800',
+                        components: [{ value: '31465800' }],
+                    },
+                ],
+            };
+            const actual = await txParser.parse(tx, address);
+            expect(expected).toEqual(actual);
+        });
+    });
+});

package/dist/utxo/litecoin/parser/__tests__/mockData/standardNoChange.d.ts

@@ -0,0 +1,6 @@
+import type { Tx } from '../../../../../generated/litecoin';
+declare const _default: {
+    tx: Tx;
+    txMempool: Tx;
+};
+export default _default;

package/dist/utxo/litecoin/parser/__tests__/mockData/standardNoChange.js

@@ -0,0 +1,36 @@
+const tx = {
+    txid: 'f4d3a8c60154f13e29719efdc00b7ce8147e1bd0b5d02863310dc8dd401ac689',
+    blockHash: '8a04b946cee33f094d196ac9b77b06002efa62025f458d06e2ea22757319d1ab',
+    blockHeight: 2305171,
+    timestamp: 1658947348,
+    confirmations: 1,
+    value: '340424408',
+    fee: '100000',
+    hex: '01000000013bf148be53ae49f142555335ba14ea297778c583ec53003ce0cdb4fbb4c7baa1020000006a47304402205b79ce288ceb094134064033cbb176058328e7282a0d4a388f8e3f9ecb0e5f4d022012a98c938a4009d45b6fee57d1ed0eb8a39a089e8e95bac1a6d103a08e06072e0121033128e1ee2a05b861f25f700c134eb21f9e88e92beb4ab23115fe419f179be5cefdffffff01d8764a140000000017a914ed9812ee29f62e6db1428dae7b1a2b32f8a30abd8700000000',
+    vin: [
+        {
+            txid: 'a1bac7b4fbb4cde03c0053ec83c5787729ea14ba35535542f149ae53be48f13b',
+            vout: '2',
+            sequence: 4294967293,
+            scriptSig: {
+                hex: '47304402205b79ce288ceb094134064033cbb176058328e7282a0d4a388f8e3f9ecb0e5f4d022012a98c938a4009d45b6fee57d1ed0eb8a39a089e8e95bac1a6d103a08e06072e0121033128e1ee2a05b861f25f700c134eb21f9e88e92beb4ab23115fe419f179be5ce',
+            },
+            addresses: ['LZSEtkn8TLr5EpremqDq49CSUS1xGnkbX9'],
+            value: '340524408',
+        },
+    ],
+    vout: [
+        {
+            value: '340424408',
+            n: 0,
+            scriptPubKey: {
+                hex: 'a914ed9812ee29f62e6db1428dae7b1a2b32f8a30abd87',
+            },
+            addresses: ['MVZSZBDqUsvzDZSvupJyPun2fb8UZKhSi7'],
+        },
+    ],
+};
+export default {
+    tx,
+    txMempool: { ...tx, blockHash: undefined, blockHeight: -1, confirmations: 0 },
+};

package/dist/utxo/litecoin/parser/__tests__/mockData/standardWithChange.d.ts

@@ -0,0 +1,6 @@
+import type { Tx } from '../../../../../generated/litecoin';
+declare const _default: {
+    tx: Tx;
+    txMempool: Tx;
+};
+export default _default;

package/dist/utxo/litecoin/parser/__tests__/mockData/standardWithChange.js

@@ -0,0 +1,44 @@
+const tx = {
+    txid: '2ff1b60d6c59f86d143a3fbf8fd73b45ef19d6fada27a6d94b925a06f03d0006',
+    blockHash: '8a04b946cee33f094d196ac9b77b06002efa62025f458d06e2ea22757319d1ab',
+    blockHeight: 2305171,
+    timestamp: 1658947348,
+    confirmations: 1,
+    value: '147580075',
+    fee: '100000',
+    hex: '020000000125c41131a88fc28fc9a77971e1aa414395c52e3be786b8eea8fc7b117f1d468b020000006a47304402204a27099396fbc3a71c76cea527a5d34361fa3e7bbdfb24997bc7881a43c51b8102206a3fb4e6cba7326ba69eb57055064b8565b42c3dc1f764088fb64fd4e1ef8a7c0121039762aeac7f2dfa57183ab23600f5107f0cc2007a223bbea994de8e876041974fffffffff0263c3eb06000000001976a91485775fe7ff34a6e1111102152a5b947570814fa288ac4821e001000000001976a9148054d8d8dd6bce91125bcfe8bbb473f54afcdc6088ac00000000',
+    vin: [
+        {
+            txid: '8b461d7f117bfca8eeb886e73b2ec5954341aae17179a7c98fc28fa83111c425',
+            vout: '2',
+            sequence: 4294967295,
+            scriptSig: {
+                hex: '47304402204a27099396fbc3a71c76cea527a5d34361fa3e7bbdfb24997bc7881a43c51b8102206a3fb4e6cba7326ba69eb57055064b8565b42c3dc1f764088fb64fd4e1ef8a7c0121039762aeac7f2dfa57183ab23600f5107f0cc2007a223bbea994de8e876041974f',
+            },
+            addresses: ['LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef'],
+            value: '147680075',
+        },
+    ],
+    vout: [
+        {
+            value: '116114275',
+            n: 0,
+            scriptPubKey: {
+                hex: '76a91485775fe7ff34a6e1111102152a5b947570814fa288ac',
+            },
+            addresses: ['LXPf92CJycUi5JogY3NXEgYqZygTkEXrsy'],
+        },
+        {
+            value: '31465800',
+            n: 1,
+            scriptPubKey: {
+                hex: '76a9148054d8d8dd6bce91125bcfe8bbb473f54afcdc6088ac',
+            },
+            addresses: ['LWvWQ3XMoipFsAqE1EZPQFUovLea7DC1ef'],
+        },
+    ],
+};
+export default {
+    tx,
+    txMempool: { ...tx, blockHash: undefined, blockHeight: -1, confirmations: 0 },
+};

package/dist/utxo/litecoin/parser/index.d.ts

@@ -1,6 +1,9 @@
-import { Tx } from '../../../generated/litecoin';
-import { BaseTransactionParser, BaseTransactionParserArgs } from '../../parser';
-export declare type TransactionParserArgs = BaseTransactionParserArgs;
+import type { Tx } from '../../../generated/litecoin';
+import type { BaseTransactionParserArgs } from '../../parser';
+import { BaseTransactionParser } from '../../parser';
+export interface TransactionParserArgs extends BaseTransactionParserArgs {
+    midgardUrl: string;
+}
 export declare class TransactionParser extends BaseTransactionParser<Tx> {
     constructor(args: TransactionParserArgs);
 }

package/dist/utxo/litecoin/parser/index.js

@@ -1,12 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionParser = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const parser_1 = require("../../parser");
-class TransactionParser extends parser_1.BaseTransactionParser {
+import { BaseTransactionParser } from '../../parser';
+import * as thorchain from '../../parser/thorchain';
+export class TransactionParser extends BaseTransactionParser {
     constructor(args) {
         super(args);
-        this.assetId = caip_1.ltcAssetId;
+        this.registerParsers([new thorchain.Parser({ midgardUrl: args.midgardUrl })]);
     }
 }
-exports.TransactionParser = TransactionParser;

package/dist/utxo/parser/index.d.ts

@@ -1,12 +1,23 @@
-import { AssetId, ChainId } from '@shapeshiftoss/caip';
+import type { AssetId, ChainId } from '@shapeshiftoss/caip';
 import type { utxo } from '@shapeshiftoss/common-api';
-import { ParsedTx } from '../../types';
+import type { ParsedTx } from '../parser';
+import type { SubParser } from './types';
+export * from './types';
 export interface BaseTransactionParserArgs {
     chainId: ChainId;
+    assetId: AssetId;
 }
 export declare class BaseTransactionParser<T extends utxo.Tx> {
     chainId: ChainId;
     assetId: AssetId;
+    private parsers;
     constructor(args: BaseTransactionParserArgs);
+    /**
+     * Register custom transaction sub parser to parse custom op return data
+     *
+     * _parsers should be registered from most generic first to most specific last_
+     */
+    registerParser(parser: SubParser<T>): void;
+    protected registerParsers(parsers: SubParser<T>[]): void;
     parse(tx: T, address: string): Promise<ParsedTx>;
 }

package/dist/utxo/parser/index.js

@@ -1,14 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseTransactionParser = void 0;
-const bignumber_js_1 = require("bignumber.js");
-const types_1 = require("../../types");
-const utils_1 = require("../../utils");
-class BaseTransactionParser {
+import { BigNumber } from 'bignumber.js';
+import { TransferType, TxStatus } from '../../types';
+import { aggregateTransfer } from '../../utils';
+export * from './types';
+export class BaseTransactionParser {
+    chainId;
+    assetId;
+    parsers = [];
     constructor(args) {
         this.chainId = args.chainId;
+        this.assetId = args.assetId;
+    }
+    /**
+     * Register custom transaction sub parser to parse custom op return data
+     *
+     * _parsers should be registered from most generic first to most specific last_
+     */
+    registerParser(parser) {
+        this.parsers.unshift(parser);
+    }
+    registerParsers(parsers) {
+        parsers.forEach(parser => this.registerParser(parser));
     }
     async parse(tx, address) {
+        const parserResults = await (async () => {
+            for (const parser of this.parsers) {
+                const result = await parser.parse(tx, address);
+                if (result)
+                    return result;
+            }
+        })();
         const parsedTx = {
             address,
             blockHash: tx.blockHash,
@@ -16,36 +36,49 @@ class BaseTransactionParser {
             blockTime: tx.timestamp,
             chainId: this.chainId,
             confirmations: tx.confirmations,
-            status: tx.confirmations > 0 ? types_1.TxStatus.Confirmed : types_1.TxStatus.Pending,
-            transfers: [],
+            status: tx.confirmations > 0 ? TxStatus.Confirmed : TxStatus.Pending,
+            transfers: parserResults?.transfers ?? [],
             txid: tx.txid,
+            trade: parserResults?.trade,
+            data: parserResults?.data,
         };
-        tx.vin.forEach((vin) => {
-            var _a, _b, _c, _d, _e, _f, _g;
-            if ((_a = vin.addresses) === null || _a === void 0 ? void 0 : _a.includes(address)) {
+        tx.vin.forEach(vin => {
+            if (vin.addresses?.includes(address)) {
                 // send amount
-                const sendValue = new bignumber_js_1.BigNumber((_b = vin.value) !== null && _b !== void 0 ? _b : 0);
+                const sendValue = new BigNumber(vin.value ?? 0);
                 if (sendValue.gt(0)) {
-                    parsedTx.transfers = (0, utils_1.aggregateTransfer)(parsedTx.transfers, types_1.TransferType.Send, this.assetId, (_d = (_c = vin.addresses) === null || _c === void 0 ? void 0 : _c[0]) !== null && _d !== void 0 ? _d : '', (_f = (_e = tx.vout[0].addresses) === null || _e === void 0 ? void 0 : _e[0]) !== null && _f !== void 0 ? _f : '', sendValue.toString(10));
+                    parsedTx.transfers = aggregateTransfer({
+                        assetId: this.assetId,
+                        from: vin.addresses?.[0] ?? '',
+                        to: tx.vout[0].addresses?.[0] ?? '',
+                        transfers: parsedTx.transfers,
+                        type: TransferType.Send,
+                        value: sendValue.toString(10),
+                    });
                 }
                 // network fee
-                const fees = new bignumber_js_1.BigNumber((_g = tx.fee) !== null && _g !== void 0 ? _g : 0);
+                const fees = new BigNumber(tx.fee ?? 0);
                 if (fees.gt(0)) {
                     parsedTx.fee = { assetId: this.assetId, value: fees.toString(10) };
                 }
             }
         });
-        tx.vout.forEach((vout) => {
-            var _a, _b, _c, _d, _e, _f;
-            if ((_a = vout.addresses) === null || _a === void 0 ? void 0 : _a.includes(address)) {
+        tx.vout.forEach(vout => {
+            if (vout.addresses?.includes(address)) {
                 // receive amount
-                const receiveValue = new bignumber_js_1.BigNumber((_b = vout.value) !== null && _b !== void 0 ? _b : 0);
+                const receiveValue = new BigNumber(vout.value ?? 0);
                 if (receiveValue.gt(0)) {
-                    parsedTx.transfers = (0, utils_1.aggregateTransfer)(parsedTx.transfers, types_1.TransferType.Receive, this.assetId, (_d = (_c = tx.vin[0].addresses) === null || _c === void 0 ? void 0 : _c[0]) !== null && _d !== void 0 ? _d : '', (_f = (_e = vout.addresses) === null || _e === void 0 ? void 0 : _e[0]) !== null && _f !== void 0 ? _f : '', receiveValue.toString(10));
+                    parsedTx.transfers = aggregateTransfer({
+                        assetId: this.assetId,
+                        from: tx.vin[0].addresses?.[0] ?? '',
+                        to: vout.addresses?.[0] ?? '',
+                        transfers: parsedTx.transfers,
+                        type: TransferType.Receive,
+                        value: receiveValue.toString(10),
+                    });
                 }
             }
         });
-        return parsedTx;
+        return Promise.resolve(parsedTx);
     }
 }
-exports.BaseTransactionParser = BaseTransactionParser;

package/dist/utxo/parser/mayachain.d.ts

@@ -0,0 +1,7 @@
+import { Parser as ThorchainParser } from './thorchain';
+export interface ParserArgs {
+    midgardUrl: string;
+}
+export declare class Parser extends ThorchainParser {
+    constructor(args: ParserArgs);
+}

package/dist/utxo/parser/mayachain.js

@@ -0,0 +1,8 @@
+import { Parser as MayachainParser } from '../../parser/mayachain';
+import { Parser as ThorchainParser } from './thorchain';
+export class Parser extends ThorchainParser {
+    constructor(args) {
+        super(args);
+        this.parser = new MayachainParser({ midgardUrl: args.midgardUrl });
+    }
+}

package/dist/utxo/parser/thorchain.d.ts

@@ -0,0 +1,10 @@
+import { Parser as ThorchainParser } from '../../parser/thorchain';
+import type { SubParser, Tx, TxSpecific } from '../parser';
+export interface ParserArgs {
+    midgardUrl: string;
+}
+export declare class Parser implements SubParser<Tx> {
+    protected parser: ThorchainParser<'thorchain' | 'mayachain'>;
+    constructor(args: ParserArgs);
+    parse(tx: Tx): Promise<TxSpecific | undefined>;
+}

package/dist/utxo/parser/thorchain.js

@@ -0,0 +1,17 @@
+import { Parser as ThorchainParser } from '../../parser/thorchain';
+const opReturnRegex = /OP_RETURN \((?<memo>[^)]+)\)/;
+export class Parser {
+    parser;
+    constructor(args) {
+        this.parser = new ThorchainParser({ midgardUrl: args.midgardUrl });
+    }
+    async parse(tx) {
+        const opReturn = tx.vout.find(vout => vout.opReturn)?.opReturn;
+        if (!opReturn)
+            return;
+        const memo = opReturn.match(opReturnRegex)?.groups?.memo;
+        if (!memo)
+            return;
+        return await this.parser.parse(memo);
+    }
+}

package/dist/utxo/parser/types.d.ts

@@ -0,0 +1,13 @@
+import type { utxo } from '@shapeshiftoss/common-api';
+import type * as mayachain from '../../parser/mayachain';
+import type * as thorchain from '../../parser/thorchain';
+import type { StandardTx } from '../../types';
+export type Tx = utxo.Tx;
+export type TxMetadata = thorchain.TxMetadata | mayachain.TxMetadata;
+export interface ParsedTx extends StandardTx {
+    data?: TxMetadata;
+}
+export type TxSpecific = Partial<Pick<ParsedTx, 'data' | 'trade' | 'transfers'>>;
+export interface SubParser<T extends Tx, U = TxSpecific> {
+    parse(tx: T, address: string): Promise<U | undefined>;
+}

package/dist/utxo/parser/types.js

@@ -0,0 +1 @@
+export {};

package/dist/websocket.d.ts

@@ -16,7 +16,7 @@ export interface TxsParams<T> {
     onMessage: (message: TransactionMessage<T>) => void;
     onError?: (err: ErrorResponse) => void;
 }
-export declare type SubscriptionId = string;
+export type SubscriptionId = string;
 export declare class Client<T> {
     private readonly url;
     private readonly connections;