filecoin-signing-tools

(β˜… 106)

Filecoin Signing Library

  • .eslintrc.js
  • .gitignore
  • .prettierignore
  • .prettierrc
  • .sonarcloud.properties
  • Cargo.toml
  • LICENSE
  • Makefile
  • package-lock.json
  • package.json
  • README.md
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/Zondax/filecoin-signing-tools

Downloads the entire project code from GitHub to your computer.

cd filecoin-signing-tools

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd signer-ffi/flutter/filecoin/android

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo test -p filecoin-signer

Type this command into your terminal and run it.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make build_npm

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation