Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 5.91 KB

README.md

File metadata and controls

95 lines (64 loc) · 5.91 KB
Raw

Iron Fish

Iron Fish

Node CI Rust CI Node CI Regenerate Fixtures codecov

Iron Fish is a Layer 1 blockchain that provides the strongest privacy guarantees on every single transaction. Leveraging zero-knowledge proofs (zk-SNARKs), and the highest industry standards for encryption.

See https://ironfish.network

Developer Install

The following steps should only be used to install if you are planning on contributing to the Iron Fish codebase. Otherwise, we strongly recommend using the installation methods here: https://ironfish.network/use/get-started/installation

  1. Install Node.js LTS

  2. Install Rust.

  3. Install Yarn.

  4. Windows:

    1. Install the current version of Python from the Microsoft Store package.
    2. Install Visual C++ Build Environment: Visual Studio Build Tools (using "Visual C++ build tools" or "Desktop development with C++" workload)

    If the above steps didn't work for you, please visit Microsoft's Node.js Guidelines for Windows for additional tips.

  5. Run yarn install from the root directory to install packages.

    • If yarn install fails with an error that includes "Failed to build cmake", you may need to first install cmake. For example, on macOS:

      1. Run brew install cmake, you'll need cmake version 3.15 or higher.

    • If yarn install fails with an error that includes "Could NOT find OpenSSL", you may need to first install OpenSSL and add an environment variable. For example, on macOS:

      1. Run brew install openssl
      2. Run export OPENSSL_ROOT_DIR=`brew --prefix openssl`
      3. Run yarn install again.

    • If yarn install fails with an error that includes "Error: not found: make", "make: cc: Command not found", or "make: g++: Command not found", you may need to install a C/C++ compiler toolchain.

      1. On Ubuntu: apt install build-essential
      2. On Amazon Linux: sudo yum groupinstall "Development Tools"

    • If yarn install fails with an error that includes "Error: Could not find any Python installation to use", you may need to install Python3 (required by node-gyp). on macOS:

      1. Run brew install python

Usage

Once your environment is set up - you can run the CLI by following these directions.

Running Tests

  1. To test the entire monorepo:
    1. Run yarn test at the root of the repository
    2. Run yarn test:slow in ./ironfish/ to run slow tests
    3. Run yarn test:coverage at the root of the repository for tests and coverage
  2. To test a specific project
    1. Run yarn test at the root of the project
    2. Run yarn test:watch in ./ironfish or ./ironfish-cli if you want the tests to run on change
    3. Run yarn test:coverage:html if you want to export the coverage in an easy-to-use format (open the index.html file in the coverage folder of the project)

Running Benchmarks and Performance Tests

  1. Rust benchmarks:
    • cargo benchmark is a cargo alias, defined in ./.cargo/config.toml
    1. cargo benchmark to run all benchmark tests
    2. cargo benchmark -- simple to run only benchmarks containing the text 'simple' in the name
  2. Typescript benchmarks:
    1. cd ironfish
    2. yarn test:perf

Structure of the repository

  • ironfish: The library that contains the IronfishSDK and all Ironfish code written in TypeScript.
  • ironfish-cli: The main client for Iron Fish as of today. It is a command-line interface built on Node. More details in our documentation.
  • ironfish-rust: Core API for interacting with the transactions and chain and using ZKP.
  • ironfish-rust-nodejs: Wrapper for ironfish-rust as a native NodeJS addon.

Contributing Code

If you want to contribute code, you must first read our contributing guidelines or risk having your pull request closed.

Other Repositories

Licensing

This code base and any contributions will be under the MPL-2.0 Software License.