Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
Reduce budget_program and config_program into boilerplate crates
Browse files Browse the repository at this point in the history
  • Loading branch information
garious committed Mar 21, 2019
1 parent d0761f5 commit 045af04
Show file tree
Hide file tree
Showing 11 changed files with 186 additions and 197 deletions.
14 changes: 4 additions & 10 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions programs/budget_api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ edition = "2018"
[dependencies]
bincode = "1.1.2"
chrono = { version = "0.4.0", features = ["serde"] }
log = "0.4.2"
serde = "1.0.89"
serde_derive = "1.0.89"
solana-sdk = { path = "../../sdk", version = "0.13.0" }

[dev-dependencies]
solana-runtime = { path = "../../runtime", version = "0.13.0" }

[lib]
name = "solana_budget_api"
crate-type = ["lib"]
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
//! budget program
use crate::budget_instruction::BudgetInstruction;
use crate::budget_state::{BudgetError, BudgetState};
use crate::payment_plan::Witness;
use bincode::{deserialize, serialize};
use chrono::prelude::{DateTime, Utc};
use log::*;
use solana_budget_api::budget_instruction::BudgetInstruction;
use solana_budget_api::budget_state::{BudgetError, BudgetState};
use solana_budget_api::payment_plan::Witness;
use solana_sdk::account::KeyedAccount;
use solana_sdk::pubkey::Pubkey;
use solana_sdk::transaction::InstructionError;
Expand Down Expand Up @@ -143,9 +143,9 @@ pub fn process_instruction(
#[cfg(test)]
mod test {
use super::*;
use solana_budget_api::budget_instruction::BudgetInstruction;
use solana_budget_api::budget_script::BudgetScript;
use solana_budget_api::id;
use crate::budget_instruction::BudgetInstruction;
use crate::budget_script::BudgetScript;
use crate::id;
use solana_runtime::bank::Bank;
use solana_runtime::bank_client::BankClient;
use solana_sdk::genesis_block::GenesisBlock;
Expand Down
1 change: 1 addition & 0 deletions programs/budget_api/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
pub mod budget_expr;
pub mod budget_instruction;
pub mod budget_processor;
pub mod budget_script;
pub mod budget_state;
pub mod budget_transaction;
Expand Down
7 changes: 0 additions & 7 deletions programs/budget_program/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,11 @@ homepage = "https://solana.com/"
edition = "2018"

[dependencies]
bincode = "1.1.2"
chrono = { version = "0.4.0", features = ["serde"] }
log = "0.4.2"
serde = "1.0.89"
serde_derive = "1.0.89"
solana-budget-api = { path = "../budget_api", version = "0.13.0" }
solana-logger = { path = "../../logger", version = "0.13.0" }
solana-sdk = { path = "../../sdk", version = "0.13.0" }

[dev-dependencies]
solana-runtime = { path = "../../runtime", version = "0.13.0" }

[lib]
name = "solana_budget_program"
crate-type = ["cdylib"]
Expand Down
4 changes: 1 addition & 3 deletions programs/budget_program/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
mod budget_processor;

use crate::budget_processor::process_instruction;
use solana_budget_api::budget_processor::process_instruction;

solana_sdk::process_instruction_entrypoint!(process_instruction);
4 changes: 4 additions & 0 deletions programs/config_api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,12 @@ bincode = "1.1.2"
log = "0.4.2"
serde = "1.0.89"
serde_derive = "1.0.89"
solana-logger = { path = "../../logger", version = "0.13.0" }
solana-sdk = { path = "../../sdk", version = "0.13.0" }

[dev-dependencies]
solana-runtime = { path = "../../runtime", version = "0.13.0" }

[lib]
name = "solana_config_api"
crate-type = ["lib"]
Expand Down
163 changes: 163 additions & 0 deletions programs/config_api/src/config_processor.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
//! Config program
use log::*;
use solana_sdk::account::KeyedAccount;
use solana_sdk::pubkey::Pubkey;
use solana_sdk::transaction::InstructionError;

pub fn process_instruction(
_program_id: &Pubkey,
keyed_accounts: &mut [KeyedAccount],
data: &[u8],
_tick_height: u64,
) -> Result<(), InstructionError> {
if keyed_accounts[1].signer_key().is_none() {
error!("account[1] should sign the transaction");
Err(InstructionError::MissingRequiredSignature)?;
}

if keyed_accounts[1].account.data.len() < data.len() {
error!("instruction data too large");
Err(InstructionError::InvalidInstructionData)?;
}

keyed_accounts[1].account.data[0..data.len()].copy_from_slice(data);
Ok(())
}

#[cfg(test)]
mod tests {
use super::*;
use crate::{id, ConfigInstruction, ConfigState};
use bincode::{deserialize, serialized_size};
use serde_derive::{Deserialize, Serialize};
use solana_runtime::bank::Bank;
use solana_runtime::bank_client::BankClient;
use solana_sdk::genesis_block::GenesisBlock;
use solana_sdk::script::Script;
use solana_sdk::signature::{Keypair, KeypairUtil};
use solana_sdk::system_instruction::SystemInstruction;

#[derive(Serialize, Deserialize, Default, Debug, PartialEq)]
struct MyConfig {
pub item: u64,
}
impl MyConfig {
pub fn new(item: u64) -> Self {
Self { item }
}
pub fn deserialize(input: &[u8]) -> Option<Self> {
deserialize(input).ok()
}
}

impl ConfigState for MyConfig {
fn max_space() -> u64 {
serialized_size(&Self::default()).unwrap()
}
}

fn create_bank(lamports: u64) -> (Bank, Keypair) {
let (genesis_block, mint_keypair) = GenesisBlock::new(lamports);
let mut bank = Bank::new(&genesis_block);
bank.add_instruction_processor(id(), process_instruction);
(bank, mint_keypair)
}

fn create_config_client(bank: &Bank, mint_keypair: Keypair) -> (BankClient, Pubkey, Pubkey) {
let config_client =
BankClient::new_with_keypairs(&bank, vec![Keypair::new(), Keypair::new()]);

let from_pubkey = config_client.pubkeys()[0];
let config_pubkey = config_client.pubkeys()[1];

let mint_client = BankClient::new(&bank, mint_keypair);
mint_client
.process_instruction(SystemInstruction::new_move(
&mint_client.pubkey(),
&from_pubkey,
42,
))
.expect("new_move");

mint_client
.process_instruction(ConfigInstruction::new_account::<MyConfig>(
&mint_client.pubkey(),
&config_pubkey,
1,
))
.expect("new_account");

(config_client, from_pubkey, config_pubkey)
}

#[test]
fn test_process_create_ok() {
solana_logger::setup();
let (bank, from_keypair) = create_bank(10_000);
let (config_client, _, _) = create_config_client(&bank, from_keypair);
let config_account = bank.get_account(&config_client.pubkeys()[1]).unwrap();
assert_eq!(id(), config_account.owner);
assert_eq!(
MyConfig::default(),
MyConfig::deserialize(&config_account.data).unwrap()
);
}

#[test]
fn test_process_store_ok() {
solana_logger::setup();
let (bank, mint_keypair) = create_bank(10_000);
let (config_client, from_pubkey, config_pubkey) = create_config_client(&bank, mint_keypair);

let my_config = MyConfig::new(42);
let instruction = ConfigInstruction::new_store(&from_pubkey, &config_pubkey, &my_config);
config_client.process_instruction(instruction).unwrap();

let config_account = bank.get_account(&config_pubkey).unwrap();
assert_eq!(
my_config,
MyConfig::deserialize(&config_account.data).unwrap()
);
}

#[test]
fn test_process_store_fail_instruction_data_too_large() {
solana_logger::setup();
let (bank, mint_keypair) = create_bank(10_000);
let (config_client, from_pubkey, config_pubkey) = create_config_client(&bank, mint_keypair);

let my_config = MyConfig::new(42);
let instruction = ConfigInstruction::new_store(&from_pubkey, &config_pubkey, &my_config);

// Replace instruction data with a vector that's too large
let script = Script::new(vec![instruction]);
let mut transaction = script.compile();
transaction.instructions[0].data = vec![0; 123];
config_client.process_transaction(transaction).unwrap_err();
}

#[test]
fn test_process_store_fail_account1_not_signer() {
solana_logger::setup();
let (bank, mint_keypair) = create_bank(10_000);
let system_keypair = Keypair::new();
let system_pubkey = system_keypair.pubkey();
bank.transfer(42, &mint_keypair, &system_pubkey, bank.last_blockhash())
.unwrap();
let (_config_client, from_pubkey, config_pubkey) =
create_config_client(&bank, mint_keypair);

let move_instruction = SystemInstruction::new_move(&system_pubkey, &Pubkey::default(), 42);
let my_config = MyConfig::new(42);
let store_instruction =
ConfigInstruction::new_store(&from_pubkey, &config_pubkey, &my_config);

// Don't sign the transaction with `config_client`
let script = Script::new(vec![move_instruction, store_instruction]);
let mut transaction = script.compile();
transaction.sign_unchecked(&[&system_keypair], bank.last_blockhash());
let system_client = BankClient::new(&bank, system_keypair);
system_client.process_transaction(transaction).unwrap_err();
}
}
1 change: 1 addition & 0 deletions programs/config_api/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use serde::Serialize;
use solana_sdk::pubkey::Pubkey;

mod config_instruction;
pub mod config_processor;

pub use config_instruction::ConfigInstruction;

Expand Down
10 changes: 1 addition & 9 deletions programs/config_program/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,9 @@ edition = "2018"

[dependencies]
log = "0.4.2"
solana-logger = { path = "../../logger", version = "0.13.0" }
solana-metrics = { path = "../../metrics", version = "0.13.0" }
solana-sdk = { path = "../../sdk", version = "0.13.0" }
solana-config-api = { path = "../config_api", version = "0.13.0" }

[dev-dependencies]
bincode = "1.1.2"
serde = "1.0.89"
serde_derive = "1.0.89"
solana-logger = { path = "../../logger", version = "0.13.0" }
solana-runtime = { path = "../../runtime", version = "0.13.0" }
solana-sdk = { path = "../../sdk", version = "0.13.0" }

[lib]
name = "solana_config_program"
Expand Down
Loading

0 comments on commit 045af04

Please sign in to comment.