Inheritance: SmartContract, IOpdexVault

A smart contract used to lock and distribute tokens based on created certificates through community approved proposals.

The mined token contract distributes the allotted amount yearly to the mining governance and vault contracts. The vault contract will automatically receive tokens and update total supply of locked and unassigned vault tokens.

Proposals can be created to be voted on and when approved, assign tokens to a certificate within the vault, to vest then redeem after about a year (1,971,000 blocks). Proposals can also be created for revoking vault certificates during vesting, changing the total pledge minimum amount and changing the total vote minimum amount.

Proposal creation is public, meaning anyone can do it, however, proposals will not be put into affect unless they pass the minimum pledge amount, the minimum vote amount, and there must be more votes in favor than in opposition.

Constructor

public OpdexVault(ISmartContractState state,
                  Address token,
                  ulong vestingDuration,
                  ulong totalPledgeMinimum,
                  ulong totalVoteMinimum,
                  ulong vestingDuration) : base(state)

Parameters

Properties

Methods

Get Certificate

Retrieves a certificate a given address is assigned.

Certificate GetCertificate(Address wallet);

Parameters

Returns

Certificate

Get Proposal

Retrieves the details about a proposal.

ProposalDetails GetProposal(ulong proposalId);

Parameters

Returns

Proposal Details

Get Proposal Vote

Retrieve the vote details of a voter for a specific proposal.

ProposalVote GetProposalVote(ulong proposalId, Address voter);

Parameters

Returns

Proposal Vote

Get Proposal Pledge

Retrieve the amount of tokens pledged by an address for a proposal.

ulong GetProposalPledge(ulong proposalId, Address pledger);

Parameters

Returns

Get Certificate Proposal Id By Recipient

Retrieves an Id of a certificate proposal that the specified recipient has open, limiting to one proposal per recipient for certificate based proposals at a time.

ulong GetCertificateProposalIdByRecipient(Address recipient);

Parameters

Returns

Notify Distribution

Method to allow the vault token to notify the vault of distribution to update the total supply.

void NotifyDistribution(UInt256 amount);

Parameters

Redeem Certificate

Redeems a vested certificate the sender owns and transfers the claimed tokens.

void RedeemCertificate();

Create New Certificate Proposal

Creates a new proposal for a certificate to be created. If this proposal were to pass, the recipient would receive a certificate that is vested for the VestingDuration, entitling them to an amount of governance tokens in the vault.

ulong CreateNewCertificateProposal(UInt256 amount, Address recipient, string description);

Parameters

Returns

Create Revoke Certificate Proposal

Creates a new proposal for a certificate to be revoked. If this proposal were to pass, the certificate holder would only be entitled to the governance tokens accrued in the VestingDuration, up to the block at which the certificate is revoked.

ulong CreateRevokeCertificateProposal(Address recipient, string description);

Parameters

Returns

Create Total Pledge Minimum Proposal

Creates a new proposal for a change to the minimum pledge total amount. If this proposal were to pass, it would alter the total amount of tokens required to pledge to a proposal, so that it can move on to a vote.

ulong CreateTotalPledgeMinimumProposal(UInt256 amount, string description);

Parameters

Returns

Create Total Vote Minimum Proposal

Creates a new proposal for a change to the minimum vote total amount. If this proposal were to pass, it would alter the total amount of tokens required to vote on a proposal, so that it can have a chance to pass.

ulong CreateTotalVoteMinimumProposal(UInt256 amount, string description);

Parameters

Returns

Pledge

Pledge for a proposal by temporarily locking CRS tokens to help meet the minimum pledge amount, so that it can move to an official vote.

void Pledge(ulong proposalId);

Parameters

Vote

Votes for or against a proposal by temporarily holding CRS in contract as vote weight.

void Vote(ulong proposalId, bool inFavor);

Parameters

Withdraw Pledge

Withdraws CRS tokens from a proposal pledge, removing the pledge if still in progress.

void WithdrawPledge(ulong proposalId, ulong withdrawAmount);

Parameters

Withdraw Vote

Withdraws held CRS from proposal vote, removing the vote if still in progress.

void WithdrawVote(ulong proposalId, ulong withdrawAmount);

Parameters

Complete Proposal

Completes a proposal and executes the resulting command within the vault contract if approved.

void CompleteProposal(ulong proposalId);

Parameters

Logs

Create Vault Certificate Log

Emitted when a vault certificate is created, either for the vault owner during each distribution period or from the owner to a new certificate holder.

Redeem Vault Certificate Log

Emitted when an address redeems their certificate and claims their tokens.

Revoke Vault Certificate Log

Emitted when the vault owner revokes a non-vested wallet’s certificate.

Create Vault Proposal Log

Emitted after a new proposal is created.

Complete Vault Proposal Log

Emitted after a proposal is expired and completed.

Vault Proposal Pledge Log

Emitted after pledging toward a proposal.

Vault Proposal Vote Log

Emitted after voting on a proposal.

Vault Proposal Withdraw Pledge Log

Emitted after withdrawing locked CRS used to pledge to a proposal.

Vault Proposal Withdraw Vote Log

Emitted after withdrawing locked CRS used to vote on a proposal.

References

OpdexVault Smart Contract - Github

IOpdexVault Interface - Github

Stratis SmartContract Documentation - Stratis Academy