Struct dao::bid_escrow::contract::BidEscrowContractRef

pub struct BidEscrowContractRef { /* private fields */ }

Reference to the BidEscrowContract contract instance.

Implementations

impl BidEscrowContractRef

pub fn at(address: &Address) -> Self

pub fn address(&self) -> &Address

pub fn with_tokens<T>(&self, amount: T) -> Self

where T: Into<Balance>,

impl BidEscrowContractRef

pub fn get_cspr_balance(&self) -> Balance

Returns the CSPR balance of the contract.

pub fn slash_voter(&mut self, voter: Address) -> SlashedVotings

Erases the VA from the all bids, offers and jobs. Only a whitelisted account is permitted to call this method. Interacts with Reputation Token Contract.

Errors

• crate::utils::Error::BidNotFound
• crate::utils::Error::JobOfferNotFound
• crate::utils::Error::CannotCancelBidOnCompletedJobOffer
• crate::utils::Error::NotWhitelisted

Events

• BidEscrowSlashResults

pub fn cancel_finished_voting(&mut self, voting_id: VotingId)

Cancels a voting that has not been finished in defined time

Errors

• crate::utils::Error::VotingDoesNotExist
• crate::utils::Error::VotingWithGivenTypeNotInProgress
• crate::utils::Error::FinishingCompletedVotingNotAllowed
• crate::utils::Error::VotingNotStarted
• crate::utils::Error::VotingAlreadyFinished
• [crate::utils::Error::VotingAlreadyCancelled]

pub fn voting_exists( &self, voting_id: VotingId, voting_type: VotingType ) -> bool

Checks if voting of a given type and id exists.

pub fn get_ballot( &self, voting_id: VotingId, voting_type: VotingType, address: Address ) -> Option<Ballot>

Returns the Voter’s Ballot.

pub fn get_voter( &self, voting_id: VotingId, voting_type: VotingType, at: u32 ) -> Option<Address>

Returns the address of nth voter who voted on Voting with voting_id.

pub fn get_voting(&self, voting_id: VotingId) -> Option<VotingStateMachine>

Returns Voting for given id.

pub fn post_job_offer( &mut self, expected_timeframe: BlockTime, budget: Balance, dos_fee: Balance )

Job Poster post a new Job Offer.

Errors

• NotKyced - if the caller is not KYCed
• DosFeeTooLow - if the caller has not sent enough DOS Fee

Events

• JobOfferCreated

pub fn pick_bid( &mut self, job_offer_id: JobOfferId, bid_id: BidId, cspr_amount: Balance )

Job poster picks a bid. This creates a new Job object and saves it in a storage.

Events

• JobCreated
• Unstake - in case there were other bids on the same Job Offer

Errors

• OnlyJobPosterCanPickABid - if the caller is not the Job Poster
• PurseBalanceMismatch - if the purse balance does not match the bid amount

pub fn submit_bid( &mut self, job_offer_id: JobOfferId, time: BlockTime, payment: Balance, reputation_stake: Balance, onboard: bool, cspr_stake: Option<Balance> )

Worker submits a Bid for a Job.

Events

• BidSubmitted
• Stake

Errors

• NotKyced - if the caller is not KYCed
• CannotBidOnOwnJob - if the caller is the Job Poster
• VaOnboardedAlready - if the caller has already been onboarded, but is trying to onboard again
• PaymentExceedsMaxBudget - if the proposed payment exceeds the maximum budget
• AuctionNotRunning - if the auction is not running
• OnlyOnboardedWorkerCanBid - if the Worker is not onboarded and the auction is internal
• OnboardedWorkerCannotBid - if the Worker is onboarded, auction is public and the configuration forbids bidding by onboarded Workers on such auctions
• InsufficientBalance - if the Worker has not enough balance to pay for the bid
• ZeroStake - if the Worker tries to stake 0 reputation
• NotWhitelisted - if the contract is not whitelisted for Reputation Staking

pub fn cancel_bid(&mut self, bid_id: BidId)

Worker cancels a Bid for a Job.

Bid can be cancelled only after VABidAcceptanceTimeout time has passed after submitting a Bid.

Events

• BidCancelled
• Unstake

Errors:

• CannotCancelNotOwnedBid when trying to cancel a Bid that is not owned by the Worker
• CannotCancelBidOnCompletedJobOffer when trying to cancel a Bid on a Job Offer that is already completed
• CannotCancelBidBeforeAcceptanceTimeout when trying to cancel a Bid before VABidAcceptanceTimeout time has passed

pub fn cancel_job_offer(&mut self, job_offer_id: JobOfferId)

Invalidates the Job Offer, returns DOS Fee to the Job Poster, returns funds to Bidders. .

pub fn job_offers_count(&self) -> u32

Returns the total number of job offers.

pub fn bids_count(&self) -> u32

Returns the total number of bids.

pub fn get_job_offer(&self, job_offer_id: JobOfferId) -> Option<JobOffer>

Returns a JobOffer with given JobOfferId.

pub fn get_bid(&self, bid_id: BidId) -> Option<Bid>

Returns a Bid with given BidId.

pub fn submit_job_proof(&mut self, job_id: JobId, proof: DocumentHash)

Submits a job proof. This is called by a Worker or any KYC’d user during Grace Period. This starts a new voting over the result.

Events

• JobSubmitted
• Unstake - Stake is used in the voting
• BallotCast - first vote is cast by the Worker

Errors

Throws JobAlreadySubmitted if job was already submitted. Throws OnlyWorkerCanSubmitProof if the caller is not the Worker and the grace period is not ongoing.

pub fn submit_job_proof_during_grace_period( &mut self, job_id: JobId, proof: DocumentHash, reputation_stake: Balance, onboard: bool )

Updates the old Bid and Job, the job is assigned to a new Worker. The rest goes the same as regular proof submission. See submit_job_proof(). The old Worker who didn’t submit the proof in time, is getting slashed.

pub fn cancel_job(&mut self, job_id: JobId)

pub fn vote( &mut self, voting_id: VotingId, voting_type: VotingType, choice: Choice, stake: Balance )

Casts a vote over a job.

Events

• BallotCast

Errors

• CannotVoteOnOwnJob if the voter is either of Job Poster or Worker
• VotingNotStarted if the voting was not yet started for this job

pub fn finish_voting( &mut self, voting_id: VotingId, voting_type: VotingType ) -> VotingSummary

Finishes voting. Depending on type of voting, different actions are performed.

Events

• VotingEnded
• BallotCast - when formal voting starts
• Unstake
• Stake
• Mint

Errors

• BidNotFound if the bid was not found
• VotingDoesNotExist if the voting does not exist
• VotingWithGivenTypeNotInProgress if the voting is not in progress
• FinishingCompletedVotingNotAllowed if the voting is already completed

pub fn jobs_count(&self) -> u32

Returns the total number of jobs.

pub fn get_job(&self, job_id: JobId) -> Option<Job>

Returns a job with given JobId.

pub fn propose_new_owner(&mut self, owner: Address)

Changes the ownership of the contract. Transfers ownership to the owner. Only the current owner is permitted to call this method.

pub fn accept_new_owner(&mut self)

Accepts the new owner proposition. This can be called only by the proposed owner.

pub fn add_to_whitelist(&mut self, address: Address)

Adds a new address to the whitelist.

pub fn remove_from_whitelist(&mut self, address: Address)

Remove address from the whitelist. ;

pub fn is_whitelisted(&self, address: Address) -> bool

Checks whether the given address is added to the whitelist. .

pub fn get_owner(&self) -> Option<Address>

Returns the address of the current owner. .

pub fn init( &mut self, variable_repository: Address, reputation_token: Address, kyc_token: Address, va_token: Address )

Constructor function.

Note

Initializes contract elements:

• Sets up the contract by saving addresses of Variable Repository, Reputation Token, VA Token, KYC Token.
• Sets [caller] as the owner of the contract.
• Adds [caller] to the whitelist.

Events

Emits:

• OwnerChanged,
• AddedToWhitelist,

Trait Implementations

impl Clone for BidEscrowContractRef

fn clone(&self) -> BidEscrowContractRef

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.