Skip to content

Commit

Permalink
Adds missing ability to query for completed proposals and view the cr…
Browse files Browse the repository at this point in the history 
…eated proposal ID when approved.
  • Loading branch information
@NoahSaso
NoahSaso committed Nov 15, 2023
1 parent db42d45 commit a7827b1
Show file tree
Hide file tree
Showing 5 changed files with 340 additions and 8 deletions.
111 changes: 111 additions & 0 deletions ...s/pre-propose/dao-pre-propose-approval-single/schema/dao-pre-propose-approval-single.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1500,6 +1500,30 @@
},
"additionalProperties": false
},
{
"description": "Return whether or not the proposal is pending",
"type": "object",
"required": [
"is_pending"
],
"properties": {
"is_pending": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"description": "A pending proposal",
"type": "object",
Expand Down Expand Up @@ -1586,6 +1610,93 @@
}
},
"additionalProperties": false
},
{
"description": "A completed proposal",
"type": "object",
"required": [
"completed_proposal"
],
"properties": {
"completed_proposal": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"description": "List of completed proposals",
"type": "object",
"required": [
"completed_proposals"
],
"properties": {
"completed_proposals": {
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0.0
},
"start_after": {
"type": [
"integer",
"null"
],
"format": "uint64",
"minimum": 0.0
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"reverse_completed_proposals"
],
"properties": {
"reverse_completed_proposals": {
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0.0
},
"start_before": {
"type": [
"integer",
"null"
],
"format": "uint64",
"minimum": 0.0
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}
Expand Down
69 changes: 65 additions & 4 deletions contracts/pre-propose/dao-pre-propose-approval-single/src/contract.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ use crate::msg::{
ApproverProposeMessage, ExecuteExt, ExecuteMsg, InstantiateExt, InstantiateMsg, ProposeMessage,
ProposeMessageInternal, QueryExt, QueryMsg,
};
use crate::state::{advance_approval_id, PendingProposal, APPROVER, PENDING_PROPOSALS};
use crate::state::{
advance_approval_id, CompletedProposal, CompletedProposalStatus, PendingProposal, APPROVER,
COMPLETED_PROPOSALS, PENDING_PROPOSALS,
};

pub(crate) const CONTRACT_NAME: &str = "crates.io:dao-pre-propose-approval-single";
pub(crate) const CONTRACT_VERSION: &str = env!("CARGO_PKG_VERSION");
Expand Down Expand Up @@ -164,14 +167,28 @@ pub fn execute_approve(
PrePropose::default().deposits.save(
deps.storage,
proposal_id,
&(proposal.deposit, proposal.proposer),
&(proposal.deposit.clone(), proposal.proposer.clone()),
)?;

let propose_messsage = WasmMsg::Execute {
contract_addr: proposal_module.into_string(),
msg: to_binary(&ProposeMessageInternal::Propose(proposal.msg))?,
msg: to_binary(&ProposeMessageInternal::Propose(proposal.msg.clone()))?,
funds: vec![],
};

COMPLETED_PROPOSALS.save(
deps.storage,
id,
&CompletedProposal {
status: CompletedProposalStatus::Approved {
created_proposal_id: proposal_id,
},
approval_id: proposal.approval_id,
proposer: proposal.proposer,
msg: proposal.msg,
deposit: proposal.deposit,
},
)?;
PENDING_PROPOSALS.remove(deps.storage, id);

Ok(Response::default()
Expand All @@ -196,11 +213,25 @@ pub fn execute_reject(
}

let PendingProposal {
deposit, proposer, ..
approval_id,
proposer,
msg,
deposit,
} = PENDING_PROPOSALS
.may_load(deps.storage, id)?
.ok_or(PreProposeError::ProposalNotFound {})?;

COMPLETED_PROPOSALS.save(
deps.storage,
id,
&CompletedProposal {
status: CompletedProposalStatus::Rejected {},
approval_id,
proposer: proposer.clone(),
msg: msg.clone(),
deposit: deposit.clone(),
},
)?;
PENDING_PROPOSALS.remove(deps.storage, id);

let messages = if let Some(ref deposit_info) = deposit {
Expand Down Expand Up @@ -297,6 +328,16 @@ pub fn query(deps: Deps, env: Env, msg: QueryMsg) -> StdResult<Binary> {
match msg {
QueryMsg::QueryExtension { msg } => match msg {
QueryExt::Approver {} => to_binary(&APPROVER.load(deps.storage)?),
QueryExt::IsPending { id } => {
let pending = PENDING_PROPOSALS.may_load(deps.storage, id)?.is_some();
// Force load completed proposal if not pending, throwing error
// if not found.
if !pending {
COMPLETED_PROPOSALS.load(deps.storage, id)?;
}

to_binary(&pending)
}
QueryExt::PendingProposal { id } => {
to_binary(&PENDING_PROPOSALS.load(deps.storage, id)?)
}
Expand All @@ -317,6 +358,26 @@ pub fn query(deps: Deps, env: Env, msg: QueryMsg) -> StdResult<Binary> {
limit,
Order::Ascending,
)?),
QueryExt::CompletedProposal { id } => {
to_binary(&COMPLETED_PROPOSALS.load(deps.storage, id)?)
}
QueryExt::CompletedProposals { start_after, limit } => to_binary(&paginate_map_values(
deps,
&COMPLETED_PROPOSALS,
start_after,
limit,
Order::Descending,
)?),
QueryExt::ReverseCompletedProposals {
start_before,
limit,
} => to_binary(&paginate_map_values(
deps,
&COMPLETED_PROPOSALS,
start_before,
limit,
Order::Ascending,
)?),
},
_ => PrePropose::default().query(deps, env, msg),
}
Expand Down
17 changes: 17 additions & 0 deletions contracts/pre-propose/dao-pre-propose-approval-single/src/msg.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ pub enum QueryExt {
/// List the approver address
#[returns(cosmwasm_std::Addr)]
Approver {},
/// Return whether or not the proposal is pending
#[returns(bool)]
IsPending { id: u64 },
/// A pending proposal
#[returns(crate::state::PendingProposal)]
PendingProposal { id: u64 },
Expand All @@ -58,6 +61,20 @@ pub enum QueryExt {
start_before: Option<u64>,
limit: Option<u32>,
},
/// A completed proposal
#[returns(crate::state::CompletedProposal)]
CompletedProposal { id: u64 },
/// List of completed proposals
#[returns(Vec<crate::state::CompletedProposal>)]
CompletedProposals {
start_after: Option<u64>,
limit: Option<u32>,
},
#[returns(Vec<crate::state::CompletedProposal>)]
ReverseCompletedProposals {
start_before: Option<u64>,
limit: Option<u32>,
},
}

pub type InstantiateMsg = InstantiateBase<InstantiateExt>;
Expand Down
28 changes: 28 additions & 0 deletions contracts/pre-propose/dao-pre-propose-approval-single/src/state.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,36 @@ pub struct PendingProposal {
pub deposit: Option<CheckedDepositInfo>,
}

#[cw_serde]
pub enum CompletedProposalStatus {
/// The proposal has been approved.
Approved {
/// The created proposal ID.
created_proposal_id: u64,
},
/// The proposal has been rejected.
Rejected {},
}

#[cw_serde]
pub struct CompletedProposal {
/// The status of a completed proposal.
pub status: CompletedProposalStatus,
/// The approval ID used to identify this pending proposal.
pub approval_id: u64,
/// The address that created the proposal.
pub proposer: Addr,
/// The propose message that ought to be executed on the proposal
/// message if this proposal is approved.
pub msg: ProposeMsg,
/// Snapshot of the deposit info at the time of proposal
/// submission.
pub deposit: Option<CheckedDepositInfo>,
}

pub const APPROVER: Item<Addr> = Item::new("approver");
pub const PENDING_PROPOSALS: Map<u64, PendingProposal> = Map::new("pending_proposals");
pub const COMPLETED_PROPOSALS: Map<u64, CompletedProposal> = Map::new("completed_proposals");

/// Used internally to track the current approval_id.
const CURRENT_ID: Item<u64> = Item::new("current_id");
Expand Down
Loading

0 comments on commit a7827b1

Please sign in to comment.