This directory holds the Charkha smart contracts, the protocol unit tests, and the protocol formal verification.
I recommend reading through the contracts in the same order they are described in the Charkha guide, which is to say in the following order:
-
Price Oracle (contract, tests)
This contract is a simple refresher on Pact contracts, as it has minimal functionality and serves as a simple database.
-
KETH Ethereum Bridge Token (contract, tests)
This contract demonstrates how to implement the fungible-v2 interface for a KIP-0005 token, and should be read before any other tokens (the other contract files omit comments around implementing the interface).
-
CHRK Governance & Rewards Token (contract)
This contract demonstrates a more advanced token with a capped maximum supply and restricted minting.
-
Charkha Market Tokens (interface, cwKDA, cwKETH, cwCHRK)
These contracts demonstrate how to write an interface of our own and then implement several simple tokens against it.
-
Governance Contract (contract)
This contract is a more complex Pact contract which demonstrates how to implement more sophisticated governance rules; this contract implemetns the Charkha formulas that can be changed according to a vote, where holding 1 CHRK token allows you 1 vote.
-
Charkha Controlling Contract (interface, contract)
This contract brings all the others together into the full implementation of the Charkha protocol. It should be read after all the others, and demonstrates a real-world, sophisticated Pact contract.
The entirety of the Charkha protocol is contained in these contracts. The basic contracts like the oracle and KETH token have accompanying .repl test files you can use to see the contract in action. The overall protocol has a test.repl file containing the full tests for the protocol.
Each contract also has an accompanying TypeScript binding in the Charkha app so you can see how this Pact code translates to TypeScript API calls.