sunspot 0.1.3

Proxy server for Solflare Wallet to re-enable custom RPC endpoints
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

# Sunspot Proxy
[![Crates.io](https://img.shields.io/crates/v/sunspot)](https://crates.io/crates/sunspot) 
![Crates.io](https://img.shields.io/crates/l/sunspot) 
![Crates.io](https://img.shields.io/crates/d/sunspot)

Sunspot is a proxy server that enables custom RPC urls and custom token metadata lists for
the [Solflare](https://solflare.com) Solana wallet.

## Installation

```bash
cargo install sunspot
```

## Setting up Local Certificate Authority

### Generating Certificates

#### From repo root

```bash
chmod +x generate-cert.sh
./generate-cert.sh
```

#### From anywhere

```bash
mkdir -p ./certs
openssl genrsa -out ./certs/sunspot.key 2048
openssl req -x509 -new -nodes -key ./certs/sunspot.key -sha256 -days 1825 -out ./certs/sunspot.pem
```

### Adding CA to Chrome

1. Go to <chrome://settings/certificates> in your Chrome browser
2. Go to the `Authorities` tab and then `Import`
3. Select the `sunspot.pem` file from the `certs` directory
4. Select `Trust this certificate for identifying websites` and click `OK`

### Adding CA to Firefox

1. Go to <about:preferences#privacy> in your Firefox browser and scroll down to `Certificates`
2. Click `View Certificates`, go to the `Authorities` tab, and then click `Import`
3. Select the `sunspot.pem` file from the `certs` directory
4. Select `Trust this CA to identify websites.` and click `OK`

## Setting up SwitchyOmega Proxy


1. Install from the [Chrome Web Store](https://chrome.google.com/webstore/detail/padekgcemlokbadohgkifijomclgjgif) or
   [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/switchyomega/)
2. In the SwitchyOmega options, go to Import/Export and click `Restore from file`
3. Select the [`OmegaOptions.bak`](./switchy-omega-proxy/OmegaOptions.bak) file from the `switchy-omega-proxy` directory
4. Click `Apply Changes` and enable the `auto switch` option through the extension icon

## Usage

Using the Testnet RPC option for Solflare is recommended. This will cause Solflare to route transactions through Testnet nodes,
so if an API changes unexpectedly, real transactions won't be routed to Mainnet-Beta. Testnet also disables some features, 
which is what we want since Sunspot can't support everything (yet)! 

```bash
sunspot --help
```

```bash
sunspot -k ./certs/sunspot.key -c ./certs/sunspot.pem http://localhost:8899
```

### Using a Custom Token List File

Sunspot allows you to provide a custom token-list JSON file, which is used to add custom names, symbols, and imageURIs
to tokens in both the wallet view and during simulations.

```json
{
  "<Token Mint String>": {
    "name": "<Token Name>",
    "symbol": "<Token Symbol>",
    "imageUri": "<Token Image URI>"
  },
  // USD Coin Example
  "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v": {
    "name": "USD Coin",
    "symbol": "USDC",
    "imageUri": "https://assets.coingecko.com/coins/images/6319/large/USD_Coin_icon.png?1547042389"
  }
}
```

You can pass this file to Sunspot using the `--token-list` (`-t`) flag.

```bash
sunspot -k ./certs/sunspot.key -c ./certs/sunspot.pem -t ./tokens.json http://localhost:8899
```

## Thanks

Special thanks to the [Hudsucker](https://github.com/omjadas/hudsucker) crate for the MITM HTTP/S proxy implementation