* CI: use a docker image that includes Python
So that tests of abi-gen generating Python can exercise the code being
generated.
* CI fix: disable old yarn permission denied hack
Motivated by CI failure of previous commit.
* CI fix: more resources for test-contracts-ganache
Motivated by CI failure of previous commit.
* CI fix: remove hack of permissions for python libs
Fix for previous CI run's failure of test-python. Apparently we don't
need this in the docker container we've switched to.
* abi-gen/Py: minimum viable test of gen'd code
Ensure the code is parseable by running it through black.
* abi-gen/Py: expand Python linter usage
Make abi-gen filter its output through black, if its available in the
runtime environment. Accordingly, stop having contract_wrappers.py's
setup.py pre_install run black on copied-over files.
Adds Pylint to the list of linters run against test-cli/output.
* abi-gen: re-enable Solidity linter
It was broken, running seemingly cleanly but not actually reading any
files, because it was targetting the wrong folder.
* abi-gen/test-cli/fixtures/sol: fix linter errors
* abi-gen/test-cli: disable pylint blackisted-name
* abi-gen/Py: rm unused var in contracts w/o methods
Remove unused variable from generated wrapper for contracts without any
methods.
* Install Py packages in dep. order, not in parallel
Install Python packages in dependency order, not in parallel.
* sra_client.py: Add `./setup.py clean`
* Fix python package dependency ordering...
...and include a script to produce the proper ordering.
* sra_client.py: reformat whitespace in doctest
* contract_wrappers.py: don't auto-import wrappers
This was discovered while minimizing CircleCI steps to dianose a problem
with running the Launch Kit Backend in CircleCI.
These classes should be imported via the
zero_ex.contract_wrappers.exchange and
zero_ex.contract_wrappers.erc20_token modules, respectively. We
permitted importing them from just zero_ex.contract_wrappers back when
they were the only wrappers we had, but now that we have so many
different contracts being wrapped, this is just another list to keep
manually updated (which, obviously is error prone, since it slipped
through the cracks already), so it's better to just not support this
type of import.
* abi-gen/Py: doc contract method attributes
Without this, generated documentation was not including the class
members that represent the contract methods, rendering the usage
unclear.
* sra_client.py: disable tests in CI
* abi-gen/Py: strip repeated spaces from devdoc
* contract_wrappers.py: gen docs for all wrappers...
...except for the dummy tokens.
* sra_client.py/test: change launch kit docker image
Previously these teses were using 0xorg/launch-kit-ci, but that was a
one-off thing created just for CI, back before there was a regularly
maintained docker image of Launch Kit.
Changed to use 0xorg/launch-kit-backend since it's regularly
maintained/updated.
Because the -backend image is using a different Linux distribution
(Alpine), the commands used to wait for ganache startup also had to
change.
The tag used, 74bcc39, is provisional due to the pending Issue at
https://github.com/0xProject/0x-launch-kit-backend/issues/73 . When
that issue is resolved, the tag suffix on the imag name should be
removed.
* Migrate from Web3.py 4.x to 5.x
* sra_client.py: checksum address in doctest
Due to problem with launch-kit-backend, documented at
https://github.com/0xProject/0x-launch-kit-backend/issues/73 ,
we need to checksum the makerAddress, in the order retrieved from the
relayer, before filling it, otherwise Web3.py gives this error:
InvalidAddress('Web3.py only accepts checksum addresses. The software
that gave you this non-checksum address should be considered unsafe,
please file it as a bug on their platform. Try using an ENS name
instead. Or, if you must accept lower safety, use
Web3.toChecksumAddress(lower_case_address).',
'0x5409ed021d9299bf6814279a6a1411a7e866a631')
* Update CHANGELOGs
* sra_client.py: make CHANGELOG be REVESE chrono.
Formerly CHANGELOG was in chronological order. Now it's in reverse
chronological order.
* abi-gen/Py: fix missing space in sanitized devdoc
* first pass at including doc comments
* incorporate suggestions for method comments; add devdoc to dummy contract
* better formatting and persist generated docs as circleci build artifacts
* store artifacts properly
* hanging indent for method params
* Rename existing wrapper, to match contract name
* base contract: make member var public
* json_schemas.py: stop storing copies of schemas!
* .gitignore generated erc20_token.py wrapper
* json schemas: allow uppercase digits in address
* existing exchange wrapper: re-order methods
to match method order in Solidity contract, to reduce noise in upcoming
diffs of newly generated code vs. old manually-written code.
* existing exchange wrapper: rename method params
To match contract method param names
* existing exchange wrapper: remove redundant member
* existing exchange wrapper: make signatures bytes
Not strings.
* abi-gen/test-cli: show context on diff failure
* abi-gen-templates/Py: fix broken event interface
Previous changes had removed the `token_address` parameter from all
generated methods, but this instance was missed because there weren't
tests/examples using events for the first contract for which wrappers
were generated (ERC20Token).
* abi-gen: remove unused method parameters
* abi-gen: convert Py method params to snake case
* abi-gen: rewrite Python tuple handling
* python-generated-wrappers: include Exchange
* abi-gen-templates/Py: easy linter fixes
* abi-gen-templates/Py: satisfy docstring linters
* abi-gen-templates/Py: normalize bytes before use
* contract_wrappers.py: replace Exchange w/generated
* contract_wrappers.py: rm manually written Exchange
* contract_wrappers.py/doctest: rename variables
* abi-gen: fix misspelling in docstring
Co-Authored-By: Fabio B <me@fabioberger.com>
* Py docs: error on warning, and test build in CI
* abi-gen: doc Py bytes params as requiring UTF-8
* abi-gen: git mv diff.sh test-cli/
* abi-gen: put Py wrapper in module folder, not file
This leaves space for user-defined additions to the same module, such as
for custom types, as shown herein.
* abi-gen: customizable param validation for Python
* contract_wrappers.py: JSON schema Order validation
* CircleCI Build Artifacts
For abi-gen command-line test output, for generated Python contract
wrappers as output by abi-gen, for generated Python contract wrappers as
reformatted and included in the Python package area, and for the "build"
output folder in each Python package, which includes the generated
documentation.
* CHANGELOG updates for all components
* abi-gen: grammar in comments
Co-Authored-By: Fabio B <me@fabioberger.com>
* abi-gen: CHANGELOG spelling correction
Co-Authored-By: Fabio B <me@fabioberger.com>
* order_utils.py: reverse (chronological) CHANGELOG
* abi-gen-templates: reset CHANGELOG patch version
* CHANGELOGs: use multiple entries where appropriate
* abi-gen: enable devdoc solc output in test-cli
* abi-gen-templates/Py: consolidate return type
* abi-gen/test-cli: non-pure fixture contract method
Added a method to the "dummy" test fixture contract that isn't pure.
All of the other prior method cases were pure.
* abi-gen/Py: fix const methods missing return type
* abi-gen/Py: fix wrong return types on some methods
Specifically, wrapper methods wrapping contract methods that modify
contract state and return no return value. There was no test case for
this. Now there is.
* contract_wrappers.py: rm generated code in `clean`
* Parallelize Py monorepo scripts (test, lint, etc)
* abi-gen-wrappers: fix half-baked folder rename
* .circleci: give cache more descriptive name
* abi-gen: rename type field. tsName->langLocalName
* contract-artifacts: add devdoc to ERC20Token.json
Artifact changes crafted manually: re-generated artifacts from within
@0x/contracts-erc20, and then copied them into @0x/contract-artifacts,
but only committed the changes that added devdoc.
Modified @0x/contracts-erc20/compiler.json to include devdoc in the
hopes that next time contract-artifacts are re-generated en masse, the
devdoc output will just come along for the ride.
Compiling ERC20 TypeScript wrappers after adding devdoc to the artifacts
revealed some inconsistencies in the types. ethereum-types'
DevdocOutput REQUIRED many fields which are not always present,
depending the devdoc contents itself. Relaxing the requirement had some
ramifications.
* abi-gen: Python!
Lots more to come, but so far generating typed methods with some
parameter validation and with reasonable docstrings; enough to make
ERC20 work.
* existing erc20 python wrapper: re-order methods
In order to minimize the diff in the upcoming commit of the
auto-generated version.
* existing erc20 python wrapper: rename method
Rename method _erc20 to _get_contract_instance.
* existing erc20 python wrapper: rename vars
Rename method parameters to match names used in contract methods.
* existing erc20 python wrapper: correction
Contract method `allowance` previously was returning a transaction hash,
but it's a const method, so changed it to return the int that the
underlying method returns.
* contract_wrappers.py: pull in generated code
Custom setup.py command to pull in code previously generated into
../../packages/abi-gen-wrappers/src/generated-wrappers/py.
Changes to existing wrapper code reflect differences between the old,
manually-written wrapper and the new, auto-generated wrapper.
Reconfigured Circle CI to give Python build access to the output of the
TypeScript build, in order to import the generated wrappers from there.
* abi-gen: sanitize docstrings for pycodestyle lint
* abi-gen-templates.py: expose ABI from template
Use ABI given by template, not gotten by name from
zero_ex.contract_artifacts.
Also, expose ABI as a static method.
* py wrappers: contract addr to ctor, not methods
In all Python wrappers (old, manual ones; and new, generated ones), have
client pass the contract address to the wrapper's constructor, rather
than to the individual method calls.
* py wrappers: remove unused param `account_address`
* py wrappers: document use of `private_key`
* Rename file erc20_wrapper.py to erc20_token.py
To match the name of the underlying contract.
* Update CHANGELOG.json's
* git rm erc20_token.py
No need to keep it checked in. Doing so would require manual overhead
of keeping the generated copy in sync with the generation code, which
may get overlooked and cause confusion for others. Authoritative source
will be the published package on PyPI.
* abi-gen-templates: tweak CHANGELOG wording
Co-Authored-By: Fabio B <kandinsky454@protonmail.ch>
* Include transaction parameters in const calls too
* Doc contract_address param to gen'd wrapper ctor
* make myself a CODEOWNER of abi-gen*
* rename ids: langLocalName -> languageSpecificName
* Move Python generation to its own packages/ folder
* Stop duplicating contract artifacts in Python pkg!
Thanks to the way we're now using the `./setup.py pre_install`
convention, there's no longer a need to check the artifacts in to the
Python package.
* move py templates BACK to abi-gen-templates
I got a little overzealous in the previous commit that moved ALL the
python stuff into the new packages/python-contract-wrappers folder.
* Update known-good test output: prettify
* add getABIEncodedTransationData to gen'd code
It was added into the template in the following commit, but the
corresponding checked-in generated code was not updated accordingly.
f51c4f9617
* Fix missed instance of languageSpecificName change
* abi-gen: refine pipeline for testing gen'd code
- generate wrappers for test fixture contracts (dummy, etc) not in `yarn
build` but in `yarn test`
- rename folder test/generated-test/generated-wrappers to
test/generated-test/known-good, and stop writing test output to there,
instead writing it to a new test/generated-test/output folder.
- sol-compile test fixture contracts in every test run
- run unit tests separately from tests of generated and built TypeScript
wrappers. The existing `yarn run_mocha` will run unit tests, and
there's a new `yarn run_contract_wrapper_tests`.
* abi-gen: test Python gen [known test failures]
Also generate TypeScript wrapper test code into a TypeScript folder
(alongside the newly created Python folder).
Known-good code manually corrected (from generated code) to reflect
known problems that still need to be addressed. Namely:
- base contract and tx params should be imported from canonical
package, not relative path. relative path is working for wrapping
OUR contracts, but would not be usable in a more general
context.
- return type missing for some generated methods.
These outstanding problems are currently causing this test to fail.
* fix failing abi-gen test: missing return types
* fix failing abi-gen test: qualify imports
* in py wrapper, simplify base class initialization
per
https://github.com/0xProject/0x-monorepo/pull/1878#discussion_r299248641
* move 3rd party typings to typescript-typings
* make package python-contract-wrappers private
* make Xianny CODEOWNER of base-contract & templates
* abi-gen: clarify --help for --backend
* remove superfluous CHANGELOG entry
