{"id":22998417,"url":"https://github.com/tablelandnetwork/basin-provider","last_synced_at":"2025-08-14T00:32:18.136Z","repository":{"id":196123237,"uuid":"680207409","full_name":"tablelandnetwork/basin-provider","owner":"tablelandnetwork","description":"Data ingestion for Tableland Basin","archived":false,"fork":false,"pushed_at":"2024-03-22T19:45:08.000Z","size":772,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-03-22T20:37:08.803Z","etag":null,"topics":["basin","depin","filecoin"],"latest_commit_sha":null,"homepage":"https://tableland.xyz","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tablelandnetwork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-08-18T15:50:14.000Z","updated_at":"2023-12-18T16:59:37.000Z","dependencies_parsed_at":"2023-10-02T23:48:12.683Z","dependency_job_id":"7451f5c3-8276-4a42-a7f1-1710d1e4f08a","html_url":"https://github.com/tablelandnetwork/basin-provider","commit_stats":null,"previous_names":["tablelandnetwork/basin-provider"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tablelandnetwork%2Fbasin-provider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tablelandnetwork%2Fbasin-provider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tablelandnetwork%2Fbasin-provider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tablelandnetwork%2Fbasin-provider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tablelandnetwork","download_url":"https://codeload.github.com/tablelandnetwork/basin-provider/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229786993,"owners_count":18124014,"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":["basin","depin","filecoin"],"created_at":"2024-12-15T06:13:21.564Z","updated_at":"2024-12-15T06:13:22.247Z","avatar_url":"https://github.com/tablelandnetwork.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# basin-provider\n\n[![Test](https://github.com/tablelandnetwork/basin-provider/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/tablelandnetwork/basin-provider/actions/workflows/test.yml)\n[![License](https://img.shields.io/github/license/tablelandnetwork/basin-provider.svg)](./LICENSE)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg)](https://github.com/RichardLitt/standard-readme)\n\n\u003e Data ingestion for Tableland Basin\n\n# Table of Contents\n\n- [basin-provider](#basin-provider)\n- [Table of Contents](#table-of-contents)\n- [Background](#background)\n- [Usage](#usage)\n  - [Basin Worker](#basin-worker)\n- [Development](#development)\n  - [Running](#running)\n  - [Run Tests](#run-tests)\n- [Contributing](#contributing)\n- [License](#license)\n\n# Background\n\nTableland Basin is a secure and verifiable open data platform. The Basin Provider is a collection of daemons and libraries that work in conjuction with [`basin-cli`](https://github.com/tablelandnetwork/basin-cli.git) and [`basin-storage`](https://github.com/tablelandnetwork/basin-storage.git).\n\n`basin-provider` is responsible for ingesting Basin Publications that are archived on Filecoin by [`basin-storage`](https://github.com/tablelandnetwork/basin-storage.git). Publication data can be ingested in two forms:\n1. Continuously published data from a connected database (currently, only PostgreSQL is supported)\n2. Raw parquet files\n\nSee [`basin-cli`](https://github.com/tablelandnetwork/basin-cli.git) for usage info.\n\nThis repo contains the following crates:\n- [`basin_worker`](/lib/worker)`: Daemon that exposes a Cap’n Proto RPC API for creating publications and ingesting publication data.\n[`basin-storage`](https://github.com/tablelandnetwork/basin-storage.git).\n- [`basin_evm`](/lib/evm): Rust bindings for the [`basin-storage`](https://github.com/tablelandnetwork/basin-storage.git) EVM contract.\n- [`basin_protocol`](/lib/protocol): Cap’n Proto protocol definitions and Rust bindings.\n- [`basin_common`](/lib/common): Shared types and utilities.\n\n🚧 Basin is currently not in a production-ready state. Any data that is pushed to the network may be subject to deletion. 🚧\n\n# Usage\n\n## Basin Worker\n\n```bash\nbasin_worker --help\n\nIngest daemon for Tableland Basin\n\nUsage: basin_worker [OPTIONS] --export-bucket \u003cEXPORT_BUCKET\u003e --export-credentials \u003cEXPORT_CREDENTIALS\u003e --database-url \u003cDATABASE_URL\u003e\n\nOptions:\n      --evm-type \u003cEVM_TYPE\u003e\n          EVM type (other EVM flags are ignored when this is 'mem')\n\n          [env: EVM_TYPE=]\n          [default: remote]\n\n          Possible values:\n          - mem:    Use an in-memory ephemeral EVM w/ random wallet (a BasinStorage contract will be deployed)\n          - remote: Requires wallet private key, contract address, provider URL, and chain ID\n\n      --evm-wallet-pk \u003cEVM_WALLET_PK\u003e\n          Wallet private key (ECDSA, secp256k1) to use with the EVM (must have PUB_ADMIN_ROLE)\n\n          [env: EVM_WALLET_PK=]\n\n      --evm-contract-address \u003cEVM_CONTRACT_ADDRESS\u003e\n          BasinStorage EVM contract address (ECDSA, secp256k1)\n\n          [env: EVM_CONTRACT_ADDRESS=]\n\n      --evm-provider-url \u003cEVM_PROVIDER_URL\u003e\n          EVM provider URL\n\n          [env: EVM_PROVIDER_URL=]\n          [default: http://127.0.0.1:8545]\n\n      --evm-chain-id \u003cEVM_CHAIN_ID\u003e\n          EVM chain ID\n\n          [env: EVM_CHAIN_ID=]\n          [default: 31337]\n\n      --export-bucket \u003cEXPORT_BUCKET\u003e\n          Parquet export GCS bucket\n\n          [env: EXPORT_BUCKET=]\n\n      --export-credentials \u003cEXPORT_CREDENTIALS\u003e\n          Parquet export sink credentials\n\n          [env: EXPORT_CREDENTIALS=]\n\n      --database-url \u003cDATABASE_URL\u003e\n          Postgres-style database URL\n\n          [env: DATABASE_URL=]\n\n      --bind-address \u003cBIND_ADDRESS\u003e\n          Host and port to bind the RPC API to\n\n          [env: BIND_ADDRESS=]\n          [default: 127.0.0.1:3000]\n\n      --bind-health-address \u003cBIND_HEALTH_ADDRESS\u003e\n          Host and port to bind the Health API to\n\n          [env: BIND_HEALTH_ADDRESS=]\n          [default: 127.0.0.1:3001]\n\n  -v, --verbosity...\n          Logging verbosity (repeat for more verbose logging)\n          \n          [env: VERBOSITY=]\n\n  -q, --quiet\n          Silence logging\n          \n          [env: QUIET=]\n\n  -h, --help\n          Print help (see a summary with '-h')\n\n  -V, --version\n          Print version\n```\n\n# Development\n\n## Running\n\n```bash\ndocker compose up\n```\n\n## Run Tests\n\n```bash\ndocker compose up crdb\ncargo test\n```\n\n# Contributing\n\nPRs accepted.\n\nSmall note: If editing the README, please conform to the\n[standard-readme](https://github.com/RichardLitt/standard-readme) specification.\n\n# License\n\nMIT AND Apache-2.0, © 2021-2023 Tableland Network Contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftablelandnetwork%2Fbasin-provider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftablelandnetwork%2Fbasin-provider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftablelandnetwork%2Fbasin-provider/lists"}