Skip to content

Separate contract upgrade admin role #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Obaara293 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Separate contract upgrade admin role #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 93 additions & 19 deletions contracts/prompt-hash/src/contract.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,43 @@ pub struct PromptHashContract;
impl PromptHashTrait for PromptHashContract {
fn __constructor(
env: Env,
admin: Address,
admin_two: Address,
admin_three: Address,
config_admin: Address,
config_admin_two: Address,
config_admin_three: Address,
upgrade_admin: Address,
upgrade_admin_two: Address,
upgrade_admin_three: Address,
fee_wallet: Address,
xlm_sac: Address,
) -> Result<(), Error> {
ensure(
admin != admin_two && admin != admin_three && admin_two != admin_three,
Error::Unauthorized,
ensure(!Storage::is_initialized(&env), Error::AlreadyInitialized)?;
validate_admin_roles(
&config_admin,
&config_admin_two,
&config_admin_three,
&upgrade_admin,
&upgrade_admin_two,
&upgrade_admin_three,
)?;
ownable::set_owner(&env, &admin);
let admin_signers = Vec::from_array(
ownable::set_owner(&env, &config_admin);
let config_admin_signers = Vec::from_array(
&env,
[
config_admin.clone(),
config_admin_two.clone(),
config_admin_three.clone(),
],
);
let upgrade_admin_signers = Vec::from_array(
&env,
[admin.clone(), admin_two.clone(), admin_three.clone()],
[
upgrade_admin.clone(),
upgrade_admin_two.clone(),
upgrade_admin_three.clone(),
],
);
Storage::set_admin_signers(&env, &admin_signers);
Storage::set_config_admin_signers(&env, &config_admin_signers);
Storage::set_upgrade_admin_signers(&env, &upgrade_admin_signers);
Storage::set_fee_wallet(&env, &fee_wallet);
Storage::set_fee_percentage(&env, &DEFAULT_FEE_BPS);
Storage::set_xlm_address(&env, &xlm_sac);
Expand Down Expand Up @@ -664,9 +685,9 @@ impl PromptHashTrait for PromptHashContract {
approver_a: Address,
approver_b: Address,
) -> Result<(), Error> {
require_admin_multisig(&env, &approver_a, &approver_b)?;
require_config_admin_multisig(&env, &approver_a, &approver_b)?;
Storage::require_no_reentrancy(&env)?;
ensure(new_fee_percentage <= MAX_BPS, Error::InvalidFeePercentage)?;
ensure(new_fee_percentage <= MAX_FEE_BPS, Error::FeeExceedsMaximum)?;
Storage::set_fee_percentage(&env, &new_fee_percentage);
Events::emit_fee_updated(&env, new_fee_percentage);
Ok(())
Expand All @@ -678,7 +699,7 @@ impl PromptHashTrait for PromptHashContract {
approver_a: Address,
approver_b: Address,
) -> Result<(), Error> {
require_admin_multisig(&env, &approver_a, &approver_b)?;
require_config_admin_multisig(&env, &approver_a, &approver_b)?;
Storage::require_no_reentrancy(&env)?;
Storage::set_fee_wallet(&env, &new_fee_wallet);
Events::emit_fee_wallet_updated(&env, new_fee_wallet);
Expand All @@ -703,7 +724,7 @@ impl PromptHashTrait for PromptHashContract {
approver_a: Address,
approver_b: Address,
) -> Result<(), Error> {
require_admin_multisig(&env, &approver_a, &approver_b)?;
require_config_admin_multisig(&env, &approver_a, &approver_b)?;
Storage::require_no_reentrancy(&env)?;
Storage::set_pause_status(&env, paused);
Events::emit_contract_paused_state_changed(&env, paused);
Expand Down Expand Up @@ -808,7 +829,7 @@ impl PromptHashTrait for PromptHashContract {
approver_a: Address,
approver_b: Address,
) -> Result<(), Error> {
require_admin_multisig(&env, &approver_a, &approver_b)?;
require_upgrade_admin_multisig(&env, &approver_a, &approver_b)?;
ensure(!Storage::is_paused(&env), Error::ContractIsPaused)?;
// (1) Reject an invalid implementation: a zero hash is never a deployable
// WASM, and re-proposing the currently-deployed bytecode is a no-op.
Expand All @@ -827,7 +848,7 @@ impl PromptHashTrait for PromptHashContract {
}

fn confirm_upgrade(env: Env, approver_a: Address, approver_b: Address) -> Result<(), Error> {
require_admin_multisig(&env, &approver_a, &approver_b)?;
require_upgrade_admin_multisig(&env, &approver_a, &approver_b)?;
let pending = Storage::get_pending_upgrade(&env).ok_or(Error::UpgradeNotProposed)?;
// (timelock) Enforce the cooldown before executing the upgrade.
let proposed_at =
Expand Down Expand Up @@ -858,7 +879,7 @@ impl PromptHashTrait for PromptHashContract {
}

fn cancel_upgrade(env: Env, approver_a: Address, approver_b: Address) -> Result<(), Error> {
require_admin_multisig(&env, &approver_a, &approver_b)?;
require_upgrade_admin_multisig(&env, &approver_a, &approver_b)?;
let pending = Storage::get_pending_upgrade(&env).ok_or(Error::UpgradeNotProposed)?;
Storage::clear_pending_upgrade(&env);
Storage::clear_upgrade_proposer(&env);
Expand Down Expand Up @@ -2126,21 +2147,74 @@ fn ensure(condition: bool, error: Error) -> Result<(), Error> {
}
}

fn require_admin_multisig(
fn require_config_admin_multisig(
env: &Env,
approver_a: &Address,
approver_b: &Address,
) -> Result<(), Error> {
require_role_multisig(env, approver_a, approver_b, Storage::is_config_admin_signer)
}

fn require_upgrade_admin_multisig(
env: &Env,
approver_a: &Address,
approver_b: &Address,
) -> Result<(), Error> {
require_role_multisig(
env,
approver_a,
approver_b,
Storage::is_upgrade_admin_signer,
)
}

fn require_role_multisig(
env: &Env,
approver_a: &Address,
approver_b: &Address,
is_signer: fn(&Env, &Address) -> bool,
) -> Result<(), Error> {
ensure(approver_a != approver_b, Error::Unauthorized)?;
ensure(
Storage::is_admin_signer(env, approver_a) && Storage::is_admin_signer(env, approver_b),
is_signer(env, approver_a) && is_signer(env, approver_b),
Error::Unauthorized,
)?;
approver_a.require_auth();
approver_b.require_auth();
Ok(())
}

fn validate_admin_roles(
config_admin: &Address,
config_admin_two: &Address,
config_admin_three: &Address,
upgrade_admin: &Address,
upgrade_admin_two: &Address,
upgrade_admin_three: &Address,
) -> Result<(), Error> {
ensure(
config_admin != config_admin_two
&& config_admin != config_admin_three
&& config_admin_two != config_admin_three
&& upgrade_admin != upgrade_admin_two
&& upgrade_admin != upgrade_admin_three
&& upgrade_admin_two != upgrade_admin_three,
Error::Unauthorized,
)?;
ensure(
config_admin != upgrade_admin
&& config_admin != upgrade_admin_two
&& config_admin != upgrade_admin_three
&& config_admin_two != upgrade_admin
&& config_admin_two != upgrade_admin_two
&& config_admin_two != upgrade_admin_three
&& config_admin_three != upgrade_admin
&& config_admin_three != upgrade_admin_two
&& config_admin_three != upgrade_admin_three,
Error::Unauthorized,
)
}

fn validate_classification(env: &Env, classification: &String) -> Result<(), Error> {
for name in ALL_CLASSIFICATIONS {
if classification == &String::from_str(env, name) {
Expand Down
16 changes: 15 additions & 1 deletion contracts/prompt-hash/src/fuzz.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,25 @@ struct FuzzContext {
fn setup(env: &Env) -> FuzzContext {
env.mock_all_auths();
let admin = Address::generate(env);
let admin_two = Address::generate(env);
let admin_three = Address::generate(env);
let upgrade_admin = Address::generate(env);
let upgrade_admin_two = Address::generate(env);
let upgrade_admin_three = Address::generate(env);
let fee_wallet = Address::generate(env);
let xlm = env.register(FungibleTokenContract, (admin.clone(),));
let contract = env.register(
PromptHashContract,
(admin.clone(), fee_wallet.clone(), xlm.clone()),
(
admin.clone(),
admin_two,
admin_three,
upgrade_admin,
upgrade_admin_two,
upgrade_admin_three,
fee_wallet.clone(),
xlm.clone(),
),
);
FuzzContext { contract, xlm }
}
Expand Down
26 changes: 25 additions & 1 deletion contracts/prompt-hash/src/gas_bench.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ struct Context {
admin: Address,
admin_two: Address,
admin_three: Address,
upgrade_admin: Address,
upgrade_admin_two: Address,
upgrade_admin_three: Address,
fee_wallet: Address,
xlm: Address,
contract: Address,
Expand All @@ -49,6 +52,9 @@ fn setup(env: &Env) -> Context {
let admin = Address::generate(env);
let admin_two = Address::generate(env);
let admin_three = Address::generate(env);
let upgrade_admin = Address::generate(env);
let upgrade_admin_two = Address::generate(env);
let upgrade_admin_three = Address::generate(env);
let fee_wallet = Address::generate(env);
let xlm = env.register(FungibleTokenContract, (admin.clone(),));
let contract = env.register(
Expand All @@ -57,6 +63,9 @@ fn setup(env: &Env) -> Context {
admin.clone(),
admin_two.clone(),
admin_three.clone(),
upgrade_admin.clone(),
upgrade_admin_two.clone(),
upgrade_admin_three.clone(),
fee_wallet.clone(),
xlm.clone(),
),
Expand All @@ -65,6 +74,9 @@ fn setup(env: &Env) -> Context {
admin,
admin_two,
admin_three,
upgrade_admin,
upgrade_admin_two,
upgrade_admin_three,
fee_wallet,
xlm,
contract,
Expand Down Expand Up @@ -202,11 +214,23 @@ fn gas_benchmarks_all_contract_operations() {
let admin = Address::generate(&env);
let admin_two = Address::generate(&env);
let admin_three = Address::generate(&env);
let upgrade_admin = Address::generate(&env);
let upgrade_admin_two = Address::generate(&env);
let upgrade_admin_three = Address::generate(&env);
let fee_wallet = Address::generate(&env);
let xlm = env.register(FungibleTokenContract, (admin.clone(),));
let _ = env.register(
PromptHashContract,
(admin, admin_two, admin_three, fee_wallet, xlm),
(
admin,
admin_two,
admin_three,
upgrade_admin,
upgrade_admin_two,
upgrade_admin_three,
fee_wallet,
xlm,
),
);
});

Expand Down
25 changes: 19 additions & 6 deletions contracts/prompt-hash/src/storage.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,34 @@ fn ensure(condition: bool, error: Error) -> Result<(), Error> {
}

impl Storage {
pub fn set_admin_signers(env: &Env, signers: &Vec<Address>) {
pub fn set_config_admin_signers(env: &Env, signers: &Vec<Address>) {
let key = DataKey::AdminSigners;
env.storage().persistent().set(&key, signers);
Self::extend_key_ttl(env, &key);
}

pub fn is_admin_signer(env: &Env, signer: &Address) -> bool {
let key = DataKey::AdminSigners;
pub fn is_config_admin_signer(env: &Env, signer: &Address) -> bool {
Self::is_signer(env, &DataKey::AdminSigners, signer)
}

pub fn set_upgrade_admin_signers(env: &Env, signers: &Vec<Address>) {
let key = DataKey::UpgradeAdminSigners;
env.storage().persistent().set(&key, signers);
Self::extend_key_ttl(env, &key);
}

pub fn is_upgrade_admin_signer(env: &Env, signer: &Address) -> bool {
Self::is_signer(env, &DataKey::UpgradeAdminSigners, signer)
}

fn is_signer(env: &Env, key: &DataKey, signer: &Address) -> bool {
let signers: Vec<Address> = env
.storage()
.persistent()
.get(&key)
.get(key)
.unwrap_or_else(|| Vec::new(env));
if env.storage().persistent().has(&key) {
Self::extend_key_ttl(env, &key);
if env.storage().persistent().has(key) {
Self::extend_key_ttl(env, key);
}
for index in 0..signers.len() {
if signers.get(index).unwrap() == signer.clone() {
Expand Down
Loading