README
¶
fc-retrieval-gateway
Filecoin Retrieval Gateway
Start the service
Create a config file
Create a .env file, using .env.example as a reference:
cp .env.example .env
=======
## Development
### Start the service with Docker
Start the service:
make dev
The APIs should be available at
- Client Api: `http://localhost:9010`
- Provider Api: `http://localhost:9011`
- Gateway Api: `http://localhost:9012`
- Admin Api: `http://localhost:9013`
To rebuild containers, following option can be used:
make dev arg=--build
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gateway
command
Package main - program entry point for a Retrieval Gateway node.
|
Package main - program entry point for a Retrieval Gateway node. |
|
Package config - combines operations used to setup parameters for Gateway node in FileCoin network
|
Package config - combines operations used to setup parameters for Gateway node in FileCoin network |
|
internal
|
|
|
api
Package api contains code for managing the REST API of the web service.
|
Package api contains code for managing the REST API of the web service. |
|
api/adminapi
Package adminapi contains the API code for the admin client - gateway communication.
|
Package adminapi contains the API code for the admin client - gateway communication. |
|
api/clientapi
Package clientapi - set of remote API used to call a Gateway, grouped to a specific caller type - Retrieval Client.
|
Package clientapi - set of remote API used to call a Gateway, grouped to a specific caller type - Retrieval Client. |
|
api/gatewayapi
Package gatewayapi - set of remote API used to call a Gateway, grouped to a specific caller type - Retrieval Gateway.
|
Package gatewayapi - set of remote API used to call a Gateway, grouped to a specific caller type - Retrieval Gateway. |
|
api/providerapi
Package providerapi contains the API code for the provider - gateway.
|
Package providerapi contains the API code for the provider - gateway. |
|
core
Package core - structure representing a Gateway's current state, including setting, configuration, references to all running Gateway APIs of this instance.
|
Package core - structure representing a Gateway's current state, including setting, configuration, references to all running Gateway APIs of this instance. |
|
reputation
Package reputation - contains operations related to blockchain network participants' favorability marking.
|
Package reputation - contains operations related to blockchain network participants' favorability marking. |
|
util
Package util contains a range of utility code.
|
Package util contains a range of utility code. |
|
util/settings
Package settings - holds configuration specific to a Retrieval Gateway node.
|
Package settings - holds configuration specific to a Retrieval Gateway node. |
|
scripts
|
|
|
make-env-file
command
|
Click to show internal directories.
Click to hide internal directories.