mirror of
https://github.com/jwinterm/grin-wallet.git
synced 2026-10-17 15:21:39 +02:00
ardocratandGitHub
ca5686aa04
* build: use node submodule as dependency * ci: checkout submodules * docs: add contributing and build instruction * ci: update release build * git: remove old submodule * git: grin staging submodule * git: add submodule dir
42 lines
2.4 KiB
Markdown
42 lines
2.4 KiB
Markdown
[](https://github.com/mimblewimble/grin-wallet/actions/workflows/ci.yaml)
|
|
[](https://codecov.io/gh/mimblewimble/grin-wallet)
|
|
[](https://gitter.im/grin_community/Lobby)
|
|
[](https://gitter.im/grin_community/support)
|
|
[](https://docs.rs/releases/search?query=grin_wallet)
|
|
[](https://github.com/mimblewimble/grin-wallet/releases)
|
|
[](https://github.com/mimblewimble/grin-wallet/blob/master/LICENSE)
|
|
|
|
# Grin Wallet
|
|
|
|
This is the reference implementation of [Grin's](https://github.com/mimblewimble/grin) wallet. It consists of 2 major pieces:
|
|
|
|
* The Grin Wallet APIs, which are intended for use by Grin community wallet developers. The wallet APIs can be directly linked into other projects or invoked via a JSON-RPC interface.
|
|
|
|
* A reference command-line wallet, which provides a baseline wallet for Grin and demonstrates how the wallet APIs should be called.
|
|
|
|
## Contributing
|
|
|
|
To get involved, read our [contributing docs](https://github.com/mimblewimble/grin/blob/master/CONTRIBUTING.md).
|
|
|
|
Find us:
|
|
|
|
* Telegram: [Grin Development](https://t.me/grindevelopment)
|
|
* Chat: [Keybase](https://keybase.io/team/grincoin), more instructions on how to join [here](https://grin.mw/community).
|
|
|
|
## Usage
|
|
|
|
To use the command-line wallet, we recommend using the latest release from the [Releases page](https://github.com/mimblewimble/grin-wallet/releases). There are distributions for Linux, MacOS and Windows.
|
|
|
|
Full documentation outlining how to use the command line wallet can be found on [Grin's Wiki](https://github.com/mimblewimble/docs/wiki/Wallet-User-Guide)
|
|
|
|
To build locally install Rust and execute in the project directory:
|
|
```
|
|
git submodule update --init --recursive
|
|
cargo build --release
|
|
./target/release/grin-wallet
|
|
```
|
|
|
|
## License
|
|
|
|
Apache License v2.0
|