yellowstone-shield-parser 0.8.0

Parser for the Yellowstone Shield program
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

# Yellowstone Shield

<p align="center">
  <img src="yellowstone-shield.png" alt="Yellowstone Shield" style="width: 250px;">
</p>

Yellowstone 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.

## Deployments

| Network | Program ID                                    |
| ------- | --------------------------------------------- |
| Mainnet | `b1ockYL7X6sGtJzueDbxRVBEEPN4YeqoLW276R3MX8W` |
| Devnet  | `b1ockYL7X6sGtJzueDbxRVBEEPN4YeqoLW276R3MX8W` |

## Why Use Yellowstone Shield?

- On-chain management allows retrieval and updates via standard Solana RPC methods.
- Supports updates via websocket/gRPC.
- Overcomes limitations of Solana's ALTs and Config programs.

## Solana RPC Integration

Yellowstone Shield integrates with Solana RPC by introducing:

- A new parameter, `forwardingPolicies`, in the `sendTransaction` RPC method, enabling users to specify allow/blocklists.
- An optional `Solana-ForwardingPolicies` HTTP header to support legacy clients.

Transaction senders interpret these policies to determine validator forwarding behavior, ensuring consistent enforcement of allow/blocklists across different RPC providers.

## SDKs and CLI

### SDKs

Clients are available for interacting with Yellowstone Shield:

- [JavaScript SDK](./clients/js)
- [Rust SDK](./clients/rust)

These SDKs facilitate easy integration and use of Yellowstone Shield in various applications and services.

### Command Line Tool (CLI)

A CLI tool is provided for convenient management of Yellowstone Shield policies, available in the `./cli` directory:

- [CLI Documentation](./cli/README.md)

This CLI allows creating policies, adding or removing identites, 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 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.

## Policy Bound to Token Extensions Asset

Policies 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:

- **Name**: Identifier of the policy.
- **Symbol**: Short representation of the policy.
- **URI**: Link to additional policy information.

The policy account uses a Program Derived Address (PDA), derived with the seed:

```
["shield", "policy", {mint_address}]
```

## Development

Install dependencies:

```sh
pnpm install
```

### Build and Test

```sh
pnpm programs:build
pnpm programs:test
pnpm programs:format
pnpm programs:lint
```

### Generate IDLs and Clients

```sh
pnpm generate:idls
pnpm generate:clients
```

### Local Validator Management

```sh
pnpm validator:start
pnpm validator:restart
pnpm validator:stop
```

## License

AGPL-3.0

## Developers

This project is developed by [Triton One](https://triton.one/).