https://github.com/mfactory-lab/ic-solana
(WIP) Interact with Solana from the Internet Computer.
https://github.com/mfactory-lab/ic-solana
cross-chain dfinity icp integration internet-computer rpc solana wallet web3
Last synced: 3 months ago
JSON representation
(WIP) Interact with Solana from the Internet Computer.
- Host: GitHub
- URL: https://github.com/mfactory-lab/ic-solana
- Owner: mfactory-lab
- License: apache-2.0
- Created: 2023-11-21T12:18:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-20T14:30:51.000Z (11 months ago)
- Last Synced: 2024-11-20T14:39:53.793Z (11 months ago)
- Topics: cross-chain, dfinity, icp, integration, internet-computer, rpc, solana, wallet, web3
- Language: Rust
- Homepage:
- Size: 13.3 MB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-internet-computer - Solana RPC Canister - Interact with Solana blockchain from the Internet Computer. (Chain Fusion / Solana)
README
# IC-Solana Gateway
[](https://internetcomputer.org)
[](LICENSE)
[](./.github/workflows/ci.yml)
> #### Interact with [Solana](https://solana.com) from the [Internet Computer](https://internetcomputer.org/).
> [!Warning]
> This repo (`mfactory-lab/ic-solana`) is **deprecated**.
> All users should migrate to the actively maintained replacement:
> [`dfinity/sol-rpc-canister`](https://github.com/dfinity/sol-rpc-canister)
## Overview
**IC-Solana** is a solution that connects the [Internet Computer](https://internetcomputer.org/) with [Solana](https://solana.com/). It allows developers to build decentralized applications (dApps) on the Internet Computer with functionality comparable to traditional Solana dApps. This integration combines the capabilities of both blockchain networks, making it easier to develop cross-chain applications and expand the possibilities for decentralized solutions.
## Quick start
Add the following configuration to your `dfx.json` file (replace the `ic` principal with any option from the list of available canisters):
```json
{
"canisters": {
"solana_rpc": {
"type": "custom",
"candid": "https://github.com/mfactory-lab/ic-solana/blob/main/src/ic-solana-rpc/ic-solana-rpc.did",
"wasm": "https://github.com/mfactory-lab/ic-solana/blob/main/ic-solana-rpc.wasm.gz",
"init_arg": "(record {})"
},
"solana_wallet": {
"type": "custom",
"candid": "https://github.com/mfactory-lab/ic-solana/blob/main/src/ic-solana-wallet/ic-solana-wallet.did",
"wasm": "https://github.com/mfactory-lab/ic-solana/blob/main/ic-solana-wallet.wasm.gz",
"init_arg": "(record {})"
}
}
}
```
## Running the project locally
### Requirements
Make sure you have the following installed:
- [Rust](https://www.rust-lang.org/learn/get-started)
- [Docker](https://www.docker.com/get-started/) (optional for [reproducible builds](#reproducible-builds))
- [PocketIC](https://github.com/dfinity/pocketic) (optional for testing)
- [DFINITY SDK](https://sdk.dfinity.org/docs/quickstart/local-quickstart.html)
### Building the code
Start a local replica listening on port 4943:
```bash
# Start a local replica
dfx start --clean --host 127.0.0.1:4943
```
Build and deploy canisters:
```bash
# Deploy the `solana_rpc` canister locally
dfx deploy solana_rpc --argument '(record {})'
# Deploy the `solana_wallet` canister locally
dfx deploy solana_wallet --argument "(record { sol_canister = opt principal \"`dfx canister id solana_rpc`\"; schnorr_key = null })"
```
All the canisters will be deployed to the local network with their fixed canister IDs.
Once the build and deployment are complete, your application will be accessible at:
```
http://localhost:4943?canisterId={asset_canister_id}
```
Replace `{asset_canister_id}` with the actual canister's ID generated during deployment.
## Examples
Use the Solana mainnet cluster:
```bash
dfx canister call solana_rpc sol_getHealth '(variant{Mainnet},null)' --wallet $(dfx identity get-wallet)
```
Use the Solana devnet cluster:
```bash
dfx canister call solana_rpc sol_getHealth '(variant{Devnet},null)' --wallet $(dfx identity get-wallet)
```
Use a single custom RPC:
```bash
dfx canister call solana_rpc sol_getHealth '(variant{Custom=vec{record{network="https://mainnet.helius-rpc.com/"}}},null)' --wallet $(dfx identity get-wallet)
```
Use multiple custom RPCs:
```bash
dfx canister call solana_rpc sol_getHealth '(variant{Custom=vec{record{network="mainnet"},record{network="https://mainnet.helius-rpc.com/"}}},null)' --wallet $(dfx identity get-wallet)
```
Use a single RPC provider (predefined providers: mainnet|m, devnet|d, testnet|t):
```bash
dfx canister call solana_rpc sol_getHealth '(variant{Provider=vec{"mainnet"}},null)' --wallet $(dfx identity get-wallet)
```
## Components
### [RPC Canister](./src/ic-solana-rpc)
The **RPC Canister** enables communication with the Solana blockchain, using [HTTPS outcalls](https://internetcomputer.org/https-outcalls) to transmit raw transactions and messages via on-chain APIs of [Solana JSON RPC](https://solana.com/docs/rpc) providers, for example, [Helius](https://www.helius.dev/) or [Quicknode](https://www.quicknode.com/).
Key functionalities include:
1. Retrieving Solana-specific data, such as block details, account information, node statistics, etc.
2. Managing Solana RPC providers, including registration, updates, and provider configurations.
3. Calculating and managing the cost of RPC requests.
[//]: # (The RPC Canister runs on the 34-node [fiduciary subnet](https://internetcomputer.org/docs/current/references/subnets/subnet-types#fiduciary-subnets))
[//]: # (with the following principal: [bd3sg-teaaa-aaaaa-qaaba-cai](https://dashboard.internetcomputer.org/canister/bd3sg-teaaa-aaaaa-qaaba-cai).)
### [Wallet Canister](./src/ic-solana-wallet)
The **Wallet Canister** is used for managing addresses and for securely signing transactions/messages for the Solana blockchain using the [threshold Schnorr API](https://internetcomputer.org/docs/current/developer-docs/smart-contracts/signatures/signing-messages-t-schnorr).
Key functionalities include:
1. Generating a Solana public key (Ed25519) for a user on the Internet Computer (ICP).
2. Signing messages using distributed keys based on the `Threshold Schnorr` protocol.
3. Signing and sending raw transactions to the Solana blockchain via the [RPC Canister](#rpc-canister).
### [IC-Solana](./src/ic-solana)
A Rust library that provides the necessary tools for integrating Solana with ICP canisters.
## Access control
IC-Solana stores a list of registered Solana JSON RPC providers, to which transactions and messages can be submitted. Access to the list is controlled by admin(s) who can assign managers with specific rights to add, remove, and update Solana JSON RPC providers.
## Reproducible builds
IC-Solana supports [reproducible builds](https://internetcomputer.org/docs/current/developer-docs/smart-contracts/test/reproducible-builds):
1. Ensure [Docker](https://www.docker.com/get-started/) is installed on your machine.
2. Run `./scripts/docker-build --rpc` in your terminal.
3. Run `sha256sum ic-solana-rpc.wasm.gz` on the generated file to view the SHA-256 hash.
Compare the generated SHA-256 hash with the hash provided in the repository to verify the build's integrity.
## Learn more
- [Candid Interface](https://github.com/mfactory-lab/ic-solana/blob/main/src/ic-solana-rpc/ic-solana-rpc.did)
- [Solana JSON RPC API](https://solana.com/docs/rpc)
- [Internet Computer Developer Docs](https://internetcomputer.org/docs/current/developer-docs/)
- [DFINITY SDK Documentation](https://sdk.dfinity.org/docs/)
- [Internet Computer HTTPS Outcalls](https://internetcomputer.org/https-outcalls)
## Contributing
Contributions are welcome! Please check out the [contributor guidelines](https://github.com/mfactory-lab/ic-solana/blob/main/.github/CONTRIBUTING.md) for more information.
## License
This project is licensed under the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0).