Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe the two APIs at a high level #14

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Describe the two APIs at a high level #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions chainweb.openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,23 @@ openapi: '3.0'
info:
title: Kadena Chainweb Node API
description: |
Help improve this documentation: [GitHub](https://github.com/kadena-io/chainweb-openapi/issues)

API of [chainweb-node](https://github.com/kadena-io/chainweb-node)

Chainweb is a scalable Proof-Of-Work (PoW) consensus algorithm. It is an
conservative extension of Bitcoin's Nakamoto consensus that extends
Bitcoin's single chain algorithm to multiple chains. This allows for
unlimited transaction throughput by horizontally scaling the number of chains.

Feedback and bug reports for the content of this site are welcome. Please
open an issue at [this github repository](https://github.com/kadena-io/chainweb-openapi/issues).
The node exposes two distinct APIs: the P2P API and the Service API. They
are served on separate ports. The P2P API contains the RPC endpoints that
are mandatory for nodes to expose. These endpoints should typically be
more efficient than Service API endpoints for most use cases. The Service
API contains RPC endpoints that can be used to create more load on the
node and may have reason to be proxied differently for rate limiting or
other purposes.

version: '0.0'
x-logo:
url: 'https://i.imgur.com/bAZFAGF.png'
Expand Down