@xchainjs/xchain-doge 0.5.6 → 0.5.8

package/lib/client.d.ts

@@ -3,6 +3,7 @@ import { Address } from '@xchainjs/xchain-util';
 export declare type DogecoinClientParams = XChainClientParams & {
     sochainUrl?: string;
     blockcypherUrl?: string;
+    sochainApiKey: string;
 };
 /**
  * Custom Dogecoin client
@@ -10,6 +11,7 @@ export declare type DogecoinClientParams = XChainClientParams & {
 declare class Client extends UTXOClient {
     private sochainUrl;
     private blockcypherUrl;
+    private sochainApiKey;
     /**
      * Constructor
      * Client is initialised with network type
@@ -17,7 +19,7 @@ declare class Client extends UTXOClient {
      *
      * @param {DogecoinClientParams} params
      */
-    constructor({ network, feeBounds, sochainUrl, blockcypherUrl, phrase, rootDerivationPaths, }: DogecoinClientParams);
+    constructor({ network, feeBounds, sochainApiKey, sochainUrl, blockcypherUrl, phrase, rootDerivationPaths, }: DogecoinClientParams);
     /**
      * Set/Update the sochain url.
      *
@@ -90,6 +92,14 @@ declare class Client extends UTXOClient {
      * @returns {Balance[]} The Doge balance of the address.
      */
     getBalance(address: Address): Promise<Balance[]>;
+    /**
+     * helper function tto limit adding to an array
+     *
+     * @param arr array to be added to
+     * @param toAdd elements to add
+     * @param limit do not add more than this limit
+     */
+    private addArrayUpToLimit;
     /**
      * Get transaction history of a given address with pagination options.
      * By default it will return the transaction history of the current wallet.

package/lib/const.d.ts

@@ -1,4 +1,4 @@
-import { Asset, Chain } from '@xchainjs/xchain-util';
+import { Asset } from '@xchainjs/xchain-util';
 /**
  * Minimum transaction fee
  * 100000 satoshi/kB (similar to current `minrelaytxfee`)
@@ -12,7 +12,7 @@ export declare const UPPER_FEE_BOUND = 20000000;
  * Chain identifier for Dogecoin
  *
  */
-export declare const DOGEChain: Chain;
+export declare const DOGEChain: "DOGE";
 /**
  * Base "chain" asset on dogecoin
  *

package/lib/index.esm.js

@@ -84951,7 +84951,6 @@ const AssetDOGE = { chain: DOGEChain, symbol: 'DOGE', ticker: 'DOGE', synth: fal
 const toSochainNetwork = (network) => {
     switch (network) {
         case Network.Mainnet:
-            return 'DOGE';
         case Network.Stagenet:
             return 'DOGE';
         case Network.Testnet:
@@ -84959,26 +84958,26 @@ const toSochainNetwork = (network) => {
     }
 };
 const getSendTxUrl$1 = ({ sochainUrl, network }) => {
-    return `${sochainUrl}/send_tx/${toSochainNetwork(network)}`;
+    return `${sochainUrl}/broadcast_transaction/${toSochainNetwork(network)}`;
 };
 /**
- * Get address information.
+ * Get transaction by hash.
  *
- * @see https://sochain.com/api#get-display-data-address
+ * @see https://sochain.com/api#get-tx
  *
  * @param {string} sochainUrl The sochain node url.
- * @param {string} network
- * @param {string} address
- * @returns {DogeAddressDTO}
+ * @param {string} network network id
+ * @param {string} hash The transaction hash.
+ * @returns {Transactions}
  */
-const getAddress = ({ sochainUrl, network, address, }) => __awaiter(void 0, void 0, void 0, function* () {
-    const url = `${sochainUrl}/address/${toSochainNetwork(network)}/${address}`;
-    const response = yield axios.get(url);
-    const addressResponse = response.data;
-    return addressResponse.data;
+const getTx = ({ apiKey, sochainUrl, network, hash }) => __awaiter(void 0, void 0, void 0, function* () {
+    const url = `${sochainUrl}/transaction/${toSochainNetwork(network)}/${hash}`;
+    const response = yield axios.get(url, { headers: { 'API-KEY': apiKey } });
+    const tx = response.data;
+    return tx.data;
 });
 /**
- * Get transaction by hash.
+ * Get transactions
  *
  * @see https://sochain.com/api#get-tx
  *
@@ -84987,11 +84986,11 @@ const getAddress = ({ sochainUrl, network, address, }) => __awaiter(void 0, void
  * @param {string} hash The transaction hash.
  * @returns {Transactions}
  */
-const getTx = ({ sochainUrl, network, hash }) => __awaiter(void 0, void 0, void 0, function* () {
-    const url = `${sochainUrl}/get_tx/${toSochainNetwork(network)}/${hash}`;
-    const response = yield axios.get(url);
-    const tx = response.data;
-    return tx.data;
+const getTxs = ({ apiKey, address, sochainUrl, network, page, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const url = `${sochainUrl}/transactions/${toSochainNetwork(network)}/${address}/${page}`; //TODO support paging
+    const response = yield axios.get(url, { headers: { 'API-KEY': apiKey } });
+    const txs = response.data;
+    return txs.data;
 });
 /**
  * Get address balance.
@@ -85003,12 +85002,12 @@ const getTx = ({ sochainUrl, network, hash }) => __awaiter(void 0, void 0, void
  * @param {string} address
  * @returns {number}
  */
-const getBalance = ({ sochainUrl, network, address, }) => __awaiter(void 0, void 0, void 0, function* () {
-    const url = `${sochainUrl}/get_address_balance/${toSochainNetwork(network)}/${address}`;
-    const response = yield axios.get(url);
+const getBalance = ({ apiKey, sochainUrl, network, address }) => __awaiter(void 0, void 0, void 0, function* () {
+    const url = `${sochainUrl}/balance/${toSochainNetwork(network)}/${address}`;
+    const response = yield axios.get(url, { headers: { 'API-KEY': apiKey } });
     const balanceResponse = response.data;
-    const confirmed = assetAmount(balanceResponse.data.confirmed_balance, DOGE_DECIMAL);
-    const unconfirmed = assetAmount(balanceResponse.data.unconfirmed_balance, DOGE_DECIMAL);
+    const confirmed = assetAmount(balanceResponse.data.confirmed, DOGE_DECIMAL);
+    const unconfirmed = assetAmount(balanceResponse.data.unconfirmed, DOGE_DECIMAL);
     const netAmt = confirmed.amount().plus(unconfirmed.amount());
     const result = assetToBase(assetAmount(netAmt, DOGE_DECIMAL));
     return result;
@@ -85023,24 +85022,19 @@ const getBalance = ({ sochainUrl, network, address, }) => __awaiter(void 0, void
  * @param {string} address
  * @returns {DogeAddressUTXO[]}
  */
-const getUnspentTxs = ({ sochainUrl, network, address, startingFromTxId, }) => __awaiter(void 0, void 0, void 0, function* () {
-    let resp = null;
-    if (startingFromTxId) {
-        resp = yield axios.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}/${startingFromTxId}`);
-    }
-    else {
-        resp = yield axios.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}`);
-    }
+const getUnspentTxs = ({ apiKey, sochainUrl, network, address, page, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const url = [sochainUrl, 'unspent_outputs', toSochainNetwork(network), address, page].filter((v) => !!v).join('/');
+    const resp = yield axios.get(url, { headers: { 'API-KEY': apiKey } });
     const response = resp.data;
-    const txs = response.data.txs;
-    if (txs.length === 100) {
+    const txs = response.data.outputs;
+    if (txs.length === 10) {
         //fetch the next batch
-        const lastTxId = txs[99].txid;
         const nextBatch = yield getUnspentTxs({
+            apiKey,
             sochainUrl,
             network,
             address,
-            startingFromTxId: lastTxId,
+            page: page + 1,
         });
         return txs.concat(nextBatch);
     }
@@ -86504,43 +86498,52 @@ const validateAddress = (address, network) => {
     }
 };
 // Stores list of txHex in memory to avoid requesting same data
-const txHexMap = {};
-/**
- * Helper to get `hex` of `Tx`
- *
- * It will try to get it from cache before requesting it from Sochain
- */
-const getTxHex = ({ txHash, sochainUrl, network, }) => __awaiter(void 0, void 0, void 0, function* () {
-    // try to get hex from cache
-    const txHex = txHexMap[txHash];
-    if (!!txHex)
-        return txHex;
-    // or get it from Sochain
-    const { tx_hex } = yield getTx({ hash: txHash, sochainUrl, network });
-    // cache it
-    txHexMap[txHash] = tx_hex;
-    return tx_hex;
-});
+// const txHexMap: Record<TxHash, string> = {}
+// /**
+//  * Helper to get `hex` of `Tx`
+//  *
+//  * It will try to get it from cache before requesting it from Sochain
+//  */
+// const getTxHex = async ({
+//   apiKey,
+//   txHash,
+//   sochainUrl,
+//   network,
+// }: {
+//   apiKey: string
+//   sochainUrl: string
+//   txHash: TxHash
+//   network: Network
+// }): Promise<string> => {
+//   // try to get hex from cache
+//   const txHex = txHexMap[txHash]
+//   if (!!txHex) return txHex
+//   // or get it from Sochain
+//   const { tx_hex } = await sochain.getTx({ apiKey, hash: txHash, sochainUrl, network })
+//   // cache it
+//   txHexMap[txHash] = tx_hex
+//   return tx_hex
+// }
 /**
  * Scan UTXOs from sochain.
  *
  * @param params
  * @returns {UTXO[]} The UTXOs of the given address.
  */
-const scanUTXOs = ({ sochainUrl, network, address, withTxHex, }) => __awaiter(void 0, void 0, void 0, function* () {
+const scanUTXOs = ({ apiKey, sochainUrl, network, address, }) => __awaiter(void 0, void 0, void 0, function* () {
     const utxos = yield getUnspentTxs({
+        apiKey,
         sochainUrl,
         network,
         address,
+        page: 1,
     });
-    return yield Promise.all(utxos.map((utxo) => __awaiter(void 0, void 0, void 0, function* () {
-        return ({
-            hash: utxo.txid,
-            index: utxo.output_no,
-            value: assetToBase(assetAmount(utxo.value, DOGE_DECIMAL)).amount().toNumber(),
-            txHex: withTxHex ? yield getTxHex({ txHash: utxo.txid, sochainUrl, network }) : undefined,
-        });
-    })));
+    return utxos.map((utxo) => ({
+        hash: utxo.hash,
+        index: utxo.index,
+        value: assetToBase(assetAmount(utxo.value, DOGE_DECIMAL)).amount().toNumber(),
+        txHex: utxo.tx_hex,
+    }));
 });
 /**
  * Build transcation.
@@ -86548,10 +86551,10 @@ const scanUTXOs = ({ sochainUrl, network, address, withTxHex, }) => __awaiter(vo
  * @param {BuildParams} params The transaction build options.
  * @returns {Transaction}
  */
-const buildTx = ({ amount, recipient, memo, feeRate, sender, network, sochainUrl, withTxHex = false, }) => __awaiter(void 0, void 0, void 0, function* () {
+const buildTx = ({ apiKey, amount, recipient, memo, feeRate, sender, network, sochainUrl, }) => __awaiter(void 0, void 0, void 0, function* () {
     if (!validateAddress(recipient, network))
         throw new Error('Invalid address');
-    const utxos = yield scanUTXOs({ sochainUrl, network, address: sender, withTxHex });
+    const utxos = yield scanUTXOs({ apiKey, sochainUrl, network, address: sender });
     if (utxos.length === 0)
         throw new Error('No utxos to send');
     const feeRateWhole = Number(feeRate.toFixed(0));
@@ -86576,12 +86579,12 @@ const buildTx = ({ amount, recipient, memo, feeRate, sender, network, sochainUrl
     // https://thornode.ninerealms.com/thorchain/inbound_addresses?height=7526662 (09-27-2022)
     // For now we increase it by 10x
     psbt.setMaximumFeeRate(7500000);
-    const params = { sochainUrl, network, address: sender };
+    // const params = { sochainUrl, network, address: sender }
     for (const utxo of inputs) {
         psbt.addInput({
             hash: utxo.hash,
             index: utxo.index,
-            nonWitnessUtxo: Buffer.from((yield getTx(Object.assign({ hash: utxo.hash }, params))).tx_hex, 'hex'),
+            nonWitnessUtxo: Buffer.from(utxo.txHex, 'hex'),
         });
     }
     // Outputs
@@ -86681,7 +86684,7 @@ class Client extends UTXOClient {
     constructor({ network = Network.Mainnet, feeBounds = {
         lower: LOWER_FEE_BOUND,
         upper: UPPER_FEE_BOUND,
-    }, sochainUrl = 'https://sochain.com/api/v2', blockcypherUrl = 'https://api.blockcypher.com/v1', phrase, rootDerivationPaths = {
+    }, sochainApiKey, sochainUrl = 'https://sochain.com/api/v3', blockcypherUrl = 'https://api.blockcypher.com/v1', phrase, rootDerivationPaths = {
         [Network.Mainnet]: `m/44'/3'/0'/0/`,
         [Network.Stagenet]: `m/44'/3'/0'/0/`,
         [Network.Testnet]: `m/44'/1'/0'/0/`,
@@ -86691,6 +86694,7 @@ class Client extends UTXOClient {
         this.blockcypherUrl = '';
         this.setSochainUrl(sochainUrl);
         this.setBlockcypherUrl(blockcypherUrl);
+        this.sochainApiKey = sochainApiKey;
     }
     /**
      * Set/Update the sochain url.
@@ -86718,7 +86722,6 @@ class Client extends UTXOClient {
     getExplorerUrl() {
         switch (this.network) {
             case Network.Mainnet:
-                return 'https://blockchair.com/dogecoin';
             case Network.Stagenet:
                 return 'https://blockchair.com/dogecoin';
             case Network.Testnet:
@@ -86817,12 +86820,28 @@ class Client extends UTXOClient {
     getBalance(address) {
         return __awaiter(this, void 0, void 0, function* () {
             return getBalance$1({
+                apiKey: this.sochainApiKey,
                 sochainUrl: this.sochainUrl,
                 network: this.network,
                 address,
             });
         });
     }
+    /**
+     * helper function tto limit adding to an array
+     *
+     * @param arr array to be added to
+     * @param toAdd elements to add
+     * @param limit do not add more than this limit
+     */
+    addArrayUpToLimit(arr, toAdd, limit) {
+        for (let index = 0; index < toAdd.length; index++) {
+            const element = toAdd[index];
+            if (arr.length < limit) {
+                arr.push(element);
+            }
+        }
+    }
     /**
      * Get transaction history of a given address with pagination options.
      * By default it will return the transaction history of the current wallet.
@@ -86833,39 +86852,44 @@ class Client extends UTXOClient {
     getTransactions(params) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            // Sochain API doesn't have pagination parameter
             const offset = (_a = params === null || params === void 0 ? void 0 : params.offset) !== null && _a !== void 0 ? _a : 0;
             const limit = (params === null || params === void 0 ? void 0 : params.limit) || 10;
-            const response = yield getAddress({
-                sochainUrl: this.sochainUrl,
-                network: this.network,
-                address: `${params === null || params === void 0 ? void 0 : params.address}`,
-            });
-            const total = response.txs.length;
-            const transactions = [];
-            const txs = response.txs.filter((_, index) => offset <= index && index < offset + limit);
-            for (const txItem of txs) {
-                const rawTx = yield getTx({
-                    sochainUrl: this.sochainUrl,
-                    network: this.network,
-                    hash: txItem.txid,
-                });
-                const tx = {
-                    asset: AssetDOGE,
-                    from: rawTx.inputs.map((i) => ({
-                        from: i.address,
-                        amount: assetToBase(assetAmount(i.value, DOGE_DECIMAL)),
-                    })),
-                    to: rawTx.outputs
-                        // ignore tx with type 'nulldata'
-                        .filter((i) => i.type !== 'nulldata')
-                        .map((i) => ({ to: i.address, amount: assetToBase(assetAmount(i.value, DOGE_DECIMAL)) })),
-                    date: new Date(rawTx.time * 1000),
-                    type: TxType.Transfer,
-                    hash: rawTx.txid,
-                };
-                transactions.push(tx);
+            if (offset < 0 || limit < 0)
+                throw Error('ofset and limit must be equal or greater than 0');
+            const firstPage = Math.floor(offset / 10) + 1;
+            const lastPage = limit > 10 ? firstPage + Math.floor(limit / 10) : firstPage;
+            const offsetOnFirstPage = offset % 10;
+            const txHashesToFetch = [];
+            let page = firstPage;
+            try {
+                while (page <= lastPage) {
+                    const response = yield getTxs({
+                        apiKey: this.sochainApiKey,
+                        sochainUrl: this.sochainUrl,
+                        network: this.network,
+                        address: `${params === null || params === void 0 ? void 0 : params.address}`,
+                        page,
+                    });
+                    if (response.transactions.length === 0)
+                        break;
+                    if (page === firstPage && response.transactions.length > offsetOnFirstPage) {
+                        //start from offset
+                        const txsToGet = response.transactions.slice(offsetOnFirstPage);
+                        this.addArrayUpToLimit(txHashesToFetch, txsToGet.map((i) => i.hash), limit);
+                    }
+                    else {
+                        this.addArrayUpToLimit(txHashesToFetch, response.transactions.map((i) => i.hash), limit);
+                    }
+                    page++;
+                }
+            }
+            catch (error) {
+                console.error(error);
+                //an errors means no more results
             }
+            // console.log(JSON.stringify({ txHashesToFetch }, null, 2))
+            const total = txHashesToFetch.length;
+            const transactions = yield Promise.all(txHashesToFetch.map((hash) => this.getTransactionData(hash)));
             const result = {
                 total,
                 txs: transactions,
@@ -86882,6 +86906,7 @@ class Client extends UTXOClient {
     getTransactionData(txId) {
         return __awaiter(this, void 0, void 0, function* () {
             const rawTx = yield getTx({
+                apiKey: this.sochainApiKey,
                 sochainUrl: this.sochainUrl,
                 network: this.network,
                 hash: txId,
@@ -86895,7 +86920,7 @@ class Client extends UTXOClient {
                 to: rawTx.outputs.map((i) => ({ to: i.address, amount: assetToBase(assetAmount(i.value, DOGE_DECIMAL)) })),
                 date: new Date(rawTx.time * 1000),
                 type: TxType.Transfer,
-                hash: rawTx.txid,
+                hash: rawTx.hash,
             };
         });
     }
@@ -86921,6 +86946,7 @@ class Client extends UTXOClient {
             const feeRate = params.feeRate || (yield this.getSuggestedFeeRate());
             checkFeeBounds(this.feeBounds, feeRate);
             const { psbt } = yield buildTx({
+                apiKey: this.sochainApiKey,
                 amount: params.amount,
                 recipient: params.recipient,
                 memo: params.memo,
@@ -86928,7 +86954,6 @@ class Client extends UTXOClient {
                 sender: this.getAddress(fromAddressIndex),
                 sochainUrl: this.sochainUrl,
                 network: this.network,
-                withTxHex: false,
             });
             const dogeKeys = this.getDogeKeys(this.phrase, fromAddressIndex);
             psbt.signAllInputs(dogeKeys); // Sign all inputs