@tradelayerprotocol/tradelayer 1.9.1

package/README.md

@@ -0,0 +1,217 @@
+# TradeLayer NPM Setup Guide
+
+This NPM package helps you connect to the TradeLayer API, set up a Litecoin node, and perform peer-to-peer trading on decentralized orderbooks. Follow the steps below to initialize the environment and get everything running smoothly.
+
+## Prerequisites
+
+- **Node.js**: Ensure that you have Node.js installed. You can download it from [here](https://nodejs.org/).
+- **Git**: Git must be installed on your system. You can download Git from [here](https://git-scm.com/).
+- **wget**: Ensure you have wget installed to download the Litecoin binaries.
+
+## Installation and Setup
+
+### Step 1: Install the NPM package
+
+In the directory of your choice, run the following command to install this package:
+
+```bash
+
+npm i tradelayer
+```
+## Step 2: Setup
+
+To run the TradeLayer setup script, use the following command from the root of your project where the NPM package is installed, chose the win or lin version for Windos and Linux formatting differences:
+
+```
+
+cd node_modules/tradelayer/
+
+./setup-win.sh
+
+./setup-winmain.sh
+
+./setup-lin.sh
+
+./setup-linmain.sh
+```
+
+Choose the 'main' versions if you're setting up for mainnet.
+
+If you get an err "Permission denied" running the bash, try:
+
+```
+chmod +x setup-lin.sh
+```
+
+Run the included setup script to automatically:
+
+- Fetch and install Litecoin binaries.
+- defines litecoin.conf file with default user/pass credentials and 18332 testnet port
+- Start `litecoind`.
+- Clone the TradeLayer.js repository and check out the correct branch (`txIndexRefactor`).
+- waits for RPC to become available on litecoind
+- Generates an address.
+- Start the TradeLayer API.
+
+The .sh output will end with something like this:
+
+```
+Wallet address created: tltc1q23fu03xr7m8muxrf3x8pvrvfhrlanct0lte9cu
+
+
+Building TradeLayer API...
+
+...<NPM install output>...
+
+Setup complete!
+
+```
+
+Copy the address and fund it with a testnet faucet (https://testnet.help/en/ltcfaucet/testnet) or mainnet LTC. We're adding our own algo testnet faucet to support this, coming soon.
+
+The API logic will grab your UTXOs from a loaded wallet using listunspent to build transactions.
+
+Be sure to backup wallet.dat files, a clearlist automated-signing app is coming to make this more secure using NEAR Chain Signatures and will be integrated into this NPM.
+
+Here's the rest of the example script to illustrate, copy this to a .js file and then drag it over from your local device to the ftp interface on your server, and drop it into the folder where you run npm i tradelayer. Run it after running the .sh and funding the new address:
+
+
+```js
+const ApiWrapper = require('tradelayer/algoAPI.js');
+const litecore = require('bitcoin-lib-ltc');
+const litecoinClient = require('tradelayer/litecoinClient.js');
+const api = new ApiWrapper('http://172.81.181.19', 9191);
+const OrderbookSession = require('tradelayer/orderbook.js');
+const io = require('socket.io-client');
+const axios = require('axios')
+const socket = new io('ws://172.81.181.19');
+const myInfo = {address:'',otherAddrs:[]};
+
+const client = litecoinClient(); // Use the litecoinClient for RPC commands
+
+// Start listening for order matches and handle swaps
+const orderbookSession = new OrderbookSession(socket, myInfo, client);
+const savedOrderUUIDs = []; // Array to store UUIDs of orders
+
+async function initializeApiAndStartSync() {
+    await api.initUntilSuccess(); // Call the init function and wait for it to complete
+    console.log('API Initialized successfully.');
+    await getUTXOBalances('')
+}
+
+// Example usage: call the function to initialize the API and start periodic sync checks
+initializeApiAndStartSync();
+// Example of fetching UTXO balances for a test address
+async function getUTXOBalances(address) {
+    try {
+        const utxos = await api.listUnspent(); // Fetch unspent transactions
+        const totalBalance = utxos.reduce((sum, utxo) => {
+            if (utxo.address === address) {
+                return sum + utxo.amount; // Sum balances for the specific address
+            }else if(address==''&&myInfo.address==''){
+                myInfo.address=utxo.address
+                console.log('Captured address'+myInfo.address)
+                return sum+ utxo.amount
+            }else if(address==''&&myInfo.address!=''){
+                myInfo.otherAddrs.push(utxo.address)
+                return sum+ utxo.amount
+            }
+            return sum;
+        }, 0);
+        console.log(`Total UTXO balance for address ${address}:`, totalBalance);
+    } catch (error) {
+        console.error('Error fetching UTXO balances:', error);
+    }
+}
+
+// Example of calling token balances
+async function getTokenBalances(address) {
+    try {
+        const response = await api.getAllTokenBalancesForAddress(address); // Assuming this method exists
+        console.log(`Token balances for address ${address}:`, response);
+    } catch (error) {
+        console.error('Error fetching token balances:', error);
+    }
+}
+
+// Define the async function
+async function performTradeOperations(testAddress) {
+    try {
+          console.log("awaiting init and address load")
+        await api.delay(10000);
+        if(myInfo.address){
+            testAddress=myInfo.address
+        }else{
+            console.log('awaiting UTXOs to mark the address')
+            api.delay(10000);
+            testAddress=myInfo.address
+        }
+
+
+        // Call getTokenBalances with your test address
+        await getTokenBalances(testAddress);
+
+        // Example of fetching spot markets
+        try {
+            const spotMarkets = await api.getSpotMarkets();
+            console.log('Spot Markets:', spotMarkets);
+        } catch (error) {
+            console.error('Error fetching spot markets:', error);
+        }
+
+        // Example of fetching futures markets
+        try {
+            const futuresMarkets = await api.getFuturesMarkets();
+            console.log('Futures Markets:', futuresMarkets);
+        } catch (error) {
+            console.error('Error fetching futures markets:', error);
+        }
+
+        // Example of sending an order
+        const orderDetails = {
+            type: 'SPOT',
+            action: 'BUY',
+            props: { id_for_sale: 0, id_desired: 1, price: 0.01, amount: 0.05 },
+            keypair: { address: 'some-address', pubkey: 'some-pubkey' },
+            isLimitOrder: true
+        };
+
+        try {
+            const orderUUID = await api.sendOrder(orderDetails);
+            console.log('Order sent, UUID:', orderUUID);
+            savedOrderUUIDs.push(orderUUID); // Save UUID to the array
+
+            // After saving, attempt to cancel the first order in the array
+            if (savedOrderUUIDs.length > 0) {
+                const orderToCancel = savedOrderUUIDs[0];
+                console.log(`Attempting to cancel order with UUID: ${orderToCancel}`);
+
+                try {
+                    const cancelResponse = await api.cancelOrder(orderToCancel);
+                    console.log(`Order with UUID: ${orderToCancel} canceled successfully!`);
+                } catch (error) {
+                    console.error(`Error canceling order with UUID: ${orderToCancel}`, error);
+                }
+            }
+        } catch (error) {
+            console.error('Error sending order:', error);
+        }
+
+        // Example of getting orderbook data
+        const filter = { type: 'SPOT', first_token: 0, second_token: 1 };
+        try {
+            const orderbookData = await api.getOrderbookData(filter);
+            console.log('Orderbook Data:', orderbookData);
+        } catch (error) {
+            console.error('Error fetching orderbook data:', error);
+        }
+
+    } catch (error) {
+        console.error('An error occurred during trade operations:', error);
+    }
+}
+
+// Example usage of the function
+performTradeOperations(myInfo.address);
+
+```

package/address.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Check if Litecoin daemon is running
+if ! pgrep litecoind > /dev/null
+then
+    echo "Litecoind is not running. Please start the Litecoin daemon first."
+    exit 1
+fi
+
+# Create a new Litecoin address
+ADDRESS=$(litecoin-cli -conf=litecoin.conf getnewaddress)
+
+# Validate the address and retrieve the public key (pubkey)
+PUBKEY=$(litecoin-cli -conf=litecoin.conf validateaddress "$ADDRESS" | jq -r '.pubkey')
+
+# Check if pubkey was retrieved
+if [ -z "$PUBKEY" ]; then
+  echo "Error: Could not retrieve the public key. Ensure the address belongs to the local wallet."
+  exit 1
+fi
+
+# Write the address and public key to the .env file
+echo "USER_ADDRESS=$ADDRESS" > .env
+echo "USER_PUBKEY=$PUBKEY" >> .env
+
+echo "Address and public key have been saved to .env"