Add policy store lib for accessing policies in transaction forwarders

Author: kespinola

Cargo.lock

@@ -1,9 +1,17 @@
 
 [workspace]
 resolver = "2"
-members = ["cli", "clients/rust", "program"]
+members = ["cli", "clients/rust", "parser", "program", "store"]
 
 [workspace.dependencies]
 yellowstone-shield-client = { path = "clients/rust" }
 yellowstone-shield = { path = "program" }
+yellowstone-shield-cli = { path = "cli" }
+yellowstone-shield-parser = { path = "parser" }
 anyhow = "1.0.97"
+solana-sdk = "~2.1.11"
+solana-program = "~2.1.11"
+
+[workspace.metadata.patch.crates-io]
+solana-program = { git = "https://github.com/rpcpool/solana-public.git", tag = "v2.1.11-triton-public" }
+solana-sdk = { git = "https://github.com/rpcpool/solana-public.git", tag = "v2.1.11-triton-public" }

Cargo.toml

@@ -19,7 +19,7 @@ Yellowstone Shield is a Solana program designed to manage allowlists and blockli
 - Supports updates via websocket/gRPC.
 - Overcomes limitations of Solana's ALTs and Config programs.
 
-## Integration
+## Solana RPC Integration
 
 Yellowstone Shield integrates with Solana RPC by introducing:
 
@@ -47,6 +47,10 @@ A CLI tool is provided for convenient management of Yellowstone Shield policies,
 
 This CLI allows creating policies, adding or removing validators, and managing configurations directly via terminal commands.
 
+## Rust Policy Store
+
+The Rust Policy Store provides efficient caching and quick retrieval of Yellowstone Shield policies, enabling real-time validator 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.
+
 ## Policy Bound to Token Extensions Asset
 
 Policies are bound to a Token Extensions (TE) asset. Token holders can update validator identities tracked by the policy. The TE asset also contains metadata describing the policy:
@@ -55,91 +59,13 @@ Policies are bound to a Token Extensions (TE) asset. Token holders can update va
 - **Symbol**: Short representation of the policy.
 - **URI**: Link to additional policy information.
 
-### Binding Policy to Token Extensions Asset
-
 The policy account uses a Program Derived Address (PDA), derived with the seed:
 
 ```
 ["shield", "policy", {mint_address}]
 ```
 
-Here, `{mint_address}` is the mint address of the associated Token Extensions asset.
-
----
-
-## Program State
-
-### Policy Account
-
-Each policy account stores:
-
-- `kind`: Always set to `Policy`.
-- `strategy`: Either `Allow` or `Deny`.
-- `validatorIdentities`: Validator public keys.
-
-## Instructions
-
-### CreatePolicy
-
-Creates a policy account.
-
-**Accounts:**
-
-- `mint`: Token mint for policy management.
-- `tokenAccount`: Authority token account.
-- `policy`: Policy account (mutable).
-- `payer`: Fee-paying account (mutable, signer).
-- `systemProgram`: System program.
-- `tokenProgram`: SPL token program.
-
-**Arguments:**
-
-- `strategy`: `Allow` or `Deny`.
-- `validatorIdentities`: Validator public keys.
-
-### AddIdentity
-
-Adds a validator to a policy.
-
-**Accounts:**
-
-- `mint`: Token mint.
-- `tokenAccount`: Authority account.
-- `policy`: Policy account (mutable).
-- `payer`: Fee-paying account (mutable, signer).
-- `systemProgram`: System program.
-
-**Arguments:**
-
-- `validatorIdentity`: Validator public key.
-
-### RemoveIdentity
-
-Removes a validator from a policy.
-
-**Accounts:**
-
-- `mint`: Token mint.
-- `tokenAccount`: Authority account.
-- `policy`: Policy account (mutable).
-- `payer`: Fee-paying account (mutable, signer).
-- `systemProgram`: System program.
-
-**Arguments:**
-
-- `validatorIdentity`: Validator public key.
-
-## Errors
-
-Common errors:
-
-- `DeserializationError`
-- `SerializationError`
-- `InvalidPda`
-- `ValidatorIdentityNotFound`
-- `InvalidAssociatedTokenAccount`
-
-## Development Setup
+## Development
 
 Install dependencies:
 
@@ -177,4 +103,4 @@ AGPL-3.0
 
 ## Developers
 
-This project is developded by [Triton One](https://triton.one/).
+This project is developed by [Triton One](https://triton.one/).

README.md

@@ -1,12 +1,14 @@
 [package]
-name = "cli"
+name = "yellowstone-shield-cli"
 version = "0.1.0"
 edition = "2021"
 
 [dependencies]
 clap = "4.5.32"
 clap_derive = "4.5.32"
-yellowstone-shield-client = { workspace = true }
+yellowstone-shield-client = { workspace = true, features = [
+  "token-extensions",
+] }
 solana-sdk = "2.1.11"
 solana-cli = "2.1.11"
 solana-cli-config = "2.1.11"

cli/Cargo.toml

@@ -1,10 +1,24 @@
 pub mod policy;
 pub mod validator;
 
-use crate::CommandContext;
 use anyhow::Result;
+use solana_client::nonblocking::rpc_client::RpcClient;
+use solana_sdk::pubkey::Pubkey;
+use solana_sdk::signature::Keypair;
+use spl_token_metadata_interface::state::TokenMetadata;
+use yellowstone_shield_client::accounts::Policy;
+
+pub struct CommandContext {
+    pub client: RpcClient,
+    pub keypair: Keypair,
+}
+
+pub struct SolanaAccount<T>(pub Pubkey, pub T);
+pub struct CommandComplete(pub SolanaAccount<TokenMetadata>, pub SolanaAccount<Policy>);
+
+pub type RunResult = Result<CommandComplete>;
 
 #[async_trait::async_trait]
 pub trait RunCommand {
-    async fn run(&self, context: CommandContext) -> Result<()>;
+    async fn run(&self, context: CommandContext) -> RunResult;
 }

cli/src/command/mod.rs

@@ -2,6 +2,8 @@ use anyhow::Result;
 use log::info;
 use solana_sdk::{
     account::WritableAccount,
+    commitment_config::CommitmentConfig,
+    native_token::Sol,
     pubkey::Pubkey,
     signature::{Keypair, Signer},
 };
@@ -22,13 +24,13 @@ use yellowstone_shield_client::{
     TransactionBuilder,
 };
 
-use super::RunCommand;
-use crate::CommandContext;
+use super::{RunCommand, RunResult};
+use crate::command::{CommandComplete, CommandContext, SolanaAccount};
 use borsh::BorshDeserialize;
 
 /// Builder for creating a new policy
 pub struct CreateCommandBuilder<'a> {
-    strategy: Option<&'a PermissionStrategy>,
+    strategy: Option<PermissionStrategy>,
     validator_identities: Option<&'a Vec<Pubkey>>,
     name: Option<String>,
     symbol: Option<String>,
@@ -48,7 +50,7 @@ impl<'a> CreateCommandBuilder<'a> {
     }
 
     /// Set the strategy for the policy
-    pub fn strategy(mut self, strategy: &'a PermissionStrategy) -> Self {
+    pub fn strategy(mut self, strategy: PermissionStrategy) -> Self {
         self.strategy = Some(strategy);
         self
     }
@@ -81,7 +83,7 @@ impl<'a> CreateCommandBuilder<'a> {
 #[async_trait::async_trait]
 impl<'a> RunCommand for CreateCommandBuilder<'a> {
     /// Execute the creation of the policy
-    async fn run(&self, context: CommandContext) -> Result<()> {
+    async fn run(&self, context: CommandContext) -> RunResult {
         let CommandContext { keypair, client } = context;
 
         // Given a PDA derived from the payer's public key.
@@ -150,7 +152,7 @@ impl<'a> RunCommand for CreateCommandBuilder<'a> {
             .payer(keypair.pubkey())
             .token_account(payer_token_account)
             .validator_identities(validator_identities.to_vec())
-            .strategy(yellowstone_shield_client::types::PermissionStrategy::Allow)
+            .strategy(self.strategy.expect("strategy must be set"))
             .instruction();
 
         // Initialize the payer's token account.
@@ -185,7 +187,10 @@ impl<'a> RunCommand for CreateCommandBuilder<'a> {
             .transaction();
 
         client
-            .send_and_confirm_transaction_with_spinner(&tx)
+            .send_and_confirm_transaction_with_spinner_and_commitment(
+                &tx,
+                CommitmentConfig::confirmed(),
+            )
             .await?;
 
         let mut account_data = client.get_account(&address).await?;
@@ -200,26 +205,9 @@ impl<'a> RunCommand for CreateCommandBuilder<'a> {
         let mut mint_bytes = mint_pod.get_extension_bytes::<TokenMetadata>().unwrap();
         let token_metadata = TokenMetadata::try_from_slice(&mut mint_bytes).unwrap();
 
-        info!("🎉 Policy successfully created! 🎉");
-        info!("--------------------------------");
-        info!("🏠 Addresses:");
-        info!("  📜 Policy: {}", address);
-        info!("  🔑 Mint: {}", mint.pubkey());
-        info!("--------------------------------");
-        info!("🔍 Details:");
-        match policy.strategy {
-            PermissionStrategy::Allow => info!("  ✅ Strategy: Allow"),
-            PermissionStrategy::Deny => info!("  ❌ Strategy: Deny"),
-        }
-        info!(
-            "  🛡️ Validator Identities: {:?}",
-            policy.validator_identities
-        );
-        info!("  🏷️ Name: {}", token_metadata.name);
-        info!("  🔖 Symbol: {}", token_metadata.symbol);
-        info!("  🌐 URI: {}", token_metadata.uri);
-        info!("--------------------------------");
-
-        Ok(())
+        Ok(CommandComplete(
+            SolanaAccount(mint.pubkey(), token_metadata),
+            SolanaAccount(address, policy),
+        ))
     }
 }