{"id":18841461,"url":"https://github.com/subvisual/fidl","last_synced_at":"2026-01-30T11:30:15.909Z","repository":{"id":257862176,"uuid":"865936032","full_name":"subvisual/fidl","owner":"subvisual","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-14T18:04:29.000Z","size":401,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T18:30:34.619Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/subvisual.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-01T11:24:04.000Z","updated_at":"2025-02-14T18:04:30.000Z","dependencies_parsed_at":"2024-10-16T19:37:23.412Z","dependency_job_id":"5669778a-e9d1-446b-b2e1-3662b8862a03","html_url":"https://github.com/subvisual/fidl","commit_stats":null,"previous_names":["subvisual/fidl"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subvisual%2Ffidl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subvisual%2Ffidl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subvisual%2Ffidl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subvisual%2Ffidl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/subvisual","download_url":"https://codeload.github.com/subvisual/fidl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239780122,"owners_count":19695734,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T02:51:27.382Z","updated_at":"2026-01-30T11:30:15.866Z","avatar_url":"https://github.com/subvisual.png","language":"Go","readme":"# FIDL\n\n## Table of Contents\n\n-   [Overview](#overview)\n-   [CLI (Command Line Interface)](#cli)\n-   [Service/Bank](#bank)\n-   [Proxy](#proxy)\n-   [License](#license)\n\n## Overview\n\nFIDL is an on-going development project consisting in three different components:\n\n-   [CLI (Command Line Interface)](#cli): client to deposit FIL funds and request retrievals from storage providers\n-   [Service/Bank](#bank): http server to act as a service/bank\n    -   [Migrations](#migrations): postgres database\n-   [Proxy](#proxy): http server to be installed on storage providers, to bridge the communication between clients and the service/bank\n\nExample of configuration files for each component on the folder `etc`.\n\n## CLI\n\nTo run the CLI: `go run cmd/cli/main.go --config=\"etc/cli.ini.example\"`\n\nWith the following available commands:\n\n-   `authorize -p \u003cproxy_wallet_address\u003e -b \u003cbank_address\u003e`\n-   `balance -b \u003cbank_address\u003e`\n-   `deposit -a \u003camount\u003e -b \u003cbank_address\u003e -p \u003cbank_wallet_address\u003e`\n-   `refund -b \u003cbank_address\u003e`\n-   `withdraw -a \u003camount\u003e -d \u003cdestination\u003e -b \u003cbank_address\u003e`\n-   `banks -p \u003cproxy_address\u003e`\n-   `retrieval -p \u003cproxy_address\u003e -i \u003cpiece_cid\u003e -a \u003cauthorization\u003e`\n\n## Service/Bank\n\nTo run the Bank: `go run cmd/bank/main.go --config=\"etc/bank.ini.example\"`\n\nHTTP server API featuring the following endpoints:\n\n-   GET `/api/v1/healthcheck`: healthcheck to verify if the server is properly running\n-   POST `/api/v1/register`: registers a proxy on the bank\n-   POST `/api/v1/deposit`: client deposits FIL funds on the bank\n-   POST `/api/v1/withdraw`: client withdraws FIL funds from the bank\n-   GET `/api/v1/balance`: checks client's balance\n-   POST `/api/v1/authorize`: authorizes transaction\n-   GET `/api/v1/refund`: client refunds all the expired FIL funds on escrow\n-   POST `/api/v1/redeem`: proxy redeems funds of transaction\n-   POST `/api/v1/verify`: proxy verifies an authorization\n\n### Migrations\n\nMigrations are managed by [go-migrate](https://github.com/golang-migrate/migrate#cli-usage)\n\nTo run migrations:\n`migrate -path=./bank/postgres/migrations -database=$DSN up`\n\n-   `$DSN` should contain your database data source string\n\n### Makefile\n\nA makefile is available to easily deploy the database and run the migrations:\n\n-   `make db:create`: creates the database\n-   `make db:drop`: drops the database\n-   `make db:migrate:up`: runs the migrations\n-   `make db:migrate:down`: rolls back the migrations\n-   `make db:migrate:force`: force dirty database migrations for given version\n-   `make migration:create`: creates a new migration with specified name\n\n## Proxy\n\nTo run the Proxy: `go run cmd/proxy/main.go --config=\"etc/proxy.ini.example\"`\n\nHTTP server API featuring the following endpoints:\n\n-   GET `/api/v1/healthcheck`: healthcheck to verify if the server is properly running\n-   GET `/api/v1/banks`: show the banks that the proxy is registered with\n-   GET `/api/v1/fetch/{piece_cid}`: to request a file retrieval to booster-http, given a `piece-cid`\n\n## License\n\nDual-licensed under [MIT](https://github.com/subvisual/fidl/blob/main/LICENSE-MIT) + [Apache 2.0](https://github.com/subvisual/fidl/blob/main/LICENSE-APACHE)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubvisual%2Ffidl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsubvisual%2Ffidl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubvisual%2Ffidl/lists"}