@bloxchain/contracts

Bloxchain Protocol smart contracts – state abstraction and core components for building on the Bloxchain Protocol.

The core protocol (contracts/core/) has been independently audited by Nethermind. Report and scope: audits/nethermind on GitHub. Pre-mainnet today; mainnet deployment coming soon. Review release notes and pin an exact version before production use.

Requirements

• Node.js: >= 18.0.0 (for tooling; Solidity has no runtime dependency)
• Solidity: 0.8.x (0.8.34 recommended)
• Compilers: Foundry, Hardhat, or Truffle

Installation

npm install @bloxchain/contracts

Usage

Import contracts in your Solidity files. All contracts live under @bloxchain/contracts/core/:

import "@bloxchain/contracts/core/base/BaseStateMachine.sol";
import "@bloxchain/contracts/core/security/SecureOwnable.sol";
import "@bloxchain/contracts/core/access/RuntimeRBAC.sol";
import "@bloxchain/contracts/core/execution/GuardController.sol";
import "@bloxchain/contracts/core/lib/utils/SharedValidation.sol";
import "@bloxchain/contracts/core/lib/interfaces/IDefinition.sol";

Foundry: No remapping needed; the package exposes core/ at root (lib, base, access, execution, security live inside it).
Hardhat / Truffle: Resolve @bloxchain/contracts from node_modules as usual.

Contracts

Core contracts

| Contract | Description | |----------|-------------| | BaseStateMachine | Foundation state machine for all blox contracts | | SecureOwnable | Multi-role security with time-locked operations | | RuntimeRBAC | Dynamic role-based access control | | GuardController | Execution workflows and time-locked transactions |

Templates and examples

Templates (e.g. AccountBlox, CopyBlox) and example applications (SimpleVault, SimpleRWA20) live in the main repository under contracts/examples/. They are not included in this npm package. See the main repo for full documentation and examples.

Dependencies

This package declares:

• @openzeppelin/contracts: 5.6.1
• @openzeppelin/contracts-upgradeable: 5.6.1

Install them in your project if your tooling does not resolve transitive dependencies.

Versioning and stability

This package follows Semantic Versioning. Stable releases publish to npm latest; see CHANGELOG.md. Pin the exact version in production and review release notes before upgrading.

Security

• Vulnerability reporting: Do not open public GitHub issues for security vulnerabilities. See the Security Policy for reporting instructions (e.g. [email protected]).
• Audit status: Core protocol (contracts/core/) audited by Nethermind (PDF). This npm package does not include the PDF; verify the audited commit in the engagement README. Follow your own deployment, upgrade, and operational review before production use.

Support and links

• Documentation: Bloxchain Protocol README
• Issues and feature requests: GitHub Issues
• Homepage: bloxchain.app
• Author: Particle Crypto Security

Repository

Part of Bloxchain Protocol. For full documentation, architecture, and examples, see the main repository.

License

MPL-2.0 (Mozilla Public License 2.0). See the LICENSE file in the main repository.