Skip to content

Commit

Permalink
update README, add wiki link and fix typos
Browse files Browse the repository at this point in the history
update project conf: classifiers and keywords
  • Loading branch information
Elnaril committed Dec 28, 2023
1 parent 10749d9 commit b5ef796
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
---

## Release Notes
### v1.0.1
- Fix issue #35 - fails to decode input data when there is too many commands
### v1.0.0
- Add support for SWEEP and PAY_PORTION
- Fix decoding issues
Expand Down Expand Up @@ -171,8 +173,8 @@ The result is a tuple, starting with the "in-token" and ending with the "out-tok
The Universal Router allows the chaining of several functions in the same transaction.
This codec supports it (at least for supported functions) and exposes public methods that can be chained.

The chaining starts with the `encode.chain()` method and ends with the `build()` one which return the full encoded data to be included in the transaction.
Below some examples of encoded input for one function and one example for 2 functions.
The chaining starts with the `encode.chain()` method and ends with the `build()` one which returns the full encoded data to be included in the transaction.
Below some examples of encoded data for one function and one example for 2 functions.

Default values for deadlines and expirations can be computed with the static methods `get_default_deadline()` and `get_default_expiration()` respectively.
```python
Expand Down Expand Up @@ -357,3 +359,6 @@ transaction["data"] = encoded_data

# you can now sign and send the transaction to the UR
```

## Tutorials and Recipes:
See the [SDK Wiki](https://github.com/Elnaril/uniswap-universal-router-decoder/wiki).
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description = "Decode & Encode transaction data sent to Uniswap Universal Router
readme = "README.md"
requires-python = ">=3.8"
classifiers = [
"Development Status :: 2 - Pre-Alpha",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
Expand All @@ -27,7 +27,7 @@ license = {text = "MIT License"}
dependencies = [
"web3>=6.0.0,<7.0.0",
]
keywords = ["blockchain", "ethereum", "uniswap", "universal router", "decoder", "encoder", "codec", "wrapper"]
keywords = ["blockchain", "ethereum", "uniswap", "universal router", "decoder", "encoder", "codec", "wrapper", "SDK"]

[tool.setuptools]
packages = ["uniswap_universal_router_decoder"]
Expand Down

0 comments on commit b5ef796

Please sign in to comment.