{"id":20245101,"url":"https://github.com/interlay/interbtc-clients","last_synced_at":"2026-03-05T08:32:45.908Z","repository":{"id":37416009,"uuid":"331293852","full_name":"interlay/interbtc-clients","owner":"interlay","description":"interBTC Clients | Vault, Oracle, Faucet","archived":false,"fork":false,"pushed_at":"2025-10-15T09:24:49.000Z","size":26585,"stargazers_count":53,"open_issues_count":45,"forks_count":31,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-10-22T15:51:53.550Z","etag":null,"topics":["bitcoin","interbtc","polkadot","rust","substrate","vault"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/interlay.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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-01-20T12:02:29.000Z","updated_at":"2025-10-13T15:56:12.000Z","dependencies_parsed_at":"2024-03-13T14:57:50.895Z","dependency_job_id":"01bc1314-f057-47db-8134-596997ef7a83","html_url":"https://github.com/interlay/interbtc-clients","commit_stats":null,"previous_names":[],"tags_count":155,"template":false,"template_full_name":null,"purl":"pkg:github/interlay/interbtc-clients","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interlay%2Finterbtc-clients","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interlay%2Finterbtc-clients/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interlay%2Finterbtc-clients/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interlay%2Finterbtc-clients/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/interlay","download_url":"https://codeload.github.com/interlay/interbtc-clients/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interlay%2Finterbtc-clients/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30115941,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T08:19:04.902Z","status":"ssl_error","status_checked_at":"2026-03-05T08:17:37.148Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["bitcoin","interbtc","polkadot","rust","substrate","vault"],"created_at":"2024-11-14T09:18:56.803Z","updated_at":"2026-03-05T08:32:45.878Z","avatar_url":"https://github.com/interlay.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/interlay/interbtc-clients\"\u003e\n    \u003cimg alt=\"interBTC Clients\" src=\"media/banner.jpg\"\u003e\n  \u003c/a\u003e\n  \u003ch2 align=\"center\"\u003einterBTC Clients\u003c/h2\u003e\n\n  \u003cp align=\"center\"\u003e\n    Faucet, Oracle \u0026 Vault / Relayer\n  \u003c/p\u003e\n\u003c/p\u003e\n\n_This project is currently under active development_.\n\n## Getting started\n\n### Prerequisites\n\n```\ncurl https://sh.rustup.rs -sSf | sh\n```\n\nPlease also install the following dependencies:\n\n- `cmake`\n- `clang` (\u003e=10.0.0)\n- `clang-dev`\n- `libc6-dev`\n- `libssl-dev`\n- `pkg-config` (on Ubuntu)\n\n### Installation\n\n#### Faucet\n\nThe testnet may use a faucet to allow users and vaults to self-fund up to a daily limit.\n\nTo start the Faucet follow the instructions contained in the [Faucet README](./faucet/README.md).\n\n#### Oracle\n\nThe interBTC bridge requires a price oracle to calculate collateralization rates, for local development we can run this client\nto automatically update the exchange rate at a pre-determined time interval.\n\nTo start the Oracle follow the instructions contained in the [Oracle README](./oracle/README.md).\n\n#### Vault\n\nThe Vault client is used to intermediate assets between Bitcoin and the BTC Parachain.\nIt is also capable of submitting Bitcoin block headers to the BTC Parachain.\n\nTo start the Vault follow the instructions contained in the [Vault README](./vault/README.md).\n\n### Development\n\nBuilding requires a specific rust toolchain and nightly compiler version. The\nrequirements are specified in the [./rust-toolchain.toml](./rust-toolchain.toml)\n[override file](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file).\n\nRunning `rustup show` from the root directory of this repo should be enough to\nset up the toolchain and you can inspect the output to verify that it matches\nthe version specified in the override file.\n\nUse the following command to fetch the newest metadata from a live chain:\n\n```shell\ncurl -sX POST -H \"Content-Type: application/json\" --data '{\"jsonrpc\":\"2.0\",\"method\":\"state_getMetadata\", \"id\": 1}' localhost:9933 | jq .result | cut -d '\"' -f 2 | xxd -r -p \u003e runtime/metadata.scale\n```\n\nTo build, one of the following mutually-exclusive features must be specified:\n- parachain-metadata-interlay\n- parachain-metadata-kintsugi\n\nThe default command for building the clients, assuming a Kintsugi chain, is:\n```shell\ncargo run --features=parachain-metadata-kintsugi --bin runner -- --parachain-ws 'ws://localhost:9944'   --vault-config-file args.txt\n```\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://web3.foundation/grants/\"\u003e\n    \u003cimg src=\"media/web3_grants.png\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Troubleshooting\n\n**Too many open files**\n\nOn `cargo test` the embedded parachain node in the integration tests can consume a lot of resources. Currently the best workaround is to increase the resource limits of the current user.\n\nUse `ulimit -a` to list the current resource limits. To increase the maximum number of files set `ulimit -n 4096` or some other reasonable limit. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterlay%2Finterbtc-clients","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finterlay%2Finterbtc-clients","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterlay%2Finterbtc-clients/lists"}