From 0e0ec247e42cb4785b980a4191c59538a34c972d Mon Sep 17 00:00:00 2001 From: Simon B Date: Fri, 25 Jan 2019 11:08:08 +0100 Subject: [PATCH] fix owner_api docs: wrong port number (#2442) * 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 --- doc/api/api.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/api/api.md b/doc/api/api.md index 6facdea4a..616373bee 100644 --- a/doc/api/api.md +++ b/doc/api/api.md @@ -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.