Core/grin-wallet
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin-wallet.git synced 2025-01-20 19:11:09 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docstring update and provide a bit of a readme (#104)

Browse source
This commit is contained in:
Yeastplume 2019-05-16 09:17:54 +01:00 committed by GitHub
parent af6a6249e0
commit 45750c8837
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -7,3 +7,20 @@
[![License](https://img.shields.io/github/license/mimblewimble/grin-wallet.svg)](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.
# 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)
# License
Apache License v2.0

2
api/src/owner_rpc.rs
View file

@ -25,7 +25,7 @@ use crate::Owner;
use easy_jsonrpc;
/// Public definition used to generate Owner jsonrpc api.
/// * When running `grin-wallet listen` with defaults, the V2 api is available at
/// * When running `grin-wallet owner_api` with defaults, the V2 api is available at
/// `localhost:3420/v2/owner`
/// * The endpoint only supports POST operations, with the json-rpc request as the body
#[easy_jsonrpc::rpc]