Binary oracle implementation (#1347)

* oracle pair init

* update

* updates

* progress

* update

* update

* progress

* builds

* update

* progress

* update

* copy pasta

* Refactor and add Instruction serializing/deserializing

* Add pack/unpack for Pool struct

* Implement InitPool instruction

* Add unit test and refactor InitPool instruction

* Minor changes

* Add using deposing token mint decimals in pass and fail mints

* Add Deposit instruction processing

* Add test for Deposit instruction

* Add Withdraw instruction processing

* Add test for Withdraw instruction

* Add Decide instruction with test

* Changes in Withdraw instruciton and add time travel to Decide instruction test

* Fix clippy warning

* Fix warning with if operator

* Fix clippy warnings

* Update libs version and minor fixes

* Minor changes

* Add user_transfer_authority to withdraw instruction and other minor changes

* Fix clippy warns

* Change return value after serialization

* Update tokio and solana-program-test libs version

Co-authored-by: Anatoly Yakovenko <[email protected]>

Author: n00m4d

Cargo.lock

@@ -1,6 +1,7 @@
 [workspace]
 members = [
   "associated-token-account/program",
+  "binary-oracle-pair/program",
   "examples/rust/cross-program-invocation",
   "examples/rust/custom-heap",
   "examples/rust/logging",

Cargo.toml

@@ -0,0 +1,12 @@
+Simple Oracle Pair Token
+
+1. pick a deposit token
+2. pick the decider's pubkey
+3. pick the mint term end slot
+4. pick the decide term end slot, must be after 3
+
+Each deposit token can mint one `Pass` and one `Fail` token up to
+the mint term end slot.  After the decide term end slot the `Pass`
+token converts 1:1 with the deposit token if and only if the decider
+had set `pass` before the end of the decide term, otherwise the `Fail`
+token converts 1:1 with the deposit token.

binary-oracle-pair/README.md

@@ -0,0 +1,29 @@
+[package]
+name = "spl-binary-oracle-pair"
+version = "0.1.0"
+description = "Solana Program Library Binary Oracle Pair"
+authors = ["Solana Maintainers <[email protected]>"]
+repository = "https://github.com/solana-labs/solana-program-library"
+license = "Apache-2.0"
+edition = "2018"
+
+[features]
+test-bpf = []
+
+[dependencies]
+num-derive = "0.3"
+num-traits = "0.2"
+solana-program = "1.5.14"
+spl-token = { version = "3.0", path = "../../token/program", features = [ "no-entrypoint" ] }
+thiserror = "1.0"
+uint = "0.8"
+arbitrary = { version = "0.4", features = ["derive"], optional = true }
+borsh = "0.8.2"
+
+[dev-dependencies]
+solana-program-test = "1.6.1"
+solana-sdk = "1.5.14"
+tokio = { version = "1.3.0", features = ["macros"]}
+
+[lib]
+crate-type = ["cdylib", "lib"]

binary-oracle-pair/program/Cargo.toml

@@ -0,0 +1,2 @@
+[target.bpfel-unknown-unknown.dependencies.std]
+features = []

binary-oracle-pair/program/Xargo.toml

@@ -0,0 +1,25 @@
+//! Program entrypoint definitions
+
+#![cfg(all(target_arch = "bpf", not(feature = "no-entrypoint")))]
+
+use crate::{error::PoolError, processor};
+use solana_program::{
+    account_info::AccountInfo, entrypoint, entrypoint::ProgramResult,
+    program_error::PrintProgramError, pubkey::Pubkey,
+};
+
+entrypoint!(process_instruction);
+fn process_instruction(
+    program_id: &Pubkey,
+    accounts: &[AccountInfo],
+    instruction_data: &[u8],
+) -> ProgramResult {
+    if let Err(error) =
+        processor::Processor::process_instruction(program_id, accounts, instruction_data)
+    {
+        // catch the error so we can print it
+        error.print::<PoolError>();
+        return Err(error);
+    }
+    Ok(())
+}

binary-oracle-pair/program/src/entrypoint.rs

@@ -0,0 +1,97 @@
+//! Error types
+
+use num_derive::FromPrimitive;
+use num_traits::FromPrimitive;
+use solana_program::{
+    decode_error::DecodeError, msg, program_error::PrintProgramError, program_error::ProgramError,
+};
+use thiserror::Error;
+
+/// Errors that may be returned by the Binary Oracle Pair program.
+#[derive(Clone, Debug, Eq, Error, FromPrimitive, PartialEq)]
+pub enum PoolError {
+    /// Pool account already in use
+    #[error("Pool account already in use")]
+    AlreadyInUse,
+    /// Deposit account already in use
+    #[error("Deposit account already in use")]
+    DepositAccountInUse,
+    /// Token mint account already in use
+    #[error("Token account already in use")]
+    TokenMintInUse,
+    /// Invalid seed or bump_seed was provided
+    #[error("Failed to generate program account because of invalid data")]
+    InvalidAuthorityData,
+    /// Invalid authority account provided
+    #[error("Invalid authority account provided")]
+    InvalidAuthorityAccount,
+    /// Lamport balance below rent-exempt threshold.
+    #[error("Lamport balance below rent-exempt threshold")]
+    NotRentExempt,
+    /// Expected an SPL Token mint
+    #[error("Input token mint account is not valid")]
+    InvalidTokenMint,
+    /// Amount should be more than zero
+    #[error("Amount should be more than zero")]
+    InvalidAmount,
+    /// Wrong decider account
+    #[error("Wrong decider account was sent")]
+    WrongDeciderAccount,
+    /// Signature missing in transaction
+    #[error("Signature missing in transaction")]
+    SignatureMissing,
+    /// Decision was already made for this pool
+    #[error("Decision was already made for this pool")]
+    DecisionAlreadyMade,
+    /// Decision can't be made in current slot
+    #[error("Decision can't be made in current slot")]
+    InvalidSlotForDecision,
+    /// Deposit can't be made in current slot
+    #[error("Deposit can't be made in current slot")]
+    InvalidSlotForDeposit,
+    /// No decision has been made yet
+    #[error("No decision has been made yet")]
+    NoDecisionMadeYet,
+}
+
+impl From<PoolError> for ProgramError {
+    fn from(e: PoolError) -> Self {
+        ProgramError::Custom(e as u32)
+    }
+}
+
+impl<T> DecodeError<T> for PoolError {
+    fn type_of() -> &'static str {
+        "Binary Oracle Pair Error"
+    }
+}
+
+impl PrintProgramError for PoolError {
+    fn print<E>(&self)
+    where
+        E: 'static + std::error::Error + DecodeError<E> + PrintProgramError + FromPrimitive,
+    {
+        match self {
+            PoolError::AlreadyInUse => msg!("Error: Pool account already in use"),
+            PoolError::DepositAccountInUse => msg!("Error: Deposit account already in use"),
+            PoolError::TokenMintInUse => msg!("Error: Token account already in use"),
+            PoolError::InvalidAuthorityData => {
+                msg!("Error: Failed to generate program account because of invalid data")
+            }
+            PoolError::InvalidAuthorityAccount => msg!("Error: Invalid authority account provided"),
+            PoolError::NotRentExempt => msg!("Error: Lamport balance below rent-exempt threshold"),
+            PoolError::InvalidTokenMint => msg!("Error: Input token mint account is not valid"),
+            PoolError::InvalidAmount => msg!("Error: Amount should be more than zero"),
+            PoolError::WrongDeciderAccount => msg!("Error: Wrong decider account was sent"),
+            PoolError::SignatureMissing => msg!("Error: Signature missing in transaction"),
+            PoolError::DecisionAlreadyMade => {
+                msg!("Error: Decision was already made for this pool")
+            }
+            PoolError::InvalidSlotForDecision => {
+                msg!("Error: Decision can't be made in current slot")
+            }
+            PoolError::InvalidSlotForDeposit => msg!("Deposit can't be made in current slot"),
+            PoolError::NoDecisionMadeYet => msg!("Error: No decision has been made yet"),
+        }
+    }
+}