* 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.
* add validateAndSendTransactionAsync to all wrappers
* remove contract-wrappers from @0x/contracts-extensions
* replace error types in contract-wrappers
* upgrade asset-buyer and asset-swapper to contract-wrappers v11
* update website and 0x.js
* remove calldataOptimizationUtils
The update to the fixture contract's artifact added a bunch of
`internalType` stuff. I'm not sure where that came from. Maybe
newly generated by the latest version of solc?
* 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
* abi-gen/Py: fix return type for multi-val returns
Methods that return multiple values were broken in two ways. One: a
spurious newline was being injected between the return type and the
colon ending the Python method prototype. Two: the return type was
being generated as just `[TypeA, TypeB]`, whereas it should be
`Tuple[TypeA, TypeB]`.
* abi-gen/Py: fix support for arrays of structs
* abi-gen/Py: FAILING test case nested unrefd struct
When a struct contains another struct, and the inner struct is not
directly referenced by any method interface, wrapper generation is
failing to render a class to represent the inner struct.
This won't fail in CI because at this time CI doesn't run any native
Python tooling to analyze the generated code. Running mypy locally on
the files in this commit produces the following output:
test-cli/output/python/abi_gen_dummy/__init__.py:76: error: Name 'Tuple0x246f9407' is not defined
This problem affects the generation of wrappers for the DutchAuction
contract.
* abi-gen/Py: fix nested unref'd struct failure
* abi-gen/Py: introduce newlines to quiet linter
When generating contracts with long names (eg
CoordinatorRegistryValidator), the `black` reformatter was introducing
these newlines for us, and it was moving the `# type: ignore` comment in
there such that it no longer was on the line it needed to be on.
Introducing these newlines manually (instead of letting black inject
them) allows the linter directive to stay where it needs to be.
* abi-gen/Py: declare tuples in dependency order
* abi-gen/Py: fix support for overloaded methods
* contract_wrappers.py: pylint: permit 2-char args
By default pylint says that 2 characters is too short for an argument
name, but we have some contract methods with 2-character argument names
(eg `to` in `AssetProxyOwner.getTransactionIds()`), so we want to permit
them.
* contract_wrappers.py: include all contracts
* Update CHANGELOGs
* abi-gen: rename variable
* abi-gen: refine comments
* abi-gen/Py: reword tuple class docstring
* 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
* git rm unnecessary .gitkeep file
* After all Pytest runs, show short test summary
* abi-gen/Py: facilitate inlining of parameter lists
Effectively, stopped new-lines from being introduced by calls to the
`params` and `typed_params` partials.
* abi-gen: simple Py wrapper test for local dev'ment
* abi-gen/Py: stop gen'ing ValidatorBase
* abi-gen/Py: declare abi() wrapper method in Base
* abi-gen/Py: methods as classes to ease call/sendTx
Represent methods as classes in order to faciliate access to a method's
different operations (call, send_transaction, etc).
* contract_wrappers.py: make Base methods public
Changed some methods on BaseContractWrapper to be public.
* contract_wrappers.py: remove unused method
* contract_wrappers.py: extract method
* abi-gen/Py: inline method
* contract_wrappers.py: fix bug in call()
We were passing transaction parameters through to sendTransaction()
invocations, but not to call() invocations.
* abi-gen/Py: remove `view_only` param to call/tx
Formerly, in the BaseContractWrapper, there was just one function used
for both eth_call and eth_sendTransaction, and you would distinguish
between the two by specifying `view_only=True` when you wanted a call.
This commit defines a method dedicated to executing an eth_call, and
leaves the old method behind, with the `view_only` param removed, to be
used for eth_sendTransaction.
* abi-gen/Py: rename method
* contract_wrappers/Py: simplify web3 func handling
Pass web3 function instance into generated wrapper method class
constructor, rather than having that class obtain it upon each method
call.
Really this is just an elimination of a call to
BaseContractWrapper.contract_instance(), which will be removed
completely in a shortly-upcoming commit.
* contract_wrappers.py: inline method
Inline and remove method BaseContractWrapper.contract_instance().
* contract_wrappers.py: pass Validator to *Method
Pass a ValidatorBase instance into construction of the contract method
classes, *Method, to eliminate another dependency on the containing
contract object, which will be eliminated completely in a
shortly-upcoming commit.
* abi-gen/Py: BaseContractWrapper -> ContractMethod
Change the fundamental thing-to-be-wrapped from the contract to the
method. Since the named method classes were introduced (in a previous
commit), and since the operations contained within the Base are
predominantly focused on supporting method calls more than anything
else, it makes more intuitive sense to provide a base for the methods
than for the contract.
With this change, the method classes no longer require a contract object
to be passed to their constructors. The contract members that the
methods were utilizing are now passed directly to the method
constructor.
* contract_wrappers.py: rename module to bases...
...from _base_contract_wrapper. The old name hasn't made sense since
ValidatorBase was moved into that module, and definitely doesn't make
sense now that the fundamental thing-to-be-wrapped has changed from the
contract to the method. Also renamed to make it public (removed the
leading underscore) since we're generating code that will depend on it.
* abi-gen/Py: clarify call/sendTx docstrings
* abi-gen/Py: adjust whitespace
* contract_wrappers.py: inline method
* abi-gen/Py: rename class ValidatorBase...
...to just Validator. It's in the "bases" module, which provides the
context needed in order to know it's a base class
* python-packages: fix silent failures of ./parallel
* contract_wrappers.py: remove private_key support
Having this present was overcomplicating interfaces. And it was
untested (and not readily working when testing was attempted). And it
only provided a thin layer of convenience, which a client could easily
code up themselves.
* contract_wrappers.py: inline method
* contract_wrappers.py: rm unused member variables
* contract_wrappers.py: rm unnecessary instance var
* abi-gen/Py: add estimate_gas to gen'd methods
* update CHANGELOG.json
* Define SubscriptionManager and instantiate in generated wrappers
* expose subscribe/unsubscribe in generated wrappers
* update changelogs
* use SubscriptionManager in `@0x/contract-wrappers`
* 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)
