{"id":28070050,"url":"https://github.com/rpcpool/yellowstone-shield","last_synced_at":"2025-05-12T19:35:59.813Z","repository":{"id":264279253,"uuid":"858671321","full_name":"rpcpool/yellowstone-shield","owner":"rpcpool","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-24T18:01:01.000Z","size":2032,"stargazers_count":13,"open_issues_count":2,"forks_count":1,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-24T19:22:00.855Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rpcpool.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}},"created_at":"2024-09-17T10:28:51.000Z","updated_at":"2025-04-24T18:01:05.000Z","dependencies_parsed_at":"2025-04-24T19:21:14.838Z","dependency_job_id":"ad72d8c4-f356-41b7-be65-789c28b19f05","html_url":"https://github.com/rpcpool/yellowstone-shield","commit_stats":null,"previous_names":["rpcpool/solana-yellowstone-blocklist","rpcpool/yellowstone-shield"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpcpool%2Fyellowstone-shield","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpcpool%2Fyellowstone-shield/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpcpool%2Fyellowstone-shield/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpcpool%2Fyellowstone-shield/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rpcpool","download_url":"https://codeload.github.com/rpcpool/yellowstone-shield/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253808714,"owners_count":21967586,"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":"2025-05-12T19:35:59.225Z","updated_at":"2025-05-12T19:35:59.798Z","avatar_url":"https://github.com/rpcpool.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yellowstone Shield\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"yellowstone-shield.png\" alt=\"Yellowstone Shield\" style=\"width: 250px;\"\u003e\n\u003c/p\u003e\n\nYellowstone Shield is a Solana program that manages on-chain allowlists and blocklists of identities. An identity can be any addressable account in Solana, such as a validator, wallet, or program. This program allows transaction senders, like Agave STS, Helius' Atlas, Mango's lite-rpc, Jito's blockEngine, and Triton's Jet, to effectively control transaction forwarding policies.\n\n## Deployments\n\n| Network | Program ID                                    |\n| ------- | --------------------------------------------- |\n| Mainnet | `b1ockYL7X6sGtJzueDbxRVBEEPN4YeqoLW276R3MX8W` |\n| Devnet  | `b1ockYL7X6sGtJzueDbxRVBEEPN4YeqoLW276R3MX8W` |\n\n## Why Use Yellowstone Shield?\n\n- On-chain management allows retrieval and updates via standard Solana RPC methods.\n- Supports updates via websocket/gRPC.\n- Overcomes limitations of Solana's ALTs and Config programs.\n\n## Solana RPC Integration\n\nYellowstone Shield integrates with Solana RPC by introducing:\n\n- A new parameter, `forwardingPolicy`, in the `sendTransaction` RPC method, enabling users to specify allow/blocklists.\n- An optional `Solana-ForwardingPolicy` HTTP header to support legacy clients.\n\nTransaction senders interpret these policies to determine validator forwarding behavior, ensuring consistent enforcement of allow/blocklists across different RPC providers.\n\n## SDKs and CLI\n\n### SDKs\n\nClients are available for interacting with Yellowstone Shield:\n\n- [JavaScript SDK](./clients/js)\n- [Rust SDK](./clients/rust)\n\nThese SDKs facilitate easy integration and use of Yellowstone Shield in various applications and services.\n\n### Command Line Tool (CLI)\n\nA CLI tool is provided for convenient management of Yellowstone Shield policies, available in the `./cli` directory:\n\n- [CLI Documentation](./cli/README.md)\n\nThis CLI allows creating policies, adding or removing identites, and managing configurations directly via terminal commands.\n\n## Rust Policy Store\n\nThe Rust Policy Store provides efficient caching and quick retrieval of Yellowstone Shield policies, enabling real-time identity permission checks in transaction forwarders and RPC services. It ensures thread-safe access and updates with atomic snapshots. See the [Policy Store README](./policy-store/README.md) for detailed integration and usage instructions.\n\n## Policy Bound to Token Extensions Asset\n\nPolicies are bound to a Token Extensions (TE) asset. Token holders can update identities tracked by the policy. The TE asset also contains metadata describing the policy:\n\n- **Name**: Identifier of the policy.\n- **Symbol**: Short representation of the policy.\n- **URI**: Link to additional policy information.\n\nThe policy account uses a Program Derived Address (PDA), derived with the seed:\n\n```\n[\"shield\", \"policy\", {mint_address}]\n```\n\n## Development\n\nInstall dependencies:\n\n```sh\npnpm install\n```\n\n### Build and Test\n\n```sh\npnpm programs:build\npnpm programs:test\npnpm programs:format\npnpm programs:lint\n```\n\n### Generate IDLs and Clients\n\n```sh\npnpm generate:idls\npnpm generate:clients\n```\n\n### Local Validator Management\n\n```sh\npnpm validator:start\npnpm validator:restart\npnpm validator:stop\n```\n\n## License\n\nAGPL-3.0\n\n## Developers\n\nThis project is developed by [Triton One](https://triton.one/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpcpool%2Fyellowstone-shield","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frpcpool%2Fyellowstone-shield","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpcpool%2Fyellowstone-shield/lists"}