evernode-js-client 0.6.18 → 0.6.20

package/index.js

@@ -53257,6 +53257,8 @@ const HOST_UPDATE_PARAM_SIZE = 123;
 
 const VOTE_VALIDATION_ERR = "VOTE_VALIDATION_ERR";
 
+const IPV6_FAMILY = 6;
+
 class HostClient extends BaseEvernodeClient {
 
     constructor(xrpAddress, xrpSecret, options = {}) {
@@ -53335,17 +53337,57 @@ class HostClient extends BaseEvernodeClient {
      * @param {number} leaseIndex Index number for the lease.
      * @param {number} leaseAmount Amount (EVRs) of the lease offer.
      * @param {string} tosHash Hex hash of the Terms Of Service text.
+     * @param {string} outboundIPAddress Assigned IP Address.
      */
-    async offerLease(leaseIndex, leaseAmount, tosHash) {
-        // <prefix><lease index 16)><half of tos hash><lease amount (int64)><identifier (uint32)>
+    async offerLease(leaseIndex, leaseAmount, tosHash, outboundIPAddress = null) {
+
+        // <prefix><version tag ("LTV"+uint8)><lease index (uint16)><half of tos hash><lease amount (int64)><identifier (uint32)><ip data>
+        // Lengths of sub sections.
         const prefixLen = EvernodeConstants.LEASE_TOKEN_PREFIX_HEX.length / 2;
+        const versionPrefixLen = EvernodeConstants.LEASE_TOKEN_VERSION_PREFIX_HEX.length / 2;
+        const versionLen = versionPrefixLen + 2; // ("LTV"<Version Number>)
+        const indexLen = 2;
         const halfToSLen = tosHash.length / 4;
-        const uriBuf = Buffer.allocUnsafe(prefixLen + halfToSLen + 14);
+        const leaseAmountLen = 8;
+        const identifierLen = 4;
+        const ipDataLen = 17;
+
+        // Offsets of sub sections
+        const versionPrefixOffset = prefixLen;
+        const versionOffset = prefixLen + versionPrefixLen;
+        const indexOffset = prefixLen + versionLen;
+        const halfTosHashOffset = prefixLen + versionLen + indexLen;
+        const leaseAmountOffset = prefixLen + versionLen + indexLen + halfToSLen;
+        const identifierOffset = prefixLen + versionLen + indexLen + halfToSLen + leaseAmountLen;
+        const ipDataOffset = prefixLen + versionLen + indexLen + halfToSLen + leaseAmountLen + identifierLen;
+
+        const uriBuf = Buffer.alloc((prefixLen + versionLen + indexLen + halfToSLen + leaseAmountLen + identifierLen + ipDataLen));
+
         Buffer.from(EvernodeConstants.LEASE_TOKEN_PREFIX_HEX, 'hex').copy(uriBuf);
-        uriBuf.writeUInt16BE(leaseIndex, prefixLen);
-        Buffer.from(tosHash, 'hex').copy(uriBuf, prefixLen + 2, 0, halfToSLen);
-        uriBuf.writeBigInt64BE(XflHelpers.getXfl(leaseAmount.toString()), prefixLen + 2 + halfToSLen);
-        uriBuf.writeUInt32BE((await this.xrplAcc.getSequence()), prefixLen + 10 + halfToSLen);
+        Buffer.from(EvernodeConstants.LEASE_TOKEN_VERSION_PREFIX_HEX, 'hex').copy(uriBuf, versionPrefixOffset, 0, versionPrefixLen);
+        uriBuf.writeUInt16BE(EvernodeConstants.LEASE_TOKEN_VERSION, versionOffset);
+        uriBuf.writeUInt16BE(leaseIndex, indexOffset);
+        Buffer.from(tosHash, 'hex').copy(uriBuf, halfTosHashOffset, 0, halfToSLen);
+        uriBuf.writeBigInt64BE(XflHelpers.getXfl(leaseAmount.toString()), leaseAmountOffset);
+        uriBuf.writeUInt32BE((await this.xrplAcc.getSequence()), identifierOffset);
+
+        if (outboundIPAddress) {
+            if (outboundIPAddress.includes(":")) {
+                uriBuf.writeUInt8(IPV6_FAMILY, ipDataOffset);
+                const ipBuf = Buffer.from(outboundIPAddress.split(':').map(v => {
+                    const bytes = [];
+                    for (let i = 0; i < v.length; i += 2) {
+                        bytes.push(parseInt(v.substr(i, 2), 16));
+                    }
+                    return bytes;
+                }).flat());
+
+                ipBuf.copy(uriBuf, ipDataOffset + 1, 0, ipDataLen);
+            } else {
+                throw "Invalid outbound IP address was provided";
+            }
+        }
+
         const uri = uriBuf.toString('base64');
 
         try {
@@ -54779,6 +54821,8 @@ const EvernodeConstants = {
     EVR: 'EVR',
     TOKEN_PREFIX_HEX: '657672686F7374', // evrhost
     LEASE_TOKEN_PREFIX_HEX: '6576726C65617365', // evrlease
+    LEASE_TOKEN_VERSION_PREFIX_HEX: '4C5456', // LTV (Lease_Token_Version)
+    LEASE_TOKEN_VERSION: 1,
     HOOK_NAMESPACE: '01EAF09326B4911554384121FF56FA8FECC215FDDE2EC35D9E59F2C53EC665A0',
     NOW_IN_EVRS: "0.00000001",
     HOOKS: [
@@ -56200,23 +56244,45 @@ const { Buffer } = __nccwpck_require__(4300);
 const { XflHelpers } = __nccwpck_require__(3243);
 const { EvernodeConstants } = __nccwpck_require__(9849);
 const { TransactionHelper } = __nccwpck_require__(7071);
+const { EvernodeHelpers } = __nccwpck_require__(2523);
 
 // Utility helper functions.
 class UtilHelpers {
 
     static decodeLeaseTokenUri(hexUri) {
         // Get the lease index from the token's URI.
-        // <prefix><lease index 16)><half of tos hash><lease amount (int64)><identifier (uint32)>
+        // <prefix><version>lease index 16)><half of tos hash><lease amount (int64)><identifier (uint32)><(ip numeric array)>
 
         const asciiUri = TransactionHelper.hexToASCII(hexUri);
         const uriBuf = Buffer.from(asciiUri, 'base64');
+        // Lengths of sub sections.
         const prefixLen = EvernodeConstants.LEASE_TOKEN_PREFIX_HEX.length / 2;
+        const versionPrefixLen = EvernodeConstants.LEASE_TOKEN_VERSION_PREFIX_HEX.length / 2;
+        const versionLen = versionPrefixLen + 2;
+        const indexLen = 2;
         const halfToSLen = 16;
+        const leaseAmountLen = 8;
+        const identifierLen = 4;
+        const ipDataLen = 17;
+
+        const isVersionedURI = EvernodeHelpers.isValidURI(hexUri, `${EvernodeConstants.LEASE_TOKEN_PREFIX_HEX}${EvernodeConstants.LEASE_TOKEN_VERSION_PREFIX_HEX}`);
+
+        // Offsets of sub sections
+        const versionPrefixOffset = prefixLen + versionPrefixLen;
+        const halfTosHashOffset = isVersionedURI ? (prefixLen + versionLen + indexLen) : (prefixLen + indexLen);
+        const leaseAmountOffset = isVersionedURI ? (prefixLen + versionLen + indexLen + halfToSLen) : (prefixLen + indexLen + halfToSLen);
+        const identifierOffset = isVersionedURI ? (prefixLen + versionLen + indexLen + halfToSLen + leaseAmountLen) : (prefixLen + indexLen + halfToSLen + leaseAmountLen);
+        const ipDataOffset = isVersionedURI ? (prefixLen + versionLen + indexLen + halfToSLen + leaseAmountLen + identifierLen) : (prefixLen + indexLen + halfToSLen + leaseAmountLen + identifierLen);
+
         return {
-            leaseIndex: uriBuf.readUint16BE(prefixLen),
-            halfTos: uriBuf.slice(prefixLen + 2, halfToSLen),
-            leaseAmount: parseFloat(XflHelpers.toString(uriBuf.readBigInt64BE(prefixLen + 2 + halfToSLen))),
-            identifier: uriBuf.length >= (prefixLen + 14 + halfToSLen) ? uriBuf.readUInt32BE(prefixLen + 10 + halfToSLen) : null
+            version: isVersionedURI ? `${uriBuf.slice(prefixLen, versionPrefixOffset).toString()}${uriBuf.readUint16BE(prefixLen + versionPrefixLen)}` : null,
+            leaseIndex: isVersionedURI ? uriBuf.readUint16BE(prefixLen + versionLen) : uriBuf.readUint16BE(prefixLen),
+            halfTos: uriBuf.slice(halfTosHashOffset, halfTosHashOffset + halfToSLen),
+            leaseAmount: parseFloat(XflHelpers.toString(uriBuf.readBigInt64BE(leaseAmountOffset))),
+            identifier: uriBuf.length > identifierOffset ? uriBuf.readUInt32BE(identifierOffset) : null,
+            outboundIP: (uriBuf.length > ipDataOffset && (uriBuf.readUint8(ipDataOffset) == 6))
+                ? { family: 6, address: uriBuf.slice(ipDataOffset + 1, ipDataOffset + 1 + ipDataLen).toString('hex').toUpperCase().replace(/(.{4})(?!$)/g, "$1:") }
+                : null
         }
     }
 
@@ -56229,6 +56295,7 @@ class UtilHelpers {
                 return time;
         }
     }
+
 }
 
 module.exports = {

package/package.json

@@ -6,7 +6,7 @@
     ],
     "homepage": "https://github.com/HotPocketDev/evernode-js-client",
     "license": "MIT",
-    "version": "0.6.18",
+    "version": "0.6.20",
     "dependencies": {
         "elliptic": "6.5.4",
         "libsodium-wrappers": "0.7.10",