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

fix owner_api docs: wrong port number (#2442)

Browse source 
* fix owner_api docs: wrong port number

* update ports since PR #2405. We now allow both floo and mainnet owner_apis to run in parallell on a single server, with ports 13420 or 3420

* correction since there is no --mainnet flag

* fixes the comment by @karkagis
This commit is contained in:
Simon B 2019-01-25 11:08:08 +01:00 committed by Antioch Peverell
parent 2e22e2c6ec
commit 0e0ec247e4
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/api/api.md
View file

@ -17,6 +17,13 @@ To learn about what specific calls can be made read the [wallet foreign API doc]
### Wallet Owner API
The wallet owner API is an endpoint to manage the user wallet: broadcast transaction, sign transaction, see the current balance... This REST API can be started with the `grin wallet owner_api` command and will listen on `localhost:3420`. This endpoint must **never** be exposed to the outside world.
The wallet owner API is an endpoint to manage the user wallet: broadcast transaction, sign transaction, see the current balance... This REST API can be started with the `grin wallet owner_api` command and will listen on `localhost:3420`.
__This endpoint must **never** be exposed to the outside world.__
This endpoint requires, by default, Basic Authentication. The username is `grin` and the password can be found in the `.api_secret` file.
To learn about what specific calls can be made read the [wallet owner API doc](wallet_owner_api.md).
## Ports above 10000?
All ports should be below 10000 when running with default settings on mainnet. If your grin owner_api is using the 13420 port but is on mainnet, then you're using an outdated version of grin.