README
¶
broker-core
Broker for the Filecoin network
Join us on our public Slack channel for news, discussions, and status updates. Check out our blog for the latest posts and announcements.
Important note
This repository has been archived and is no longer maintained. If you are looking for an alternative tool to use, try one of these: Estuary, Web3 Storage, or lookout for the coming release of ♠️(SPADE).
Table of Contents
Background
Broker packs and auctions uploaded data to storage providers on the Filecoin network.
Install
go get github.com/textileio/broker-core
Getting Started
Storage providers: Run a bidbot
Storage providers on the Filecoin Network can bid in storage deal auctions.
Refer to the Bidbot repo.
Running locally with some test data
The bench.sh script depends on the $SEED_PHRASE environment variable for locking NEAR funds (the seed phrase itself is available in 1Password in "NEAR Developers").
$ REPO_PATH=. make up
$ cmd/storaged/bench.sh 127.0.0.1:8888 100 200 10 0.1
CI/CD
The k8 folder contains manifests to deploy the Broker system to a Kubernetes cluster.
The system is automatically deployed with the following rules:
- There are three environments:
edge,staging, andproduction(these correspond to k8 namespaces). - Any push on any branch will trigger a deploy to
edgeif the commit message contains the substring[shipit]😎. - Any push to
main(including pull request merges) will trigger a deploy tostaging. - Releases trigger a deploy to
production.
A bot named uploadbot also is available to run in any environment. To run it, go to the k8 folder and run DEPLOYMENT=<production|staging|edge> make run-uploadbot.
Dashboard
A Grafana dashboard are available to have observability in the system. To sign in, use your GH account that should be part of the Textile organization.
Contributing
Pull requests and bug reports are very welcome ❤️
This repository falls under the Textile Code of Conduct.
Feel free to get in touch by:
- Opening an issue
- Joining the public Slack channel
- Sending an email to contact@textile.io
Changelog
A changelog is published along with each release.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
apid/store/migrations
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql
|
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql |
|
auctioneerd/auctioneer/queue/migrations
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql migrations/002_bids_support_calculating_rates.down.sql migrations/002_bids_support_calculating_rates.up.sql migrations/003_auctions_add_client_address.down.sql migrations/003_auctions_add_client_address.up.sql migrations/004_bids_add_won_reason.down.sql migrations/004_bids_add_won_reason.up.sql migrations/005_auctions_add_providers.down.sql migrations/005_auctions_add_providers.up.sql migrations/006_consume_bidbot_events.down.sql migrations/006_consume_bidbot_events.up.sql migrations/007_bids_add_deal_failed_at.down.sql migrations/007_bids_add_deal_failed_at.up.sql migrations/008_leader_board.down.sql migrations/008_leader_board.up.sql migrations/009_leader_board_update.down.sql migrations/009_leader_board_update.up.sql migrations/010_leader_board_update2.down.sql migrations/010_leader_board_update2.up.sql migrations/011_leader_board_update3.down.sql migrations/011_leader_board_update3.up.sql migrations/012_leader_board_update4.down.sql migrations/012_leader_board_update4.up.sql migrations/013_leader_board_update5.down.sql migrations/013_leader_board_update5.up.sql migrations/014_leader_board_update6.down.sql migrations/014_leader_board_update6.up.sql
|
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql migrations/002_bids_support_calculating_rates.down.sql migrations/002_bids_support_calculating_rates.up.sql migrations/003_auctions_add_client_address.down.sql migrations/003_auctions_add_client_address.up.sql migrations/004_bids_add_won_reason.down.sql migrations/004_bids_add_won_reason.up.sql migrations/005_auctions_add_providers.down.sql migrations/005_auctions_add_providers.up.sql migrations/006_consume_bidbot_events.down.sql migrations/006_consume_bidbot_events.up.sql migrations/007_bids_add_deal_failed_at.down.sql migrations/007_bids_add_deal_failed_at.up.sql migrations/008_leader_board.down.sql migrations/008_leader_board.up.sql migrations/009_leader_board_update.down.sql migrations/009_leader_board_update.up.sql migrations/010_leader_board_update2.down.sql migrations/010_leader_board_update2.up.sql migrations/011_leader_board_update3.down.sql migrations/011_leader_board_update3.up.sql migrations/012_leader_board_update4.down.sql migrations/012_leader_board_update4.up.sql migrations/013_leader_board_update5.down.sql migrations/013_leader_board_update5.up.sql migrations/014_leader_board_update6.down.sql migrations/014_leader_board_update6.up.sql |
|
authd/store/migrations
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql
|
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql |
|
brokerd/store/migrations
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql migrations/002_rw.down.sql migrations/002_rw.up.sql migrations/003_providers.down.sql migrations/003_providers.up.sql migrations/004_status_enums.down.sql migrations/004_status_enums.up.sql migrations/005_payload_size.down.sql migrations/005_payload_size.up.sql migrations/006_add_dealstartoffset.down.sql migrations/006_add_dealstartoffset.up.sql migrations/007_piececididx.down.sql migrations/007_piececididx.up.sql
|
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql migrations/002_rw.down.sql migrations/002_rw.up.sql migrations/003_providers.down.sql migrations/003_providers.up.sql migrations/004_status_enums.down.sql migrations/004_status_enums.up.sql migrations/005_payload_size.down.sql migrations/005_payload_size.up.sql migrations/006_add_dealstartoffset.down.sql migrations/006_add_dealstartoffset.up.sql migrations/007_piececididx.down.sql migrations/007_piececididx.up.sql |
|
dealerd/store/migrations
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql migrations/002_market_status.down.sql migrations/002_market_status.up.sql migrations/003_remote_wallet.down.sql migrations/003_remote_wallet.up.sql migrations/004_dealer_api.down.sql migrations/004_dealer_api.up.sql migrations/005_market_deal_status_comment.down.sql migrations/005_market_deal_status_comment.up.sql migrations/006_postgraphile_status_enum.down.sql migrations/006_postgraphile_status_enum.up.sql migrations/007_dealuid.down.sql migrations/007_dealuid.up.sql migrations/008_boost_whitelist_removal.down.sql migrations/008_boost_whitelist_removal.up.sql
|
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql migrations/002_market_status.down.sql migrations/002_market_status.up.sql migrations/003_remote_wallet.down.sql migrations/003_remote_wallet.up.sql migrations/004_dealer_api.down.sql migrations/004_dealer_api.up.sql migrations/005_market_deal_status_comment.down.sql migrations/005_market_deal_status_comment.up.sql migrations/006_postgraphile_status_enum.down.sql migrations/006_postgraphile_status_enum.up.sql migrations/007_dealuid.down.sql migrations/007_dealuid.up.sql migrations/008_boost_whitelist_removal.down.sql migrations/008_boost_whitelist_removal.up.sql |
|
packerd/store/migrations
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql
|
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql |
|
piecerd/store/migrations
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql
|
Package migrations generated by go-bindata.// sources: migrations/001_init.down.sql migrations/001_init.up.sql |
|
gen
|
|
|
mocks
|
|
Click to show internal directories.
Click to hide internal directories.