Skip to content
/ cube Public

Cube is a four-elemental, fire-sampled state machine built to supercharge Bitcoin with programmability.

License

Notifications You must be signed in to change notification settings

cube-btc/cube

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cube Cube is a four-elemental, fire-sampled state machine built to supercharge Bitcoin with programmability.

Installation

Ensure you have Rust installed. Clone the repository and navigate into the project directory:

git clone https://github.com/cube-vm/cube
cd cube

Usage

Run the program with the following command:

cargo run <chain> <mode> <bitcoin-rpc-url> <bitcoin-rpc-user> <bitcoin-rpc-password>

Parameters:

  • <chain>: The Bitcoin network to use. Supported values:
    • signet
    • mainnet
  • <mode>: The mode in which the program runs. Supported values:
    • node: For running a Cube node.
    • engine: For network operators.
  • <bitcoin-rpc-url>: The RPC URL of the Bitcoin node.
  • <bitcoin-rpc-user>: The RPC username.
  • <bitcoin-rpc-password>: The RPC password.

Example:

cargo run signet node http://127.0.0.1:38332 user password

License

This project is licensed under the CC0 1.0 Universal License. See the LICENSE file for details.

About

Cube is a four-elemental, fire-sampled state machine built to supercharge Bitcoin with programmability.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages