mirror of
https://github.com/PeernetOfficial/Cmd.git
synced 2026-07-17 02:47:52 +01:00
New API functions #1:
/blockchain/self/header /blockchain/self/append /blockchain/self/read /blockchain/self/add/file The local blockchain now works, files metadata can be added and blocks read and decoded successfully.
This commit is contained in:
125
API.md
125
API.md
@@ -14,7 +14,7 @@ The API is currently unauthenticated and intentionally provides direct access to
|
||||
|
||||
The API is still in development and endpoints are subject to change. The API should be currently only used for debugging and early phase development purposes.
|
||||
|
||||
## Configuartion
|
||||
## Configuration
|
||||
|
||||
The configuration file (default `Config.yaml`) contains settings for the API. To listen on `http://127.0.0.1:112/` add this line:
|
||||
|
||||
@@ -39,9 +39,10 @@ These are the functions provided by the API:
|
||||
/status/ws Starts a websocket to receive updates on operations immediately (push instead of pull)
|
||||
/console Console provides a websocket to send/receive internal commands
|
||||
|
||||
/blockchain/self/header Header of the self peers blockchain
|
||||
/blockchain/self/read Read the self peers blockchain
|
||||
/blockchain/self/append Add a record to the blockchain
|
||||
/blockchain/self/header Header of the blockchain
|
||||
/blockchain/self/append Append a block to the blockchain
|
||||
/blockchain/self/read Read a block of the blockchain
|
||||
/blockchain/self/add/file Add file to the blockchain
|
||||
```
|
||||
|
||||
The `/share` functions are providing high-level functionality to work with files. The `/blockchain` functions provide low-level functionality which is typically not needed.
|
||||
@@ -61,11 +62,12 @@ type apiResponseStatus struct {
|
||||
Status int `json:"status"` // Status code: 0 = Ok.
|
||||
IsConnected bool `json:"isconnected"` // Whether connected to Peernet.
|
||||
CountPeerList int `json:"countpeerlist"` // Count of peers in the peer list. Note that this contains peers that are considered inactive, but have not yet been removed from the list.
|
||||
CountNetwork int `json:"countnetwork"` // Count of total peers in the network.
|
||||
// This is usually a higher number than CountPeerList, which just represents the current number of connected peers.
|
||||
// The CountNetwork number is going to be queried from root peers which may or may not have a limited view into the network.
|
||||
}
|
||||
```
|
||||
|
||||
Example response data: Todo
|
||||
|
||||
## Self Information
|
||||
|
||||
This function returns information about the current peer.
|
||||
@@ -76,7 +78,7 @@ Request: GET /peer/self
|
||||
Response: 200 with JSON structure apiResponsePeerSelf
|
||||
```
|
||||
|
||||
The peer and node IDs are returned as hex encoded strings.
|
||||
The peer and node IDs are encoded as hex encoded strings.
|
||||
|
||||
```go
|
||||
type apiResponsePeerSelf struct {
|
||||
@@ -85,8 +87,6 @@ type apiResponsePeerSelf struct {
|
||||
}
|
||||
```
|
||||
|
||||
Example response data: Todo
|
||||
|
||||
## Console
|
||||
|
||||
The `/console` websocket allows to execute internal commands. This should be only used for debugging purposes by the end-user. The same input and output as raw text as via the command-line is provided through this endpoint.
|
||||
@@ -94,3 +94,110 @@ The `/console` websocket allows to execute internal commands. This should be onl
|
||||
```
|
||||
Request: ws://127.0.0.1:112/console
|
||||
```
|
||||
|
||||
## Blockchain Self Header
|
||||
|
||||
This function returns information about the current peer. It is not required that a peer has a blockchain. If no data is shared, there are no blocks. The blockchain does not formally have a header as each block has the same structure.
|
||||
|
||||
```
|
||||
Request: GET /blockchain/self/header
|
||||
|
||||
Response: 200 with JSON structure apiBlockchainHeader
|
||||
```
|
||||
|
||||
```go
|
||||
type apiBlockchainHeader struct {
|
||||
PeerID string `json:"peerid"` // Peer ID hex encoded.
|
||||
Version uint64 `json:"version"` // Current version number of the blockchain.
|
||||
Height uint64 `json:"height"` // Height of the blockchain (number of blocks). If 0, no data exists.
|
||||
}
|
||||
```
|
||||
|
||||
## Blockchain Append Block
|
||||
|
||||
This appends a block to the blockchain. This is a low-level function for already encoded blocks.
|
||||
Do not use this function. Adding invalid data to the blockchain may corrupt it which subsequently might result in blacklisting by other peers.
|
||||
|
||||
```
|
||||
Request: POST /blockchain/self/append with JSON structure apiBlockchainBlockRaw
|
||||
|
||||
Response: 200 with JSON structure apiBlockchainBlockStatus
|
||||
```
|
||||
|
||||
```go
|
||||
type apiBlockRecordRaw struct {
|
||||
Type uint8 `json:"type"` // Record Type. See core.RecordTypeX.
|
||||
Data []byte `json:"data"` // Data according to the type.
|
||||
}
|
||||
|
||||
type apiBlockchainBlockRaw struct {
|
||||
Records []apiBlockRecordRaw `json:"records"` // Block records in encoded raw format.
|
||||
}
|
||||
|
||||
type apiBlockchainBlockStatus struct {
|
||||
Status int `json:"status"` // Status: 0 = Success, 1 = Error invalid data
|
||||
Version uint64 `json:"version"` // Current version number of the blockchain.
|
||||
Height uint64 `json:"height"` // Height of the blockchain (number of blocks).
|
||||
}
|
||||
```
|
||||
|
||||
## Blockchain Read Block
|
||||
|
||||
This reads a block of the current peer.
|
||||
|
||||
```
|
||||
Request: GET /blockchain/self/read?block=[number]
|
||||
|
||||
Response: 200 with JSON structure apiBlockchainBlock
|
||||
```
|
||||
|
||||
```go
|
||||
type apiBlockchainBlock struct {
|
||||
Status int `json:"status"` // Status: 0 = Success, 1 = Error block not found, 2 = Error block encoding (indicates that the blockchain is corrupt)
|
||||
PeerID string `json:"peerid"` // Peer ID hex encoded.
|
||||
LastBlockHash []byte `json:"lastblockhash"` // Hash of the last block. Blake3.
|
||||
BlockchainVersion uint64 `json:"blockchainversion"` // Blockchain version
|
||||
Number uint64 `json:"blocknumber"` // Block number
|
||||
RecordsRaw []apiBlockRecordRaw `json:"recordsraw"` // Block records raw. Successfully decoded records are parsed into the below fields.
|
||||
decoded struct {
|
||||
User apiBlockRecordUser `json:"user"` // User details
|
||||
Files []apiBlockRecordFile `json:"files"` // Files
|
||||
} `json:"decoded"`
|
||||
}
|
||||
|
||||
type apiBlockRecordUser struct {
|
||||
NameValid bool `json:"namevalid"` // Whether the name is supplied in this structure.
|
||||
Name string `json:"name"` // Arbitrary name of the user.
|
||||
NameSanitized string `json:"namesanitized"` // Sanitized version of the name.
|
||||
}
|
||||
|
||||
type apiBlockRecordFile struct {
|
||||
Hash []byte // Hash of the file data
|
||||
Type uint8 // Type (low-level)
|
||||
Format uint16 // Format (high-level)
|
||||
Size uint64 // Size of the file
|
||||
Directory string // Directory
|
||||
Name string // File name
|
||||
}
|
||||
```
|
||||
|
||||
## Blockchain Add File
|
||||
|
||||
This adds a file with the provided information to the blockchain.
|
||||
|
||||
```
|
||||
Request: POST /blockchain/self/add/file with JSON structure apiBlockAddFiles
|
||||
|
||||
Response: 200 with JSON structure apiBlockchainBlockStatus
|
||||
```
|
||||
|
||||
```go
|
||||
type apiBlockAddFiles struct {
|
||||
Files []apiBlockRecordFile `json:"files"`
|
||||
}
|
||||
|
||||
type apiBlockchainBlockStatus struct {
|
||||
Status int `json:"status"` // Status: 0 = Success, 1 = Error invalid data
|
||||
Height uint64 `json:"height"` // New height of the blockchain (number of blocks).
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user