redstone-near-connector-rs

RUST library for integrating RedStone Oracles with NEAR Smart Contracts and dApps.

🔮 RedStone Oracles

RedStone is a data ecosystem that delivers frequently updated, reliable and diverse data on-chain.

To learn more about RedStone oracles use the following links:

• RedStone documentation
• Supported Price Feeds (1000+)
• Data from custom URLs
• NFT Data Feeds
• Verifiable entropy

🚀 Getting started

1. Adjust your NEAR smart contracts

Installation

Add redstone-near-connector-rs dependency to your Cargo.toml file in your smart contract crate

Usage

Now you can use the get_oracle_value function in your smart contract code in the following way:

```rust use nearsdk::{log, nearbindgen}; use redstonenearconnectorrs::{getoraclevalue, decodehex};

[near_bindgen]

pub struct YourContract { ... }

[near_bindgen]

impl YourContract { ...

pub fn yourcontractmethod(&mut self, redstonepayloadstr: String) { ...

// 32 bytes identifier of the data feed
let data_feed_id: [u8; 32] = decode_hex("4254430000000000000000000000000000000000000000000000000000000000");

// Required min number of unique signers for the requested data feed
let unique_signers_threshold = 2;

// Vector, containing public keys of trusted signers
// Trusted public keys can be found here: https://github.com/redstone-finance/redstone-oracles-monorepo/blob/main/packages/oracles-smartweave-contracts/src/contracts/redstone-oracle-registry/initial-state.json
let authorised_signers: Vec<[u8; 64]> =
  vec![get_pub_key(SIGNER_1_PUB_KEY), get_pub_key(SIGNER_2_PUB_KEY)];

let current_timestamp_milliseconds = env::block_timestamp() / 1_000_000;

// Signer oracle data, efficiently serialized to bytes
let redstone_payload = decode_hex(&redstone_payload_str).unwrap();

// `get_oracle_value` function will:
// - parse redstone payload,
// - go through each signed data package,
// - verify each signature,
// - count unique signers for the requested data feed,
// - after passing all checks, return the aggregated median value
let oracle_value = get_oracle_value(
  &data_feed_id,
  unique_signers_threshold,
  &authorised_signers,
  current_timestamp_milliseconds,
  &redstone_payload,
);

...

} }

```

2. Adjust your frontend code

You probably noticed, that in the first step your smart contract function requires an additional String argument (redstone_payload). You can get it in your front-end or your tests code using redstone-sdk.

Installation

Firstly, install it in your frontgend JS or TS project

```sh

Using NPM

npm install redstone-sdk

Or using yarn

yarn add redstone-sdk ```

Usage

Then you can request the redstone payload in the following way:

```js import redstoneSDK from "redstone-sdk";

const redstoneDataGateways = [ "https://cache-service-direct-1.b.redstone.finance", "https://d33trozg86ya9x.cloudfront.net", ];

const redstonePayloadHex = await redstoneSDK.requestRedstonePayload( { dataServiceId: "redstone-main-demo", uniqueSignersCount: 2, dataFeeds: ["BTC"], }, redstoneDataGateways );

// Then you can pass the redstonePayloadHex as an argument to the smart contract call, e.g. const outcome = await wallet.signAndSendTransaction({ ... actions: [ { type: "FunctionCall", params: { methodName: "yourcontractmethod", args: { redstone_payload: redstonePayloadHex, }, ... }, }, ], }); ```

🔥 Examples

You can check out a simple example NEAR dApp powered by RedStone oracles here.

👩🏻‍💻 Development and contributions

Code structure

The main logic is located in the src/lib.rs file. Tests are located in the tests folder.

To run tests with output printing

cargo test -- --nocapture

🙋‍♂️ Contact

Please feel free to contact RedStone team on Discord or send email to core@redstone.finance

📜 License

MIT