Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/btc-vision/opnet-node
OPNet is a decentralized system that leverages Taproot/SegWit/Legacy technology to manage and execute smart contracts on Bitcoin or any other UTXO-based blockchains.
https://github.com/btc-vision/opnet-node
bitcoin opnet opnet-node utxo
Last synced: 28 days ago
JSON representation
OPNet is a decentralized system that leverages Taproot/SegWit/Legacy technology to manage and execute smart contracts on Bitcoin or any other UTXO-based blockchains.
- Host: GitHub
- URL: https://github.com/btc-vision/opnet-node
- Owner: btc-vision
- License: mit
- Created: 2024-03-30T22:20:24.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-02T01:01:24.000Z (about 1 month ago)
- Last Synced: 2024-12-02T02:19:00.189Z (about 1 month ago)
- Topics: bitcoin, opnet, opnet-node, utxo
- Language: TypeScript
- Homepage: https://opnet.org
- Size: 3.75 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.MD
Awesome Lists containing this project
README
# OP_NET - Node
[](https://github.com/prettier/prettier)
## ⚠️ Important Notice ⚠️
This repository is currently under development and is not yet ready for production use. We are actively working on
implementing the features and functionalities outlined in this document. Please check back regularly for updates and
progress reports.
**Mainnet usage is prohibited until the official release of OP_NET. All actions taken on any
main network will be discarded on release.**
## Introduction
Welcome to the official **OP_NET Node** GitHub repository. This repository contains the source code and documentation
for the OPNet Node, an essential component of a decentralized system that leverages Taproot/SegWit/Legacy technology to
manage and execute smart contracts on the Bitcoin or any other UTXO-based blockchains.
## Table of Contents
- [Getting Started](#getting-started)
- [Features](#features)
- [Installation (Quick)](#installation-quick)
- [Prerequisites](#prerequisites)
- [Installation (Development)](#installation-development)
- [Repository Contents](#repository-contents)
- [Configuration](#configuration)
- [Consensus Mechanism](#consensus-mechanism)
- [Proof of Calculation (PoC)](#proof-of-calculation-poc)
- [Proof of Validation (PoV)](#proof-of-validation-pov)
- [Combined PoC and PoV Layers](#combined-poc-and-pov-layers)
- [Feature Implementation Status](#feature-implementation-status)
- [Implemented Features](#implemented-features)
- [Features Left to Implement](#features-left-to-implement)
- [Converting OP20/NFT to BTC](#converting-op20nft-to-btc)
- [Potential Issues](#potential-issues)
- [License](#license)
## Getting Started
To get started with the node, follow these setup instructions. OP_NET is designed to run on almost any operating
system and requires Node.js, npm, a Bitcoin node, and MongoDB.
## Features
- **Consensus Validation System**: OPNet employs a dual-layer consensus validation system integrating **Proof of
Calculation (PoC)** and **Proof of Validation (PoV)**, enhancing error detection and defense against manipulation.
- **Data Sourcing from Bitcoin Network**: Data is sourced directly from the Bitcoin network, allowing each peer to
independently recalculate and verify any information at any given block.
- **Permissionless Nodes (PoC)**: Nodes handle the initial layer of validation by independently recalculating data from
the Bitcoin blockchain. This decentralized verification adds resilience without relying on trusted nodes. **Proof of
Calculation** ensures that each node's calculations are accurate and aligned with network standards, fostering
consistency across the decentralized network.
- **Bootstrap Nodes (PoV)**: Serving as **Proof of Validation** nodes, bootstrap nodes act as trusted verifiers. They
perform independent recalculations and confirm results against official network entries, adding a rigorous validation
layer. These nodes review calculations to detect potential errors or manipulations, enhancing trust without altering
individual node data directly.
- **Independent State Determination**: Each node arrives at its own state independently based on PoC, without requiring
a threshold of nodes to agree. PoV allows nodes to check what the canonical outputs are, which come from trusted nodes
such as the OPNet Foundation.
- **Contract Execution**: Execution of smart contracts through the OP-VM, handling sophisticated logic and state
changes.
- **State Management and Proofs**: Robust management of contract states, including computing and validating state
changes using Merkle proofs.
- **Merkle Root Calculation**: Computation of state roots and transaction receipt roots for comprehensive summaries of
contract states and transaction outcomes.
- **Recovery and Reversion**: Capabilities to revert states or initiate full rescans in the event of discrepancies or
blockchain reorganizations.
- **Decentralized Network**: OPNet is a decentralized network that leverages the Bitcoin blockchain for security and
immutability. Proofs and state changes are validated by a network of nodes, preparing for a future Proof of Stake (
PoS) implementation.
## Installation (Quick)
OPNet provides an automated setup script for quick installation. To use the script, run the following command:
```bash
curl -fsSL https://autosetup.opnet.org/autoconfig.sh -o autoconfig.sh && sudo -E bash autoconfig.sh
```
### Prerequisites
- **Node.js** version 21.x or higher (we recommend using Node.js 22.x).
- **npm** (Node Package Manager)
- **Bitcoin Node** (Latest version)
- **MongoDB** (Latest version)
- **Rust (cargo)**: Required to run the WASM VM.
### Installation (Development)
1. **Clone the repository**:
```bash
git clone https://github.com/btc-vision/opnet-node.git
```
2. **Navigate to the repository directory**:
```bash
cd opnet-node
```
3. **Install Rust**:
- For Linux or macOS:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
- For Windows, download the installer from the [Rust website](https://www.rust-lang.org/tools/install).
4. **Install the necessary dependencies**:
```bash
npm install
```
5. **Install MongoDB in a replica or sharded cluster mode**:
Visit the [MongoDB documentation](https://docs.mongodb.com/manual/tutorial/deploy-replica-set/) for instructions.
*Why is this needed?* To use MongoDB transactions, a replica set or sharded cluster must be enabled. This is crucial
for the correct operation of the node, allowing rollback of transactions in case of errors. Refer to our MongoDB
setup guide for more details.
6. **Configure your node**:
Adjust the variables in the configuration file located in the `config/` directory to suit your needs.
7. **Start the node**:
```bash
npm start
```
## Configuration
Before launching the node, configure the environment variables and settings according to your deployment environment.
Sample configuration files are located in the `config/` directory. Adjust settings for network endpoints, security
parameters, and operational modes as needed.
## Consensus Mechanism
OPNet utilizes a dual-layer consensus mechanism to maintain network security and data integrity.
### Proof of Calculation (PoC)
- **Role of Permissionless Nodes**: Permissionless nodes independently recalculate data from the Bitcoin network,
ensuring each node's calculations are accurate and align with network standards.
- **Independent State Determination**: Each node arrives at its own state based solely on PoC, without needing a
threshold of nodes to agree on a state.
- **Error Detection**: This decentralized approach adds resilience by detecting discrepancies through independent
calculations.
### Proof of Validation (PoV)
- **Role of Bootstrap Nodes**: Bootstrap nodes act as trusted verifiers, serving as PoV nodes. They perform independent
recalculations and validate results against official network entries.
- **Canonical Outputs**: PoV allows nodes to reference canonical outputs from trusted entities like the OPNet
Foundation.
- **Enhanced Security**: This layer enhances error detection and defends against manipulation without altering
individual node data.
### Combined PoC and PoV Layers
- **Integrity Assurance**: Nodes validated consistently by both untrusted recalculations and bootstrap node validations
are deemed correct.
- **Preparation for PoS Transition**: This structure strengthens OPNet's security, establishing a trusted foundation for
a future Proof of Stake transition.
- **Consensus Definition**: While consensus doesn't require a threshold of nodes to agree on a state, PoV provides a
mechanism for nodes to check against canonical outputs, effectively defining an implied consensus mechanism.
## Feature Implementation Status
### Implemented Features
| Feature | Description |
|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| **Network Protocol** | Comprehensive P2P communication, including encryption (ChaCha20-Poly1305 and X25519), security measures, and node discovery mechanisms. |
| **Block Synchronization** | Supports block recovery, reorganization handling, indexing, and automatic state recovery to maintain network integrity. |
| **VM Evaluation** | Manages state, computation, Merkle tree operations, and proof generation and verification within the OP-VM. |
| **Consensus Validation System** | Implements dual-layer consensus with Proof of Calculation (PoC) and Proof of Validation (PoV) to enhance error detection and prevent manipulation. |
| **Data Sourcing from Bitcoin Network** | Directly sources data from the Bitcoin blockchain, allowing independent recalculation and verification at any block. |
| **Contract Execution** | Executes smart contracts via the OP-VM, handling complex logic and state changes. |
| **State Management and Proofs** | Robust state management, including computing and validating state changes using Merkle proofs. |
| **Checksum Calculation** | Computes state roots and transaction receipt roots for comprehensive summaries of contract states and outcomes. |
| **Recovery and Reversion Capabilities** | Ability to revert states or initiate full rescans in case of discrepancies or blockchain reorganizations. |
| **Decentralized Network Structure** | Operates as a decentralized network leveraging the Bitcoin blockchain for security and immutability. |
| **P2P Encryption and Security** | Utilizes advanced encryption protocols to secure P2P communications, ensuring data integrity and confidentiality across the network. |
| **Node Discovery Mechanisms** | Implements efficient algorithms for discovering and connecting to other nodes within the network. |
| **Auto State Recovery** | Automatically recovers node state after unexpected shutdowns or network issues, minimizing downtime and data loss. |
| **Proof Generation and Verification** | Generates and verifies cryptographic proofs to ensure the validity and integrity of transactions and state changes. |
| **Error Detection Mechanisms** | Incorporates multiple layers of error detection to identify and mitigate discrepancies in data and computations. |
| **Block Gas System** | Implements a gas system to manage computational resources and prevent abuse of the network by limiting resource consumption. |
| **Mempool Tracking (Partial)** | Tracks and manages transactions in the mempool, ensuring efficient transaction processing and network performance. |
| **Transaction Validation** | Validates transactions against network rules and consensus mechanisms to ensure compliance and integrity. |
| **Relay and Propagation Mechanisms** | Facilitates the relay and propagation of blocks and transactions across the network, ensuring timely and efficient data distribution. |
| **API Integration** | Integrates with external APIs to fetch data, validate transactions, and interact with external services and applications. |
### Features Left to Implement
| Feature | Description |
|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **OP_LINK Integration** | **OP_LINK** is designed to create a fully decentralized, trustless system for bridging assets between chains. By utilizing **Auxiliary Proof of Work (AuxPoW)** and **OP_NET indexers**, it ensures that asset transfers are secure, tamper-resistant, and synchronized between the parent chain and the child chain.
In OP_LINK, when an AuxPoW block is mined and detected on the **child chain**, **OP_NET indexers** automatically trigger smart contracts on both the parent and child chains. These contracts manage the burning and minting of assets in a secure, cryptographic manner. OP_LINK ensures that the entire bridging process remains decentralized, with no reliance on centralized authorities. |
| **Multicall Simulation** | Implement multicall simulation for batch contract calls, allowing multiple contract interactions within a single transaction. This feature will improve efficiency and reduce gas costs for users interacting with multiple contracts. |
| **UTXO Support Enhancements** | Add support for UTXO legacy SegWit, UTXO legacy, UTXO P2PK, and enable multiple transactions in one input within the transaction builder. This will expand functionality and support more complex transaction types. |
| **Recode Mempool with ZeroMQ** | Replace HTTP-based mempool communication with ZeroMQ to improve performance, efficiency, and real-time transaction propagation. ZeroMQ offers lower latency and better handling of high-throughput messaging. |
| **PSBT Epoch** | Implement PSBT Epoch functionality to enhance transaction batching and processing efficiency. |
| **P2P Multithreading** | Implement multithreading in P2P networking to improve performance, scalability, and network throughput. |
| **Generic RPC Methods** | Develop a set of generic RPC methods for improved node interaction, management, and external application integration. |
| **PSBT Trading via P2P** | Implement PSBT trading mechanisms utilizing P2P networking for decentralized exchanges, enhancing trustless token exchange capabilities. |
| **State-Aware Transaction Execution** | Enhance transaction execution by incorporating state awareness, this allows the possibility to process multiple opnet transaction all at the same time. |
| **Light Nodes with Peering** | Implement light nodes that can peer with full nodes, allowing resource-constrained devices to participate in the network without full data storage. Light nodes rely on full nodes for data and transaction verification, enabling broader network participation. |
| **Websocket Support** | Add Websocket support for real-time data streaming, enabling efficient and low-latency communication between nodes and external applications. |
## Converting OP20/NFT to BTC
Please consult the [OP_NET Order Book Section](/docs/in-progress/OrderBook.md) for more information on how to convert
OP20/NFT to BTC.
## Potential Issues
If you have Python 3.12 installed, you may encounter issues. Install `setuptools` before running `npm install`:
```bash
py -3 -m pip install setuptools
```
## License
View the license by clicking [here](https://github.com/btc-vision/bsi/blob/main/LICENSE.md).