RustSDK - Audit guide

This repository is an integral part of the https://github.com/redstone-finance/redstone-oracles-monorepo repository, especially of the solana-connector package (https://github.com/redstone-finance/redstone-oracles-monorepo/tree/main/packages/solana-connector) and is subject of all their licenses.

• RustSDK - Audit guide
  • Repository
  • Code description
    • Documentation
    • Rust APIs and SDKs code conventions
  • What should be audited
    • Rust files
    • Other files

Repository

• The repository: https://github.com/redstone-finance/rust-sdk
• The CommitId: [will be prepared for the particular version]
• Path: crates/redstone

The direct path should look like: https://github.com/redstone-finance/rust-sdk/tree/[COMMIT_ID]/crates/redstone

Code description

Documentation

• Redstone crate documentation here
  • RedstoneConfig is abstraction required as configuration for the RedStone protocol here.
  • Process Payload function is the main processor of the RedStone payload here.
• General RedStone Blockchain Oracles docs
  • Especially The push model docs

Rust APIs and SDKs code conventions

We try to follow conventions from here.

What should be audited

Rust files

The code-lines in */crates/redstone/src/**/*.rs files should be audited besides files listed below:

• ./crates/redstone/src/core/test_helpers.rs - file should not be audited.
• ./crates/redstone/src/helpers - directory should not be audited.
• all test, imports and comments should not be included for audit.

Other files

• We suggest to read **/README.md
• We suggest to audit Dependencies inside **/Cargo.toml files