* Exercise doctests as a test not as a linter
* Add a contract artifact doctest, and exercise it
* Clean up linter issues
* Change asset data decoding output type
Previously, it was a TypedDict, but that was causing problems. Sphinx
seems to be broken, such that none of the fields of the class were being
rendered into the doc.
Thinking on it further, I decided that a NamedTuple makes more sense
here anyways, since tuples are immutable and this output value isn't
something someone should ever build or modify. And, NamedTuple is
getting its fields properly rendered by Sphinx.
* Add type annotations to JSON schemas docs
* Add doc publish metadata file for middlewares pkg
* Improve documentation
Note that none of the changes to .py files impact functionality in any
way, because the changes are restricted to "docstrings", which to the
Python interpreter are simply no-op statements.
However, one caveat to that is that much of these docstring changes DO
affect the functionality of automated test runs, because all of the code
examples (blocks beginning with `>>> `) are "doctests", which are
exercised via the test framework.
The index.rst files are the top-level templates for generating the
documentation, and the "automodule"/"autoclass"/etc statements pull in
the docstrings from the source code.
* correct package name in doc URL
* Move sra_client module into zero_ex namespace
* Add functions to encode asset data to bytes
* Fix: SRA client was deserializing orders weirdly
The generated code was transforming the order structure, from the camel
case field name format in the spec, into the snake case field name
format expected by Python convention. With this problem in place, the
only way to take an order from a relayer and send it to a contract (for
fill, cancel, etc) was to manually transform the field names, one by
one, into a new structure.
* Fix problem with Web3/JSON order conversion utils
* doctest: maker, trade ZRX for WETH, not vice versa
* Remove redundant test
* Construct order in native Python, not JSON
Then convert it to JSON before sending it to the relayer.
* doctest: simplify asset units
* Add doctests for filling and cancelling
* Minor doctetst copy edits; whitespace
* Rename function, and add optional parameter
* Tweak docstrings on JSON conversion functions.
* Demo asset data decoding to view asset pairs
* Demo selecting an order from the order book
And have taker take it.
* Rename variable
* Abstract ganache from examples
Doing that exposed excessive use of the verbose
NETWORK_TO_ADDRESSES[NetworkId.Ganache] construct, so simplified that,
which ripped into eliminating other temporary variables that had been
used to hold specific contract addresses.
Also cleaned up some misplaced import statements.
* Add missing SRA client doc publication metadata
* Ran prettier on new SRA client doc pub metadata
* Remove local env customizations in doc metadata
* Eliminate temporary variable
* Rename variable
* Show `pip install` in every package's doc
* Doc NetorkID & pagination params as int, not float
* Clean up unmatched parenthesis in docs
* Refine Order for Web3 compat. & add conversions
Changed some of the fields in the Order class so that it can be passed
to our contracts via Web3.
Added conversion utilities so that an Order can be easily converted to
and from a JSON-compatible dict (specifically by encoding/decoding the
`bytes` fields), to facilitate validation against the JSON schema.
Also modified JSON order schema to accept integers in addition to
stringified integers.
* Fixes for json_schemas
Has-types indicator file, py.typed, was not being included in package.
Schemas were not being properly gathered into package installation.
* Add test/demo of Exchange.getOrderInfo()
* web3 bug workaround
* Fix problem packaging contract artifacts
* Move contract addresses to their own package
* Move contract artifacts to their own package
* Add scripts to install, test & lint all components
* prettierignore files in local python dev env
* Correct missing coverage analysis for sra_client
* CI cache lint: don't save, re-use from test-python
* tag hacks as hacks
* correct merge mistake
* remove local strip_0x() in favor of eth_utils
* remove json schemas from old order_utils location
* correct merge mistake
* doctest json schemas via command-line, not code
F. Eugene Aumson