FIDL

Table of Contents

• Overview
• CLI (Command Line Interface)
• Service/Bank
• Proxy
• License

Overview

FIDL is an on-going development project consisting in three different components:

• CLI (Command Line Interface): client to deposit FIL funds and request retrievals from storage providers
• Service/Bank: http server to act as a service/bank
  • Migrations: postgres database
• Proxy: http server to be installed on storage providers, to bridge the communication between clients and the service/bank

Example of configuration files for each component on the folder etc.

CLI

To run the CLI: go run cmd/cli/main.go --config="etc/cli.ini.example"

With the following available commands:

• authorize -p <proxy_wallet_address> -b <bank_address>
• balance -b <bank_address>
• deposit -a <amount> -b <bank_address> -p <bank_wallet_address>
• refund -b <bank_address>
• withdraw -a <amount> -d <destination> -b <bank_address>
• banks -p <proxy_address>
• retrieval -p <proxy_address> -i <piece_cid> -a <authorization>

Service/Bank

To run the Bank: go run cmd/bank/main.go --config="etc/bank.ini.example"

HTTP server API featuring the following endpoints:

• GET /api/v1/healthcheck: healthcheck to verify if the server is properly running
• POST /api/v1/register: registers a proxy on the bank
• POST /api/v1/deposit: client deposits FIL funds on the bank
• POST /api/v1/withdraw: client withdraws FIL funds from the bank
• GET /api/v1/balance: checks client's balance
• POST /api/v1/authorize: authorizes transaction
• GET /api/v1/refund: client refunds all the expired FIL funds on escrow
• POST /api/v1/redeem: proxy redeems funds of transaction
• POST /api/v1/verify: proxy verifies an authorization

Migrations

Migrations are managed by go-migrate

To run migrations: migrate -path=./bank/postgres/migrations -database=$DSN up

• $DSN should contain your database data source string

Makefile

A makefile is available to easily deploy the database and run the migrations:

• make db:create: creates the database
• make db:drop: drops the database
• make db:migrate:up: runs the migrations
• make db:migrate:down: rolls back the migrations
• make db:migrate:force: force dirty database migrations for given version
• make migration:create: creates a new migration with specified name

Proxy

To run the Proxy: go run cmd/proxy/main.go --config="etc/proxy.ini.example"

HTTP server API featuring the following endpoints:

• GET /api/v1/healthcheck: healthcheck to verify if the server is properly running
• GET /api/v1/banks: show the banks that the proxy is registered with
• GET /api/v1/fetch/{piece_cid}: to request a file retrieval to booster-http, given a piece-cid

License

Dual-licensed under MIT + Apache 2.0