@tradelayerprotocol/tradelayer 1.9.1

package/tradelayer.js/src/txEncoder.js

@@ -0,0 +1,610 @@
+const BigNumber = require('bignumber.js');
+const base94 = require('./base94.js');
+const base256 = require('./base256.js');
+const marker = 'tl';
+
+const Encode = {
+
+    encodeAmount: (amt) => {
+        const scaledAmt = new BigNumber(amt).times(1e8);
+        const isWholeNumber = amt % 1 === 0;
+
+        return isWholeNumber
+            ? amt?.toString(36) ?? '0'  // Base36 encoding for whole numbers
+            : scaledAmt.integerValue()?.toString(36) ?? '0' + '~';  // Base36 with `~` flag for decimals
+    },
+    // Encode Simple Token Issue Transaction
+    encodeActivateTradeLayer(params) {
+        const txTypeEncoded = Array.isArray(params.txTypeToActivate)
+                ? params.txTypeToActivate.join(';')
+                : params.txTypeToActivate;
+        const base36hex = BigInt('0x' + params.codeHash)?.toString(36) ?? '0'; // Hex to Base 36
+        //const base94Encoded = base94.hexToBase94(params.codeHash);
+        const type = 0;
+        return marker + type + txTypeEncoded + ',' + base36hex//base94Encoded;
+    },
+
+
+    // Encode Token Issue Transaction
+    encodeTokenIssue(params) {
+        const payload = [
+            params.initialAmount?.toString(36) ?? '0',
+            params.ticker,
+            params.whitelists.map(val => val?.toString(36) ?? '0').join(','),
+            params.managed ? '1' : '0', //turn into enum
+            params.backupAddress,
+            params.nft ? '1' : '0',
+        ];
+        const type = 1;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Send Transaction
+    encodeSend(params){
+        const { sendAll, address, propertyId, amount } = params;
+
+        if (sendAll) return `1;${address}`;
+
+        // Function to encode amounts using bimodal encoding
+        const encodeAmount = (amt) => {
+            const scaledAmt = new BigNumber(amt).times(1e8);
+            const isWholeNumber = Boolean(amt%1==0);
+
+            return isWholeNumber
+                ? amt?.toString(36) ?? '0'  // Normal base36 encoding
+                : scaledAmt.integerValue()?.toString(36) ?? '0' + '~';  // Base36 with `~` flag
+        };
+
+        if (Array.isArray(propertyId) && Array.isArray(amount)) {
+            const payload = [
+                '0',
+                '',
+                propertyId.map(id => id?.toString(36) ?? '0').join(','),
+                amount.map(encodeAmount).join(',')
+            ];
+            return payload.join(';');
+        } else {
+            const amountValue = Array.isArray(amount) ? amount[0] : amount;
+            const payload = [
+                '0',
+                address,
+                propertyId?.toString(36) ?? '0',
+                encodeAmount(amountValue)
+            ];
+            const txNumber = 2;
+            const txNumber36 = txNumber?.toString(36) ?? '0';
+            return `tl${txNumber36}${payload.join(';')}`;
+        }
+    },
+
+    encodePropertyId(propertyId) {
+        if (typeof propertyId === 'string' && propertyId.startsWith('s-')) {
+            const [_, collateralId, contractId] = propertyId.split('-');
+            const encodedCollateralId = parseInt(collateralId)?.toString(36) ?? '0';
+            const encodedContractId = parseInt(contractId)?.toString(36) ?? '0';
+            return `s-${encodedCollateralId}-${encodedContractId}`;
+        } else {
+            return propertyId?.toString(36) ?? '0';
+        }
+    },
+
+    // Encode Trade Token for UTXO Transaction
+    encodeTradeTokenForUTXO: (params) => {
+        const amount = new BigNumber(params.amount).times(1e8).toNumber();
+        const sats = new BigNumber(params.satsExpected).times(1e8).toNumber();
+        const isColoredOutput = params.isColoredOutput ? '1' : '0';
+        const payload = [
+            params.propertyId?.toString(36) ?? '0',
+            amount?.toString(36) ?? '0',
+            params.columnA,
+            sats?.toString(36) ?? '0',
+            params.tokenOutput,
+            params.payToAddress,
+            isColoredOutput,
+        ];
+        const type = 3;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Commit Token Transaction
+    encodeCommit: (params) => {
+        const amount = new BigNumber(params.amount).times(1e8)?.toString(36) ?? '0';
+        const channelAddress = params.channelAddress.length > 42 ? `ref:${params.ref || 0}` : params.channelAddress;
+        const payEnabled = params.payEnabled ? '1' : '0';
+        let clearLists = '';
+        if (params.clearLists) {
+            if (Array.isArray(params.clearLists)) {
+                clearLists = `[${params.clearLists.map(num => num?.toString(36) ?? '0').join(',')}]`;
+            } else {
+                clearLists = params.clearLists?.toString(36) ?? '0';
+            }
+        }
+
+        const isColoredOutput = params.isColoredOutput ? '1' : '0';
+        const payload = [
+            params.propertyId?.toString(36) ?? '0',
+            amount,
+            channelAddress,
+            payEnabled,
+            clearLists,
+            isColoredOutput,
+        ];
+        const type = 4;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode On-chain Token for Token Transaction
+    encodeOnChainTokenForToken: (params) => {
+        const amountOffered = new BigNumber(params.amountOffered).times(1e8).toNumber();
+        const amountExpected = new BigNumber(params.amountExpected).times(1e8).toNumber();
+        const payload = [
+            params.propertyIdOffered?.toString(36) ?? '0',
+            params.propertyIdDesired?.toString(36) ?? '0',
+            amountOffered?.toString(36) ?? '0',
+            amountExpected?.toString(36) ?? '0',
+            params.stop ? '1' : '0',
+            params.post ? '1' : '0',
+        ];
+        const type = 5;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode function to handle cancel orders
+    encodeCancelOrder: (params) => {
+        let encodedTx = params.isContract;
+
+        if (params.isContract) {
+            encodedTx += `,${params.contractId?.toString(36) ?? '0'},${params.cancelAll ? 1 : 0}`;
+        } else {
+            encodedTx += `,${params.offeredPropertyId?.toString(36) ?? '0'},${params.desiredPropertyId?.toString(36) ?? '0'},${params.cancelAll ? 1 : 0}`;
+        }
+
+        let priceEncoded;
+        if (params.cancelParams && params.cancelParams.price !== undefined) {
+            if (params.isContract == 0 || params.isContract == false) {
+                priceEncoded = new BigNumber(params.cancelParams.price).times(8)?.toString(36) ?? '0';
+            } else if (params.isContract == 1 || params.isContract == true) {
+                priceEncoded = params.cancelParams.price?.toString(36) ?? '0';
+            }
+
+            encodedTx += `,${priceEncoded}`;
+            encodedTx += `,${params.cancelParams.side?.toString(36) ?? '0'}`;
+        }
+
+        if (params.cancelParams && params.cancelParams.txid) {
+            encodedTx += `,${params.cancelParams.txid}`;
+        }
+
+        const type = 6;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + encodedTx;
+    },
+
+
+    // Encode Create Whitelist Transaction
+    encodeCreateWhitelist: (params) => {
+        const payload = [
+            params.backupAddress,
+            params.name,
+            params.url,
+            params.description,
+        ];
+        const type = 7;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    encodeUpdateAdmin: (params) => {
+        const payload = [
+            params.newAddress,
+            params.whitelist ? '1' : '0',
+            params.oracle ? '1' : '0',
+            params.token ? '1' : '0',
+            params.id?.toString(36) ?? '0',
+            params.updateBackup ? '1' : '0'
+        ];
+        const type = 8;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Issue Or Revoke Attestation Transaction
+    encodeIssueOrRevokeAttestation: (params) => {
+        const payload = [
+            params.revoke,
+            params.id?.toString(36) ?? '0',
+            params.targetAddress,
+            params.metaData
+        ];
+        const type = 9;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode AMM Pool Transaction
+    encodeAMMPool: (params) => {
+        const payload = [
+            params.isRedeem, 
+            params.isContract, 
+            params.id, 
+            params.amount, 
+            params.id2, 
+            params.amount2,
+        ];
+        const type = 10;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Create Oracle Transaction
+    encodeCreateOracle: (params) => {
+        const payload = [
+            params.ticker,
+            params.url,
+            params.backupAddress,
+            params.whitelists.map(whitelist => whitelist?.toString(36) ?? '0').join(','),
+            params.lag?.toString(36) ?? '0',
+            params.enum
+        ];
+        const type = 13;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Grant Managed Token Transaction
+    encodeGrantManagedToken: (params) => {
+        const amountGranted = new BigNumber(params.amountGranted).times(1e8).toNumber();
+        const payload = [
+            params.propertyid?.toString(36) ?? '0',
+            amountGranted?.toString(36) ?? '0',
+            params.addressToGrantTo,
+            params?.dlcHash
+        ];
+        const type = 11;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Redeem Managed Token Transaction
+    encodeRedeemManagedToken: (params) => {
+        const amountGranted = new BigNumber(params.amountGranted).times(1e8).toNumber();
+        const payload = [
+            params.propertyid?.toString(36) ?? '0',
+            amountGranted?.toString(36) ?? '0',
+            params.addressToGrantTo,
+        ];
+        const type = 12;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Publish Oracle Data Transaction
+    encodePublishOracleData: (params) => {
+        const formattedPrice = new BigNumber(params.price).times(1e4).toNumber()
+        const payload = [
+            params.oracleid?.toString(36) ?? '0',
+            formattedPrice?.toString(36) ?? '0',
+        ];
+        if (params.high !== undefined) {
+            payload.push(params.high?.toString(36) ?? '0');
+        }
+        if (params.low !== undefined) {
+            payload.push(params.low?.toString(36) ?? '0');
+        }
+        if (params.close !== undefined) {
+            payload.push(params.close?.toString(36) ?? '0');
+        }
+        const type = 14;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Close Oracle Transaction
+    encodeCloseOracle(id) {
+        const type = 15
+        const typeStr =type?.toString(36) ?? '0'
+      return marker+typeStr?.toString(36) ?? '0'+id?.toString(36) ?? '0'; // No parameters
+    },
+
+    encodeCreateFutureContractSeries: (params) => {
+        const onChainData = params.onChainData && params.onChainData.length > 0 ? 
+            params.onChainData.map(data => `${data[0][0]?.toString(36) ?? '0'}:${data[0][1]?.toString(36) ?? '0'}`).join(';')
+            : '';
+
+        const payload = [
+            params.native ? '1' : '0',
+            params.underlyingOracleId?.toString(36) ?? '0',
+            onChainData, // Use '' if empty or falsy; adjust as needed
+            params.notionalPropertyId?.toString(36) ?? '0', 
+            params.notionalValue?.toString(36) ?? '0',
+            params.collateralPropertyId?.toString(36) ?? '0',
+            params.leverage,
+            params.expiryPeriod !== undefined ? params.expiryPeriod?.toString(36) ?? '0' : '0',
+            params.series?.toString(36) ?? '0',
+            params.inverse ? '1' : '0',
+            params.fee !== undefined ? params.fee ? '1' : '0' : '0'
+        ];
+        const type = 16;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Exercise Derivative Transaction
+    encodeExerciseDerivative: (params) => {
+        const payload = [
+            params.derivativeContractId?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+        ];
+        const type = 17;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Trade Contract On-chain Transaction
+    // **✅ Encode Trade Contract Onchain**
+    encodeTradeContractOnchain: (params) => {
+        console.log('encoding payload for trade '+JSON.stringify(params))
+        const payload = [
+            params.contractId?.toString(36) ?? '0',
+            new BigNumber(params.price).times(1e8).integerValue().toString(36),
+            params.amount?.toString(36) ?? '0',
+            params.sell ? '1' : '0',
+            params.insurance ? '1' : '0',
+            params.reduce ? '1' : '0',
+            params.post ? '1' : '0',
+            params.stop ? '1' : '0'
+        ];
+        const type = 18;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Trade Contract in Channel Transaction
+    encodeTradeContractChannel: (params) => {
+        const payload = [
+            params.contractId?.toString(36) ?? '0',
+            new BigNumber(params.price).times(1e8).integerValue().toString(36),
+            params.amount?.toString(36) ?? '0',
+            params.columnAIsSeller ? '1' : '0',
+            params.expiryBlock?.toString(36) ?? '0',
+            params.insurance ? '1' : '0',
+            params.columnAIsMaker ? '1' : '0'
+        ];
+        const type = 19;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Trade Tokens in Channel Transaction
+    encodeTradeTokensChannel: (params) => {
+        const amountOffered = new BigNumber(params.amountOffered1).times(1e8).toNumber();
+        const amountDesired = new BigNumber(params.amountDesired2).times(1e8).toNumber();
+        const payload = [
+            params.propertyId1?.toString(36) ?? '0',
+            params.propertyId2?.toString(36) ?? '0',
+            amountOffered?.toString(36) ?? '0',
+            amountDesired?.toString(36) ?? '0',
+            params.columnAIsOfferer ? '1' : '0',
+            params.expiryBlock?.toString(36) ?? '0',
+            params.columnAIsMaker ? '1' : '0',
+            params.Id1ColoredOutput ? '1' : '0',
+            params.Id2ColoredOutput ? '1' : '0'
+        ];
+        const type = 20;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Withdrawal Transaction
+    encodeWithdrawal: (params) => {
+        const amounts = new BigNumber(params.amountOffered).times(1e8).toNumber().toString();
+        const withdrawAll = params.withdrawAll;
+        const propertyIds = params.propertyId?.toString(36) ?? '0';
+        const column = params.column; // 0 is A, 1 is B
+        const channelAddress = params.channelAddress.length > 42 ? `ref:${params.ref || 0}` : params.channelAddress;
+        const payload = [withdrawAll, propertyIds, amounts, column, channelAddress].join(',');
+        const type = 21;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload;
+    },
+
+    // Encode Transfer Transaction
+    encodeTransfer: (params) => {
+        const propertyId = params.propertyId?.toString(36) ?? '0';
+        const amounts = new BigNumber(params.amount).times(1e8)?.toString(36) ?? '0';
+        const isColumnA = params.isColumnA ? 1 : 0;
+        const pay = params.pay ? 1 : 0;
+        const payRef = params.payRef || '';
+        const destinationAddr = params.destinationAddr.length > 42 ? `ref:${params.ref || 0}` : params.destinationAddr;
+        const payload = [propertyId, amounts, isColumnA, destinationAddr, pay, payRef].join(',');
+        const type = 22;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload;
+    },
+
+    // Encode Settle Channel PNL Transaction
+    encodeSettleChannelPNL: (params) => {
+        const base256Encoded1 = Base256Converter.hexToBase256(params.tradeid);
+        const base256Encoded2 = Base256Converter.hexToBase256(params.settleid);
+        const base94Encoded = Base94Converter.decimalToBase94(params.markPrice);
+        const payload = [
+            base256Encoded1,
+            base256Encoded2,
+            base94Encoded,
+            params.close ? '1' : '0'
+        ];
+        const type = 23;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Mint Synthetic Transaction
+    encodeMintSynthetic: (params) => {
+        const payload = [
+            params.propertyIdUsed?.toString(36) ?? '0',
+            params.contractIdUsed?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+        ];
+        const type = 24;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Redeem Synthetic Transaction
+    encodeRedeemSynthetic: (params) =>{
+        const payload = [
+            params.propertyIdUsed?.toString(36) ?? '0',
+            params.contractIdUsed?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+        ];
+        const type = 25;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Pay to Tokens Transaction
+    encodePayToTokens: (params) =>{
+        const payload = [
+            params.propertyIdTarget?.toString(36) ?? '0',
+            params.propertyIdUsed?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+        ];
+        const type = 26;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Create Option Chain Transaction
+    encodeOptionTrade: (params) => {
+        // params: { ticker, price, amount, seller, expiryBlock, isMaker, comboTicker?, comboPrice?, comboAmount? }
+        const payload = [
+            params.contractId,
+            Encode.encodeAmount(params.price)?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+            params.columnAIsSeller,
+            params.expiryBlock?.toString(36) ?? '0',
+            params.columnAIsMaker ? '1' : '0'
+        ];
+
+        if (params.comboTicker && params.comboAmount) {
+            payload.push(params.comboTicker);
+            payload.push(Encode.encodeAmount(params.comboPrice)?.toString(36) ?? '0');
+            payload.push(params.comboAmount?.toString(36) ?? '0');
+        }
+
+        const type = 27;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Trade Bai Urbun Transaction
+    encodeTradeBaiUrbun: (params) => {
+        const payload = [
+            params.propertyIdDownPayment?.toString(36) ?? '0',
+            params.propertyIdToBeSold?.toString(36) ?? '0',
+            params.price?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+            params.expiryBlock?.toString(36) ?? '0',
+            params.tradeExpiryBlock?.toString(36) ?? '0',
+        ];
+        const type = 28;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Trade Murabaha Transaction
+    encodeTradeMurabaha: (params) => {
+        const payload = [
+            params.propertyIdDownPayment?.toString(36) ?? '0',
+            params.downPaymentPercent?.toString(36) ?? '0',
+            params.propertyIdToBeSold?.toString(36) ?? '0',
+            params.price?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+            params.expiryBlock?.toString(36) ?? '0',
+            params.installmentInterval?.toString(36) ?? '0',
+            params.tradeExpiryBlock?.toString(36) ?? '0',
+        ];
+        const type = 29;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    // Encode Issue Invoice Transaction
+    encodeStakeFraudProof: (params) => {
+        const payload = [
+            params.propertyIdToReceivePayment?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+            params.dueDateBlock?.toString(36) ?? '0',
+            params.optionalPropertyIdCollateral ? params.optionalPropertyIdCollateral?.toString(36) ?? '0' : '0',
+            params.receivesPayToToken ? '1' : '0',
+        ];
+        const type = 30;
+        const typeStr = type?.toString(36) ?? '0';
+        return marker + typeStr + payload.join(',');
+    },
+
+    encodeBatchSettlement: (params)=> {},
+    // Encode Batch Move Zk Rollup Transaction
+    encodeBatchMoveZkRollup: (params) => {
+        // Assuming params.payments is an array of payment objects
+        const paymentsPayload = params.payments.map(payment => {
+            const paymentDetails = [
+                payment.fromAddress,
+                payment.propertyIds.map(id => id?.toString(36) ?? '0').join(':'),
+                payment.amounts.map(amt => amt?.toString(36) ?? '0').join(':'),
+                payment.toAddress,
+                payment.sentPropertyIds.map(id => id?.toString(36) ?? '0').join(':'),
+                payment.sentAmounts.map(amt => amt?.toString(36) ?? '0').join(':'),
+            ];
+            return paymentDetails.join(',');
+        }).join(';');
+        const payload = [
+            params.proof,
+            paymentsPayload,
+            JSON.stringify(params.miscLogic),
+            JSON.stringify(params.miscData),
+        ];
+        return payload.join('|');
+    },
+
+
+    // Encode Create Derivative of LRC20 or RGB
+    encodeColoredCoin: (params) => {
+        const payload = [
+            params.encodeDecodeRecode, //0, decode, 1 encode, 2 repairs a channel theft/unauthorized UTXO movement
+            params.propertyId?.toString(36) ?? '0', //the TL account token being encoded
+            params.SatsRatio?.toString(36) ?? '0', //how many sats of the account token are rounded to be encoded in 1 UTXO sat e.g. 100, 1000, 10000000
+            params.homeAddress //optional param to cite an addr such as a bridge or AMM depositee where this can recode if interrupted
+        ];
+        return payload.join(',');
+    },
+
+
+    // Encode cross TL chain bridging tx
+    encodeAbstractionBridge: (params) => {
+        const payload = [
+            params.propertyId?.toString(36) ?? '0',
+            params.amount?.toString(36) ?? '0',
+            params.destinationAddr
+        ];
+        return payload.join(',');
+    }, 
+
+    encodeBindSmartContract:(params)=> {
+         const payload = [
+            params.contractHash,
+            params.type,
+            params.hostChain
+        ];
+        //these are all going to be corroborated by an additional ordinal reveal, 
+        //containing the code of the contract, the OP_Return should be included
+        return payload.join(',');
+    } 
+
+}
+
+module.exports = Encode;