opensource/lotus
1
0
Fork 0
mirror of https://github.com/filecoin-project/lotus.git synced 2025-08-26 02:38:58 +08:00
Code Issues Projects Releases Wiki Activity

api: Document API change process

Browse Source
This commit is contained in:
Łukasz Magiera
2021-04-26 20:36:20 +02:00
parent 86d4f5f738
commit bfa332ca7d
7 changed files with 95 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
api/v0api/full.go
View File

@ -26,6 +26,23 @@ import (
//go:generate go run github.com/golang/mock/mockgen -destination=v0mocks/mock_full.go -package=v0mocks . FullNode
// MODIFYING THE API INTERFACE
//
// NOTE: This is the V0 (Stable) API - when adding methods to this interface,
// you'll need to make sure they are also present on the V1 (Unstable) API
//
// This API is implemented in `v1_wrapper.go` as a compatibility layer backed
// by the V1 api
//
// When adding / changing methods in this file:
// * Do the change here
// * Adjust implementation in `node/impl/`
// * Run `make gen` - this will:
// * Generate proxy structs
// * Generate mocks
// * Generate markdown docs
// * Generate openrpc blobs
// FullNode API is a low-level interface to the Filecoin network full node
type FullNode interface {
Common