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

Update API docs (#3277)

Browse source
This commit is contained in:
jaspervdm 2020-03-28 12:53:20 +01:00 committed by GitHub
parent d036332028
commit 7385e8ce7f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/api/api.md
View file

@ -1,13 +1,20 @@
# Grin API Documentation
This document contains the documentation for the Node Grin REST API.
Used to query a node about various information on the blockchain, networks and peers. By default, the API will listen on `localhost:3413`. The API is started as the same time as the Grin node.
This endpoint requires, by default, [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). The username is `grin`.
## Node API
## Node API v2
This endpoint is used to query a node about various information on the blockchain, networks and peers. By default, this REST API will listen on `localhost:3413`. This API is started as the same time as the Grin node.
This endpoint requires, by default, [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_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 [node API doc](node_api.md).
This API version uses jsonrpc for its requests. It is split up in a foreign API and an owner API. The documentation for these endpoints is automatically generated:
- [Owner API](https://docs.rs/grin_api/latest/grin_api/trait.OwnerRpc.html)
- [Foreign API](https://docs.rs/grin_api/latest/grin_api/trait.ForeignRpc.html)
## Ports above 10000?
Basic auth passwords can be found in `.api_secret`/`.foreign_api_secret` files respectively.
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.
## Node API v1
**Note:** version 1 of the API will be deprecated in v4.0.0 and subsequently removed in v5.0.0. Users of this API are encouraged to upgrade to API v2.
This API uses REST for its requests. To learn about what specific calls can be made read the [node API v1 doc](node_api_v1.md).
Basic auth password can be found in `.api_secret`

2
doc/api/node_api.md → doc/api/node_api_v1.md
View file

@ -1,4 +1,4 @@
# Node API Documentation
# Node API v1 Documentation
## Table of Contents