Skip to content

README.md

Latest commit

 

History

History
50 lines (37 loc) · 3.21 KB

README.md

File metadata and controls

50 lines (37 loc) · 3.21 KB
Raw

Iron Fish

Iron Fish

Node CI Rust CI 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

Install

  1. Install Node.js 14.x
  2. Install Rust.
  3. Install Yarn.
  4. Windows:
    1. Install Build Tools for Visual Studio 2019, including the C++ Build Tools and the Windows 10 SDK, for Rust.
    2. Rust builds also require installing MinGW-w64 via win-builds.
      1. Choose Native Windows, x86_64, choose an empty directory, and click OK.
      2. On the next screen, click Process.
      3. Once it finishes, add the bin folder containing cc to your path.
  5. Run cargo install wasm-pack to install the WebAssembly wrapper generator.
  6. Run yarn install from the root directory to install packages.

Usage

Once your environment is setup - 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 at the root of the repository 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 if you want the tests to run on change
    3. Run 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 )

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 on our documentation.
  • ironfish-wasm: Wrapper for ironfish-rust in WASM to be interacted with by the ironfish project.
  • ironfish-rust: Core API for interacting with the transactions and chain and using ZKP.
  • ironfish-http-api: API hosted on Iron Fish servers for the Iron Fish faucet.
  • ironfish-rosetta-api: API hosted on Iron Fish servers for the block explorer. The code of the block explorer client can be found here.