trac-msb 0.2.7 → 0.2.9

package/src/messages/partialStateMessages/PartialStateMessageBuilder.js

@@ -1,272 +0,0 @@
-import PeerWallet from "trac-wallet";
-import b4a from "b4a";
-
-import StateBuilder from '../base/StateBuilder.js'
-import { OperationType, TRAC_ADDRESS_SIZE, NETWORK_ID } from '../../utils/constants.js';
-import { addressToBuffer, bufferToAddress, isAddressValid } from '../../core/state/utils/address.js';
-import { isHexString } from "../../utils/helpers.js";
-import { blake3Hash } from "../../utils/crypto.js";
-import { createMessage } from "../../utils/buffer.js";
-import { isTransaction, isRoleAccess, isBootstrapDeployment, isTransfer } from "../../utils/operations.js";
-
-class PartialStateMessageBuilder extends StateBuilder {
-    #wallet;
-    #operationType;
-    #address;
-    #writingKey;
-    #txValidity;
-    #contentHash;
-    #externalBootstrap;
-    #withMsbBootstrap;
-    #bootstrapNonce;
-    #bootstrapSignature;
-    #channel;
-    #incomingAddress;
-    #amount;
-    #payload;
-
-    constructor(wallet) {
-        super();
-        if (!wallet || typeof wallet !== 'object') {
-            throw new Error('Wallet must be a valid wallet object');
-        }
-        if (!isAddressValid(wallet.address)) {
-            throw new Error('Wallet should have a valid TRAC address.');
-        }
-
-
-        this.#wallet = wallet;
-        this.reset();
-    }
-
-    reset() {
-        this.#operationType = null;
-        this.#address = null;
-        this.#writingKey = null;
-        this.#txValidity = null;
-        this.#contentHash = null;
-        this.#externalBootstrap = null;
-        this.#withMsbBootstrap = false;
-        this.#bootstrapNonce = null;
-        this.#bootstrapSignature = null;
-        this.#incomingAddress = null;
-        this.#amount = null;
-        this.#channel = null;
-        this.#payload = {};
-    }
-
-    forOperationType(operationType) {
-        if (!Object.values(OperationType).includes(operationType) || OperationType === OperationType.UNKNOWN) {
-            throw new Error(`Invalid operation type: ${operationType}`);
-        }
-
-        this.#operationType = operationType;
-        this.#payload.type = operationType;
-        return this;
-    }
-
-    withAddress(address) {
-        if (!isAddressValid(address)) {
-            throw new Error(`Address field must be a valid TRAC bech32m address with length ${TRAC_ADDRESS_SIZE}.`);
-        }
-
-        this.#address = address;
-        this.#payload.address = this.#address;
-        return this;
-    }
-
-    withContentHash(contentHash) {
-        if (!isHexString(contentHash) || contentHash.length !== 64) {
-            throw new Error('Content hash must be a 64-length hexstring.');
-        }
-        this.#contentHash = contentHash;
-        return this;
-    }
-
-    withExternalBootstrap(bootstrap) {
-        if (!isHexString(bootstrap) || bootstrap.length !== 64) {
-            throw new Error('Bootstrap key must be a 64-length hexstring.');
-        }
-        this.#externalBootstrap = bootstrap;
-        return this;
-    }
-
-    withMsbBootstrap(msbBootstrap) {
-        if (!isHexString(msbBootstrap) || msbBootstrap.length !== 64) {
-            throw new Error('MSB Bootstrap key must be a 64-length hexstring.');
-        }
-        this.#withMsbBootstrap = msbBootstrap;
-        return this;
-    }
-
-    withWriterKey(writerKey) {
-        if (!isHexString(writerKey) || writerKey.length !== 64) {
-            throw new Error('Writer key must be a 64-length hexstring.');
-        }
-        this.#writingKey = writerKey;
-        return this;
-    }
-
-    withTxValidity(txValidity) {
-        if (!isHexString(txValidity) || txValidity.length !== 64) {
-            throw new Error('txValidity must be a 64-length hexstring.');
-        }
-        this.#txValidity = txValidity;
-        return this;
-    }
-
-    withIncomingAddress(address) {
-        if (!isAddressValid(address)) {
-            throw new Error(`Incoming address field must be a valid TRAC bech32m address with length ${TRAC_ADDRESS_SIZE}.`);
-        }
-
-        this.#incomingAddress = address;
-        return this;
-    }
-
-    withAmount(amount) {
-        if (!isHexString(amount) || amount.length !== 32) {
-            throw new Error('Amount must be a 32-length hexstring.');
-        }
-
-        this.#amount = amount;
-        return this;
-    }
-
-    withChannel(channel) {
-        if (!isHexString(channel) || channel.length !== 64) {
-            throw new Error('Channel must be a 64-length hexstring.');
-        }
-
-        this.#channel = channel;
-        return this;
-    }
-
-    async buildValueAndSign() {
-        const nonce = PeerWallet.generateNonce();
-        let txMsg = null;
-        let tx = null;
-        let signature = null;
-
-        // Creating a message for signing based on operation type
-        // ATTENTION REMEMBER THAT createMessage accept only BUFFER arguments and uint32
-        switch (this.#operationType) {
-            case OperationType.ADD_WRITER:
-            case OperationType.REMOVE_WRITER:
-            case OperationType.ADMIN_RECOVERY:
-                txMsg = createMessage(
-                    NETWORK_ID,
-                    b4a.from(this.#txValidity, 'hex'),
-                    b4a.from(this.#writingKey, 'hex'),
-                    nonce,
-                    this.#operationType
-                );
-                break;
-
-            case OperationType.BOOTSTRAP_DEPLOYMENT:
-                if (!this.#externalBootstrap) {
-                    throw new Error('External bootstrap key must be set for BOOTSTRAP DEPLOYMENT operation.');
-                }
-                txMsg = createMessage(
-                    NETWORK_ID,
-                    b4a.from(this.#txValidity, 'hex'),
-                    b4a.from(this.#externalBootstrap, 'hex'),
-                    b4a.from(this.#channel, 'hex'),
-                    nonce,
-                    OperationType.BOOTSTRAP_DEPLOYMENT
-                );
-                break;
-
-            case OperationType.TX:
-                txMsg = createMessage(
-                    NETWORK_ID,
-                    b4a.from(this.#txValidity, 'hex'),
-                    b4a.from(this.#writingKey, 'hex'),
-                    b4a.from(this.#contentHash, 'hex'),
-                    b4a.from(this.#externalBootstrap, 'hex'),
-                    b4a.from(this.#withMsbBootstrap, 'hex'),
-                    nonce,
-                    OperationType.TX
-                );
-                break;
-            case OperationType.TRANSFER:
-                txMsg = createMessage(
-                    NETWORK_ID,
-                    b4a.from(this.#txValidity, 'hex'),
-                    addressToBuffer(this.#incomingAddress), // we need to sign address of the recipient as well
-                    b4a.from(this.#amount, 'hex'),
-                    nonce,
-                    OperationType.TRANSFER
-                );
-                break;
-            default:
-                throw new Error(`Unsupported operation type: ${this.#operationType}`);
-        }
-
-        // tx and signature
-        tx = await blake3Hash(txMsg);
-        signature = this.#wallet.sign(tx);
-
-        // Build the payload based on operation type
-        if (isBootstrapDeployment(this.#operationType)) {
-            this.#payload.bdo = {
-                tx: tx.toString('hex'),
-                txv: this.#txValidity,
-                bs: this.#externalBootstrap,
-                ic: this.#channel,
-                in: nonce.toString('hex'),
-                is: signature.toString('hex')
-            };
-        } else if (isRoleAccess(this.#operationType)) {
-            this.#payload.rao = {
-                tx: tx.toString('hex'),
-                txv: this.#txValidity,
-                iw: this.#writingKey,
-                in: nonce.toString('hex'),
-                is: signature.toString('hex')
-            };
-        } else if (isTransaction(this.#operationType)) {
-            this.#payload.txo = {
-                tx: tx.toString('hex'),
-                txv: this.#txValidity,
-                iw: this.#writingKey,
-                ch: this.#contentHash,
-                bs: this.#externalBootstrap,
-                mbs: this.#withMsbBootstrap,
-                in: nonce.toString('hex'),
-                is: signature.toString('hex'),
-            };
-        } else if (isTransfer(this.#operationType)) {
-            this.#payload.tro = {
-                tx: tx.toString('hex'),
-                txv: this.#txValidity,
-                to: this.#incomingAddress,
-                am: this.#amount,
-                in: nonce.toString('hex'),
-                is: signature.toString('hex')
-            }
-        }
-
-        return this;
-    }
-
-    getPayload() {
-        if (
-            !this.#payload.type ||
-            !this.#payload.address ||
-            (
-                !this.#payload.bdo &&
-                !this.#payload.rao &&
-                !this.#payload.txo &&
-                !this.#payload.tro
-            )
-        ) {
-            throw new Error('Product is not fully assembled. Missing type, address, or value bdo/rao/txo/tro.');
-        }
-        const res = this.#payload;
-        this.reset();
-        return res;
-    }
-}
-
-export default PartialStateMessageBuilder;

package/src/messages/partialStateMessages/PartialStateMessageDirector.js

@@ -1,137 +0,0 @@
-import StateBuilder from '../base/StateBuilder.js'
-import {OperationType} from '../../utils/constants.js'
-import address from "../../core/state/utils/address.js";
-
-class PartialStateMessageDirector {
-    #builder;
-
-    set builder(builderInstance) {
-        if (!(builderInstance instanceof StateBuilder)) {
-            throw new Error('Director requires a Builder instance.');
-        }
-        this.#builder = builderInstance;
-    }
-
-    /**
-     * Builds a PARTIAL bootstrap deployment operation message, which can be sent to a validator.
-     * The validator can sign this operation to make it COMPLETE and broadcast it to the network.
-     * Bootstrap deployment is required to register a subnetwork. The network will reject
-     * TransactionOperation messages for external bootstraps that are not registered.
-     * Do NOT attempt to register the MSB bootstrap key.
-     *
-     * @param {String} address - Trac address of the requester/invoker node that broadcasts the operation.
-     * @param {String} bootstrap - Bootstrap key from the subnetwork to be registered.
-     *                             MUST be different from the MSB bootstrap key.
-     *                             BEFORE deploying, ensure the subnetwork bootstrap is not already deployed.
-     * @param {String} txValidity - Transaction validity hash representing the current indexer combination.
-     *                              The operation remains valid as long as indexer keys maintain their order.
-     *                              Acts as protection against deferred execution attacks.
-     * @returns {Promise<Object>} The built bootstrap deployment operation message.
-     * @throws {Error} If the builder has not been set or message building fails.
-     */
-    async buildPartialBootstrapDeploymentMessage(address, bootstrap, channel, txValidity) {
-        if (!this.#builder) throw new Error('Builder has not been set.');
-
-        await this.#builder
-            .forOperationType(OperationType.BOOTSTRAP_DEPLOYMENT)
-            .withAddress(address)
-            .withTxValidity(txValidity)
-            .withExternalBootstrap(bootstrap)
-            .withChannel(channel)
-            .buildValueAndSign();
-
-        return this.#builder.getPayload();
-    }
-
-    async buildAddWriterMessage(address, writingKey, txValidity) {
-        if (!this.#builder) throw new Error('Builder has not been set.');
-
-        await this.#builder
-            .forOperationType(OperationType.ADD_WRITER)
-            .withAddress(address)
-            .withTxValidity(txValidity)
-            .withWriterKey(writingKey)
-            .buildValueAndSign();
-
-        return this.#builder.getPayload();
-    }
-
-    async buildRemoveWriterMessage(address, writerKey, txValidity) {
-        if (!this.#builder) throw new Error('Builder has not been set.');
-
-        await this.#builder
-            .forOperationType(OperationType.REMOVE_WRITER)
-            .withAddress(address)
-            .withTxValidity(txValidity)
-            .withWriterKey(writerKey)
-            .buildValueAndSign();
-
-        return this.#builder.getPayload();
-    }
-
-    async buildAdminRecoveryMessage(address, writingKey, txValidity) {
-        if (!this.#builder) throw new Error('Builder has not been set.');
-
-        await this.#builder
-            .forOperationType(OperationType.ADMIN_RECOVERY)
-            .withAddress(address)
-            .withTxValidity(txValidity)
-            .withWriterKey(writingKey)
-            .buildValueAndSign();
-
-        return this.#builder.getPayload();
-    }
-
-    /**
-     * Builds a transaction operation message for cross-network communication
-     * @param {String} address - Trac address of the requester/invoker node that broadcasts the transaction
-     * @param {String} incomingWritingKey - Writing key from the subnetwork, used for authentication of the requesting node
-     * @param {String} txValidity - Transaction validity hash representing current indexer combination.
-     *                              Transaction remains valid as long as indexer keys maintain their order.
-     *                              Acts as protection against deferred execution attacks.
-     * @param {String} contentHash - Hash of the contract content from the subnetwork,
-     *                              ensures data integrity between networks
-     * @param {String} externalBootstrap - Bootstrap key from the subnetwork,
-     *                                    used for cross-network communication verification.
-     *                                    MUST BE DIFFERENT from the MSB bootstrap key.
-     *                                    transaction will be rejected if external bootstrap won't be
-     *                                    deployed in the MSB (bootstrapDeploymentOperation).
-     * @param {String} msbBootstrap - Main Settlement Bus bootstrap key,
-     *                                used for internal network verification
-     * @returns {Promise<Object>} The built transaction operation message
-     * @throws {Error} If builder hasn't been set or if message building fails
-     */
-    async buildTransactionOperationMessage(
-        address,
-        incomingWritingKey,
-        txValidity,
-        contentHash,
-        externalBootstrap,
-        msbBootstrap,
-    ) {
-        if (!this.#builder) throw new Error('Builder has not been set.');
-        await this.#builder
-            .forOperationType(OperationType.TX)
-            .withAddress(address)
-            .withTxValidity(txValidity)
-            .withWriterKey(incomingWritingKey)
-            .withContentHash(contentHash)
-            .withExternalBootstrap(externalBootstrap)
-            .withMsbBootstrap(msbBootstrap)
-            .buildValueAndSign();
-        return this.#builder.getPayload();
-    }
-    async buildTransferOperationMessage(address, recipientAddress, amount, txValidity){
-        if (!this.#builder) throw new Error('Builder has not been set.');
-        await this.#builder
-            .forOperationType(OperationType.TRANSFER)
-            .withAddress(address)
-            .withTxValidity(txValidity)
-            .withIncomingAddress(recipientAddress)
-            .withAmount(amount)
-            .buildValueAndSign();
-        return this.#builder.getPayload();
-    }
-}
-
-export default PartialStateMessageDirector;

package/src/messages/partialStateMessages/PartialStateMessageOperations.js

@@ -1,131 +0,0 @@
-import PartialStateMessageBuilder from './PartialStateMessageBuilder.js';
-import PartialStateMessageDirector from './PartialStateMessageDirector.js';
-
-class PartialStateMessageOperations {
-
-    /**
-     * Assembles a PARTIAL bootstrap deployment operation, which can be sent to a validator.
-     * The validator can sign this operation to make it COMPLETE and broadcast it to the network.
-     * Bootstrap deployment is required to register a subnetwork. The network will reject
-     * TransactionOperation messages for external bootstraps that are not registered.
-     * Do NOT attempt to register the MSB bootstrap key.
-     *
-     * @param {Object} wallet - Wallet of the requester/invoker node that broadcasts the operation
-     * @param {String} externalBootstrap - Bootstrap key from the subnetwork to be registered.
-     *                                    MUST be different from the MSB bootstrap key.
-     *                                    BEFORE deploying ensure if the subnetwork bootstrap is not already deployed.
-     * @param {String} txValidity - Transaction validity hash representing the current indexer combination.
-     *                              The operation remains valid as long as indexer keys maintain their order.
-     *                              Acts as protection against deferred execution attacks.
-     * @returns {Promise<Object>} The assembled bootstrap deployment operation message
-     * @throws {Error} If assembly of the bootstrap deployment operation message fails
-     */
-    static async assembleBootstrapDeploymentMessage(wallet, externalBootstrap, channel, txValidity) {
-        try {
-            const builder = new PartialStateMessageBuilder(wallet);
-            const director = new PartialStateMessageDirector();
-            director.builder = builder;
-            return await director.buildPartialBootstrapDeploymentMessage(
-                wallet.address,
-                externalBootstrap,
-                channel,
-                txValidity
-            );
-        } catch (error) {
-            throw new Error(`Failed to assemble partial bootstrap deployment message: ${error.message}`);
-        }
-    }
-
-    static async assembleAddWriterMessage(wallet, writingKey, txValidity) {
-        try {
-            const builder = new PartialStateMessageBuilder(wallet);
-            const director = new PartialStateMessageDirector();
-            director.builder = builder;
-            return await director.buildAddWriterMessage(wallet.address, writingKey, txValidity);
-        } catch (error) {
-            throw new Error(`Failed to assemble add writer message: ${error.message}`);
-        }
-    }
-
-    static async assembleRemoveWriterMessage(wallet, writerKey, txValidity) {
-        try {
-            const builder = new PartialStateMessageBuilder(wallet);
-            const director = new PartialStateMessageDirector();
-            director.builder = builder;
-            return await director.buildRemoveWriterMessage(wallet.address, writerKey, txValidity);
-        } catch (error) {
-            throw new Error(`Failed to assemble remove writer message: ${error.message}`);
-        }
-    }
-
-    static async assembleAdminRecoveryMessage(wallet, writingKey, txValidity) {
-        try {
-            const builder = new PartialStateMessageBuilder(wallet);
-            const director = new PartialStateMessageDirector();
-            director.builder = builder;
-            return await director.buildAdminRecoveryMessage(wallet.address, writingKey, txValidity);
-        } catch (error) {
-            throw new Error(`Failed to assemble admin recovery message: ${error.message}`);
-        }
-    }
-
-
-    /**
-     * Assembles a PARTIAL transaction operation, which can be sent to a validator, who can then
-     * sign the transaction to make it COMPLETE.
-     *
-     * @param {Object} wallet - Wallet of the requester/invoker node that broadcasts the transaction
-     * @param {String} incomingWritingKey - Writing key from the subnetwork, used for authentication of the requesting node
-     * @param {String} txValidity - Transaction validity hash representing current indexer combination.
-     *                              Transaction remains valid as long as indexer keys maintain their order.
-     *                              Acts as protection against deferred execution attacks.
-     * @param {String} contentHash - Hash of the contract content from the subnetwork,
-     *                              ensures data integrity between networks
-     * @param {String} externalBootstrap - Bootstrap key from the subnetwork,
-     *                                    used for cross-network communication verification.
-     *                                    MUST BE DIFFERENT from the MSB bootstrap key.
-     *                                    transaction will be rejected if external bootstrap won't be
-     *                                    deployed in the MSB (bootstrapDeploymentOperation).
-     * @param {String} msbBootstrap - Main Settlement Bus bootstrap key,
-     *                                used for internal network verification
-     * @returns {Promise<Object>} The assembled transaction operation message
-     * @throws {Error} If assembly of the transaction operation message fails
-     */
-    static async assembleTransactionOperationMessage(wallet, incomingWritingKey, txValidity, contentHash, externalBootstrap, msbBootstrap) {
-        try {
-            const builder = new PartialStateMessageBuilder(wallet);
-            const director = new PartialStateMessageDirector();
-            director.builder = builder;
-            return await director.buildTransactionOperationMessage(
-                wallet.address,
-                incomingWritingKey,
-                txValidity,
-                contentHash,
-                externalBootstrap,
-                msbBootstrap
-            );
-        } catch (error) {
-            throw new Error(`Failed to assemble transaction operation message: ${error.message}`);
-        }
-    }
-
-    static async assembleTransferOperationMessage(wallet, recipientAddress, amount, txValidity) {
-        try {
-            const builder = new PartialStateMessageBuilder(wallet);
-            const director = new PartialStateMessageDirector();
-            director.builder = builder;
-            return await director.buildTransferOperationMessage(
-                wallet.address,
-                recipientAddress,
-                amount,
-                txValidity
-            );
-        } catch (error) {
-            throw new Error(`Failed to assemble transfer operation message: ${error.message}`);
-        }
-
-    }
-
-}
-
-export default PartialStateMessageOperations;

package/src/utils/crypto.js

@@ -1,11 +0,0 @@
-import b4a from "b4a";
-import { blake3 } from "@tracsystems/blake3";
-
-export async function blake3Hash(input, hashLength = 32) {
-  if (typeof input === "string") {
-    input = b4a.from(input, "utf8");
-  }
-
-  const hashBytes = await blake3(input, hashLength);
-  return b4a.from(hashBytes);
-}

package/tests/integration/apply/addAdmin/addAdminBasic.test.js

@@ -1,68 +0,0 @@
-import {test, hook} from '../../../helpers/wrapper.js';
-import {
-    initMsbAdmin, initTemporaryDirectory, removeTemporaryDirectory, setupMsbPeer, setupMsbWriter, setupMsbIndexer,
-    tryToSyncWriters
-} from '../../../helpers/setupApplyTests.js';
-import {randomBytes} from '../../../helpers/setupApplyTests.js';
-import CompleteStateMessageOperations from '../../../../src/messages/completeStateMessages/CompleteStateMessageOperations.js';
-import {testKeyPair1} from '../../../fixtures/apply.fixtures.js';
-import b4a from 'b4a';
-import { ADMIN_INITIAL_BALANCE } from '../../../../src/utils/constants.js';
-
-//TODO: ADD TEST WHEN NON-ADMIN NODE FORGES ADD ADMIN OPERATION AND BROADCASTS IT TO THE STATE -  SHOULD BE REJECTED
-
-let admin;
-let tmpDirectory;
-let randomChannel;
-
-const sendAddAdmin = async (invoker) => {
-    const validity = b4a.from(await admin.msb.state.getIndexerSequenceState(), 'hex')
-    const addAdminMessage = await CompleteStateMessageOperations.assembleAddAdminMessage(
-        admin.wallet,
-        admin.msb.state.writingKey,
-        validity
-    );
-
-    // add admin to base
-    await invoker.msb.state.append(addAdminMessage); // Send `add admin` request to apply function
-}
-
-hook('Initialize admin for addAdmin tests', async () => {
-    randomChannel = randomBytes(32).toString('hex');
-    const baseOptions = {
-        enable_tx_apply_logs: false,
-        enable_interactive_mode: false,
-        enable_role_requester: false,
-        channel: randomChannel,
-        enable_validator_observer: false,
-    }
-    tmpDirectory = await initTemporaryDirectory();
-    admin = await initMsbAdmin(testKeyPair1, tmpDirectory, baseOptions);
-    await admin.msb.ready();
-});
-
-test('Apply function addAdmin for the first time - happy path', async (k) => {
-    const writersLength = await admin.msb.state.getWriterLength();
-    const adminEntryBefore = await admin.msb.state.getAdminEntry();
-    k.is(adminEntryBefore, null, 'Admin entry should be null before adding a new admin');
-
-    await sendAddAdmin(admin)
-    await tryToSyncWriters(admin);
-    const adminEntryAfter = await admin.msb.state.getAdminEntry(); // check if the admin entry was added successfully in the base
-    const nodeAdminEntry = await admin.msb.state.getNodeEntry(adminEntryAfter.address)
-    const newWritersLength = await admin.msb.state.getWriterLength();
-    // check the result
-    k.ok(adminEntryAfter, 'Result should not be null');
-    k.ok(adminEntryAfter.address === admin.wallet.address, 'Admin address in base should match admin wallet address');
-    k.ok(b4a.equals(adminEntryAfter.wk, admin.msb.state.writingKey), 'Admin writing key in base should match admin MSB writing key');
-    k.ok(b4a.equals(adminEntryAfter.wk, admin.options.bootstrap), 'Admin writing key in base should match bootstrap key');
-    k.is(nodeAdminEntry.isWriter, true, 'Admin should be writer');
-    k.is(nodeAdminEntry.isIndexer, true, 'Admin should be indexer');
-    k.ok(b4a.equals(nodeAdminEntry.balance, ADMIN_INITIAL_BALANCE), 'Admin should have an initial balance');
-    k.is(newWritersLength, writersLength + 1,  'Admin should increase writers length');
-});
-
-hook('Clean up addAdmin recovery setup', async () => {
-    if (admin && admin.msb) await admin.msb.close();
-    if (tmpDirectory) await removeTemporaryDirectory(tmpDirectory);
-});