Added docs to ViewBTC.sol #160

ErinHales · 2020-05-26T22:39:37Z

No description provided.

solidity/contracts/ViewBTC.sol

* added honey bunches of docs * fixed doc errors * fixed stuff * removed todo, edited some docs

* feature: first pass at BTCView * refactor: views are now bytes29 to avoid type confusion with digests * refactor: simplify and test castTo * test: test for isValid * refactor: clarify loc/len and fix linting * test: add test for len function * bug: fix improper mask genreation by deleting the function * chore: more comments and explanation * Added docs to ViewBTC.sol (#160) * added honey bunches of docs * fixed doc errors * fixed stuff * removed todo, edited some docs * chore: finish test scaffolding for ViewBTC * bug: type error in ViewBTCTest * feature: ViewSPV contract * lint: indentation * chore: rename lib and natspec title * tests: scaffoled test file for ViewSPV * document clarification * feature: writeTo and join * refactor: distinguish between build and uncheckedBuild. refactor unsafe functions * WIP: `viewBTC` js tests (#165) * first test * more tests, cleaned up BTCUtils.test.js * wrong function * added more tests * cleaned up file, added more tests * feature: hex encoded errors for typedmemview * fixed opReturnPayload test, added scriptPubkey function in ViewBTCtest.sol * tests: indexVin and indexVout - fix indexVin & indexVout - fix tryAsVin & tryAsVout - fancy hex errors in typedmemview - add tests for indexing vin/vout - remove vectors for non-minimal varints in vin/vout - misc cleanup to truffle config - linting - type to uint conversion comments * refactor: improve/fix nibbleHex * finished nasty verifyHash256Merkle function test * tests: Tests and bugfixes for ViewSPV * added notes * moved type conversion and validation to ViewSPVTest.sol * accidentally reverted change * added more type assertions * notes on tryAsVout test * lint: solidity assembly * feature: error message for non-minimal varints * added new errors for Non-minimal varints * refactor: improve non-minimal varint error * bug: don't be so lazy * fixed test cases that deal with non-minimal var ints * updated error tests, needs cleaned up * pushing latest * fixed bugs * finished payload, work and workHash tests * separated out error cases * Organized ViewBTC tests * updated test descriptions * bug: fix payload p2sh path * added test case to extractHash * chore: improved comments for typedmemview * chore: remove duplicate test vector Co-authored-by: James Prestwich <james@prestwi.ch> * Test for `checkWork` (#173) * added some checkWork tests * removed only * lint error * opt: use identity function for copying * refactor: clean up clone * refactor: remove legacy files and update CheckBitcoinSigs * refactor: redelete BTCUtils * lint: whitespace * version: bump sol to 4.0.0 * feature: tryAsSPK * refactor: slightly clean up uncompressed pubkey handling Co-authored-by: Erin Hales <36751902+ErinHales@users.noreply.github.com> Co-authored-by: Erin Hales <erin@summa.one>

added honey bunches of docs

087c21c

ErinHales requested a review from prestwich May 26, 2020 22:39