ddaws / go-maker Goto Github PK

Add support for connecting to the Maker DSChief for pulling Governance information from the Maker system including the current hat, proposed slates, and their votes. This is important to support developing and monitoring governance tools.

Some useful links for my future self

• https://docs.makerdao.com/smart-contract-modules/governance-module/chief-detailed-documentation
• https://via.hypothes.is/https://github.com/dapphub/ds-chief/blob/master/src/chief.sol
• https://github.com/makerdao/dai.js/blob/dev/packages/dai-plugin-governance/contracts/addresses/mainnet.json
• https://via.hypothes.is/https://github.com/dapphub/ds-note/blob/master/src/note.sol
• https://solidity.readthedocs.io/en/v0.5.3/layout-of-source-files.html
• https://solidity.readthedocs.io/en/v0.4.21/using-the-compiler.html

Contract code is currently generated using abigen and uses the defaults, returning big.Int for uint256 types on chain. A custom generator should be written to allow us to return Rad, Ray, and Wad types as defined here: https://github.com/ddaws/go-maker/blob/master/maker/math.go#L15-L25

This will remove the need to for consumers to create these types and reduce the chance of user precision errors when using these types.

The Maker system uses fixed point arithmetic storing values on chain as uint256. go-etheruem represents uint256 as a a big.Int. How to correctly add, sub, mul, and div these values while accounting for precision isn't always clear. This can make calculations error prone.

go-maker should expose a minimal set of types and operations that handles precision properly to minimize the user error when working with these values.