Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/demox-labs/solrand


https://github.com/demox-labs/solrand

Last synced: 8 days ago
JSON representation

Awesome Lists containing this project

README 

        
# solrand



An Random Oracle on Solana based on the Demox Protocol. 

The random numbers are provided by Random.org.



This repository implements the Solana program and provides some utilities to make interacting with it easier.



This repository creates the:

* solrand crate (Rust): https://crates.io/crates/solrand

* solrand package on npm (JS): https://www.npmjs.com/package/@demox_labs/solrand



# Installation



1. Ensure that Anchor and all of its dependencies are installed: https://project-serum.github.io/anchor/getting-started/introduction.html

1. `yarn install`

1. Rename the `Anchor.example.toml` to `Anchor.toml` and update the `wallet =` to your solana key.

1. Start the `solana-test-validator`

1. Run `anchor build && anchor deploy`

1. Use the Program Id found from the deploy. Replace `8nzxsNf74ZHDguHi51SjQWxDxegL2DBgxeGHA2pQVtTJ` with your new Program Id.

1. Run the tests: `anchor test`



## Install the crate:

Add `solrand = { version = "0.1.5", features = ["cpi"] }` to your Cargo.toml



## Install the js client library:

`npm i @demox-labs/solrand --save`



# Usage



## For CPI Calls



If you're writing a Solana program to interact with this one, we recommend copying the program accounts to your local `solana-test-validator` using: `solana-test-validator --clone 8nzxsNf74ZHDguHi51SjQWxDxegL2DBgxeGHA2pQVtTJ K2z1qkxZdsw6WpFd63hqhqx9MYUc5c85NdbXULNeGhW --url d`

* Note in order for the `--clone` to work, make sure the `solana-test-validator` is starting from a clean installation.

* You can make sure the program accounts are there by running: `curl http://localhost:8899 -X POST -H "Content-Type: application/json" -d '

  {"jsonrpc":"2.0", "id":1, "method":"getAccountInfo", "params": ["8nzxsNf74ZHDguHi51SjQWxDxegL2DBgxeGHA2pQVtTJ"]}'`



Now you can run your program using for example:

* `anchor build && anchor deploy && node my-script.js`

* `anchor test --skip-test-validator`



## Client



The tests, `tests/solrand.ts`, provide examples in how to use our client library.



# Security Considerations



1. This code has not been audited by a third party. If you find issues please submit them. We plan get an audit as soon as we can.

2. The random numbers for the Oracle are provided by Random.org. Outages are certainly possible as with any Oracle so we plan to add multiple random sources in the future. Error handling for hanging responses should be a consideration.

3. The Demox Protocol is in its beginning stages and at this point, still requires trust in Demox Labs as a third party. With the launch of our dVPN, no third party need be trusted but for this, it requires trusting that we're not fabricating packet captures and tls sessions. We will publish logs of our Random.Org account as to show usage consistent with that publicly available onchain.



# Troubleshooting



## Problems with Anchor

* The most common problem with anchor is using the right version of node. I recommend install Node through NVM and using `Node v16.11.1`. 

* Anchor may and has introduced breaking changes. The current version is 0.22.0. I recommend installing Anchor Version Manager (AVM) to compile with different versions of Anchor. `cargo install --git https://github.com/project-serum/anchor avm --locked --force`



# License



We use the `GNU Affero General Public License v3.0 or later` license to ensure the community will always have access to all original and derivations of this program.

Full text here: https://spdx.org/licenses/AGPL-3.0-or-later.html