trac-msb 0.3.0-beta.1 → 0.3.0-beta.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "trac-msb",
   "main": "msb.mjs",
-  "version": "0.3.0-beta.1",
+  "version": "0.3.0-beta.2",
   "pear": {
     "name": "trac-msb",
     "type": "terminal"
@@ -26,7 +26,7 @@
     "lint:fix": "eslint . --fix",
     "protobuf": "node scripts/generate-protobufs.js",
     "docs:check": "node scripts/docs/docs-checker.js",
-    "test:acceptance": "node --experimental-vm-modules node_modules/jest/bin/jest.js --testTimeout=200000 tests/acceptance/v1/rpc.test.mjs tests/acceptance/v1/htlc/htlc-routing.test.mjs --runInBand",
+    "test:acceptance": "node --experimental-vm-modules node_modules/jest/bin/jest.js --testTimeout=200000 tests/acceptance/v1/rpc.test.mjs tests/acceptance/v1/htlc/htlc-routing.test.mjs tests/acceptance/v1/current-epoch/current-epoch-routing.test.mjs tests/acceptance/v1/consensus-config/consensus-config-routing.test.mjs --runInBand",
     "test:integration": "brittle-node -t 1200000 tests/integration/integration.test.js",
     "test:unit:node": "brittle-node -t 60000 tests/unit/unit.test.js",
     "test:unit:bare": "brittle-bare -t 60000 tests/unit/unit.test.js",

package/rpc/handlers.js

@@ -456,3 +456,21 @@ export async function handleAccountDetails({ msbInstance, respond, req }) {
         stakedBalance: bufferToBigInt(nodeEntry.stakedBalance).toString(),
     });
 }
+
+export async function handleCurrentEpoch({ req, msbInstance, respond }) {
+    const confirmed = getConfirmedParameter(buildRequestUrl(req));
+    if (confirmed === null) {
+        return respond(400, { error: 'Parameter "confirmed" must be exactly "true" or "false"' });
+    }
+    const current_epoch = await msbInstance.getCurrentEpoch(confirmed);
+    respond(200, { current_epoch });
+}
+
+export async function handleConsensusConfig({ req, msbInstance, respond }) {
+    const confirmed = getConfirmedParameter(buildRequestUrl(req));
+    if (confirmed === null) {
+        return respond(400, { error: 'Parameter "confirmed" must be exactly "true" or "false"' });
+    }
+    const consensusConfig = await msbInstance.getConsensusConfig(confirmed);
+    respond(200, consensusConfig);
+}

package/rpc/routes/v1.js

@@ -15,6 +15,8 @@ import {
     handleHtlcClaim,
     handleHtlcRefund,
     handleHtlc,
+    handleCurrentEpoch,
+    handleConsensusConfig,
 } from '../handlers.js';
 
 export const v1Routes = [
@@ -34,4 +36,6 @@ export const v1Routes = [
     { method: 'POST', path: '/tx-payloads-bulk', handler: handleFetchBulkTxPayloads },
     { method: 'GET', path: '/tx/details', handler: handleTransactionExtendedDetails },
     { method: 'GET', path: '/account', handler: handleAccountDetails },
+    { method: 'GET', path: '/current-epoch', exact: true, handler: handleCurrentEpoch },
+    { method: 'GET', path: '/consensus-config', exact: true, handler: handleConsensusConfig },
 ];

package/src/core/state/State.js

@@ -676,6 +676,12 @@ class State extends ReadyResource {
         for await (const entry of historyStream) {
             if (isTransactionRecordPut(entry)) {
                 hashes.push({ hash: entry.key, confirmed_length: entry.seq });
+            } else if (entry.type === 'put' && entry.key.startsWith(EntryType.EPOCH_HASH)) {
+                // Epoch records share this history, but have their own key namespace.
+                const hash = entry.key.slice(EntryType.EPOCH_HASH.length);
+                if (hash.length === HASH_BYTE_LENGTH * 2 && isHexString(hash)) {
+                    hashes.push({ hash, confirmed_length: entry.seq });
+                }
             }
         }
 
@@ -5561,6 +5567,28 @@ class State extends ReadyResource {
         return Status.SUCCESS;
     }
 
+    async getUnsignedConsensusConfig() {
+        // Keep the pointer and record in the same view while unsigned state can change.
+        const snapshot = this.#base.view.snapshot();
+        try {
+            const currentConfigPointer = (await snapshot.get(EntryType.CONSENSUS_CONFIG_CURRENT))?.value;
+            if (_.isNil(currentConfigPointer)) return null;
+
+            if (!b4a.isBuffer(currentConfigPointer) || currentConfigPointer.length !== CONSENSUS_CONFIG_INDEX_SIZE) {
+                throw new Error('Invalid current consensus config pointer.');
+            }
+
+            const currentConfigIndex = currentConfigPointer.readUInt32BE(0);
+            const encodedConsensusConfig = (await snapshot.get(EntryType.CONSENSUS_CONFIG_RECORD + currentConfigIndex))?.value;
+            if (_.isNil(encodedConsensusConfig)) {
+                throw new Error(`Consensus config record ${currentConfigIndex} does not exist.`);
+            }
+
+            return decodeVersionedConsensusConfig(encodedConsensusConfig);
+        } finally {
+            await snapshot.close();
+        }
+    }
 }
 
 export default State;

package/src/index.js

@@ -37,7 +37,8 @@ import {
     encodeApplyOperation,
     encodeConsensusConfig,
     safeDecodeApplyOperation,
-    safeEncodeApplyOperation
+    safeEncodeApplyOperation,
+    decodeEpochRecord
 } from "./codecs/apply/applyOperationCodec.js";
 import { encodeVdfConfig } from "./codecs/consensus/v1/vdfConfigCodec.js";
 import PartialTransactionValidator from "./core/network/protocols/validators/shared/validators/PartialTransactionValidator.js";
@@ -425,7 +426,16 @@ export class MainSettlementBus extends ReadyResource {
 
     async fetchBulkTxPayloads(hashes) {
         const response = { results: [], missing: [] };
-        const results = await Promise.all(hashes.map((hash) => this.getConfirmedTxInfo(hash)));
+        const results = await Promise.all(hashes.map(async (hash) => {
+            const transaction = await this.getConfirmedTxInfo(hash);
+            if (transaction) return transaction.decoded;
+
+            const epochRecord = await this.#state.getEpochProof(hash);
+            if (epochRecord === null) return null;
+
+            // This hash identifies the stored epoch record, not an original transaction.
+            return { type: OperationType.SET_EPOCH, seo: decodeEpochRecord(epochRecord) };
+        }));
 
         results.forEach((result, index) => {
             const hash = hashes[index];
@@ -434,7 +444,7 @@ export class MainSettlementBus extends ReadyResource {
                 return;
             }
 
-            const decodedResult = normalizeDecodedPayloadForJson(result.decoded, this.#config);
+            const decodedResult = normalizeDecodedPayloadForJson(result, this.#config);
             response.results.push({ hash, payload: decodedResult });
         });
 
@@ -1290,6 +1300,19 @@ export class MainSettlementBus extends ReadyResource {
             expectedKeys.every(key => Object.hasOwn(value, key))
         );
     }
+
+    async getCurrentEpoch(confirmed = true) {
+        const epoch = confirmed
+            ? await this.#state.getCurrentEpoch()
+            : await this.#state.getCurrentEpochUnsigned();
+        return epoch === null ? null : epoch.toString();
+    }
+
+    async getConsensusConfig(confirmed = true) {
+        return confirmed
+            ? this.#state.getSignedConsensusConfig()
+            : this.#state.getUnsignedConsensusConfig();
+    }
 }
 
 export default MainSettlementBus;