Go to file
Michael Bradley, Jr a56aca1ab1 fix: remove procs that are no longer spec'd by libstatus.h 2021-01-05 15:43:46 -06:00
.github/workflows ci: revise cache key so that a bump in any submodule will cause a cache miss 2021-01-05 15:43:46 -06:00
nim_status fix: remove procs that are no longer spec'd by libstatus.h 2021-01-05 15:43:46 -06:00
test feat: add function to sign a message 2021-01-05 13:12:25 -05:00
vendor ci: revise cache key so that a bump in any submodule will cause a cache miss 2021-01-05 15:43:46 -06:00
.gitattributes ci: run tests via GitHub Actions 2020-09-02 15:58:35 -05:00
.gitignore feat: migrations (#83) 2020-12-22 16:24:58 -04:00
.gitmodules fix: add missing module 2021-01-05 10:21:45 -04:00
LICENSE feat: integrate nim-sqlcipher 2020-11-18 13:34:24 -06:00
Makefile feat: migrations (#83) 2020-12-22 16:24:58 -04:00
README.md feat: integrate nim-sqlcipher 2020-11-18 13:34:24 -06:00
env.sh feat: integrate nim-sqlcipher 2020-11-18 13:34:24 -06:00
nim_status.nim fix: remove procs that are no longer spec'd by libstatus.h 2021-01-05 15:43:46 -06:00
nim_status.nimble feat: add createAccount function to create a random account 2021-01-05 13:12:25 -05:00

README.md

nim-status

License: MIT Stability: experimental Tests (GitHub Actions)

Nim implementation of the Status protocol: https://github.com/status-im/specs

Corresponds roughly to status-go: https://github.com/status-im/status-go which is consumed by status-react: https://github.com/status-im/status-react/

Requirements

  • Go - (used to build status-go)
# Linux
<TODO>

# macOS
brew install go

Installation

git clone https://github.com/status-im/nim-status
cd nim-status
make update
make

For more output use make V=1 ....

Use 4 CPU cores with make -j4 ....

Usage

  • Include build/nim_status.a, build/nim_status.h in your project
  • Before any of the API calls are done, NimMain() needs to be run.

Troubleshooting

If the make command fails due to already installed Homebrew packages, such as:

Error: protobuf 3.11.4 is already installed
To upgrade to 3.11.4_1, run `brew upgrade protobuf`.
make[1]: *** [install-os-dependencies] Error 1
make: *** [vendor/status-go/build/bin/libstatus.a] Error 2

This can be fixed by uninstalling the package e.g. brew uninstall protobuf followed by rerunning make.