The Fil+ Backend is a web service aiming to provide several HTTP endpoints to manage LDN applications, perform actions on filecoin github and read blockchain data related to applications.
The backend has two different external services:
- Github: used to manage applications.
- Blockchain data(using demob): used to validate data related to the different lifecycles of the application.
These services are the backbone for the core code that will be modifying the applications, this code is located under "core" folder and it is basically defining the structure of the json file, and a way of changing the file.
Another important section is the parsers.rs this file include the
parsers that validate the structure and format of the json file.
TBD
https://app.swaggerhub.com/apis/jesraa/FilecoinBackend/1.0.0#/
There are two different kinds of endpoints:
-
/application: these endpoints are util to manage the application. you can start by making a POST method to/applicationwith the application id(see swagger documentation for detailed api documentation). Currently the application id is the github issue. after creating application via the endpoint, a new pull request will be created with a json file with initial data. Next step for the application is to be reviewed by governance team. once they are happy with it they can hit/application/{id}/triggerto move the application to proposal state. Next, a notary should review the application and sign it with their ledger. In order for the notary to document the signature, they call/application/{id}/proposewith data related to the blockchain tx made. Next step is the same as the one before, but you would call/application/{id}/approve. In that stage, the application is granted and completed. in order to merge the pull request you can call/application/{id}/merge. -
/blockchain: these endpoints retrive blockchain data related to ldn applications. it is using demob as a data source.
- Install Rust
- Add env variables (an example present in the repo)
cargo run
TBD
TBD