Merge branch 'master' into security-md

.github/workflows/publish_docs.yml

@@ -23,6 +23,7 @@ jobs:
 
     - name: Build Sphinx Documentation
       run: |
+        make docs
         cd docs
         make html
 
@@ -32,5 +33,3 @@ jobs:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ./docs/_build/html
         keep_files: false
-
-

.gitignore

@@ -12,6 +12,10 @@
 
 **/_build/
 
+**/build/
+
+cdp_sdk.egg-info/
+
 venv/
 .venv/
 
@@ -25,3 +29,4 @@ env/
 .\#*
 .projectile
 
+.idea/

CHANGELOG.md

@@ -0,0 +1,104 @@
+# CDP Python SDK Changelog
+
+## Unreleased
+
+### [0.11.0] - 2024-11-27
+
+### Added
+- Add support for funding wallets (Alpha feature release)
+  - Must reach out to CDP SDK Discord channel to be considered for this feature.
+- Added create and update feature for `SmartContractEventActivity` webhook and its related event type filter.
+
+### Fixed
+- Fix bug in `Asset.from_model` where passed in asset ID was not used when creating a gwei or wei asset.
+
+## [0.10.4] - 2024-11-25
+
+### Added
+
+- Wallet address key export
+
+## [0.10.4] - 2024-11-25
+
+### Added
+
+- Wallet address key export
+
+## [0.10.3] - 2024-11-07
+
+### Added
+
+- Adds `source` and `source_version` to correlation header for better observability.
+
+### Fixed
+
+- Fix bug in `WalletAddress` `invoke_contract` that failed to properly handle `amount` with type `str`
+
+## [0.10.2] - 2024-11-06
+
+### Added
+
+- Support for reading int24, int56, and uint160 values from smart contracts.
+
+## [0.10.1] - 2024-10-31
+
+### Fixed
+
+- Fix Faucet transaction_link to return the correct transaction link instead of transaction hash.
+
+## [0.10.0] - 2024-10-31
+
+### Changed
+
+- Make faucet transactions async i.e. using `faucet_tx.wait()` to wait for the transaction to be confirmed.
+  - This will make the SDK more consistent and make faucet transactions more reliable.
+
+## [0.0.9] - 2024-10-29
+
+### Fixed
+
+- Fixed bug in gasless transfer that blocked sending the full asset balance.
+
+## [0.0.8] - 2024-10-28
+
+### Added
+
+- Include correlation ID in API Errors.
+
+## [0.0.7] - 2024-10-25
+
+### Added
+
+- Include ERC20 and ERC721 token transfer information into transaction content.
+- Support for wallet and address webhooks to trigger based on onchain activities.
+
+## [0.0.6] - 2024-10-17
+
+### Added
+
+- Support for read_contract to read from smart contracts
+
+## [0.0.5] - 2024-10-3
+
+### Added
+
+- Support list historical balances and list transactions function for address.
+
+## [0.0.4] - 2024-10-1
+
+### Added
+
+- Contract invocation support.
+- Arbitrary message signing support.
+- Deploy ERC20, ERC721, and ERC1155 smart contracts.
+- Hashing utilities for EIP-191 / EIP-712 data messages.
+
+### Fixed
+
+- Fixed bug in `Wallet` `default_address` property for newly hydrated wallets.
+
+## [0.0.3] - 2024-09-25
+
+### Added
+
+- Initial release of the CDP Python SDK.

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing Guide
+
+## Development
+
+### Python Version
+
+Developing in this repository requires Python 3.10 or higher.
+
+### Set-up
+
+Clone the repo by running:
+
+```bash
+git clone [email protected]:coinbase/cdp-sdk-python.git
+```
+
+To install all dependencies, run:
+
+```bash
+make install-deps
+```
+
+### Formatting
+
+To format the code, run:
+
+```bash
+make format
+```
+
+### Linting
+
+To detect all lint errors, run:
+
+```bash
+make lint
+```
+
+To autocorrect all lint errors, run:
+
+```bash
+make lint-fix
+```
+
+### Testing
+To run all tests, run:
+
+```bash
+make test
+```
+
+### Generating Documentation
+
+To build and view the documentation locally, run:
+
+```bash
+make local-docs
+```

Makefile

@@ -28,4 +28,8 @@ install-deps:
 
 .PHONY: docs
 docs:
-	sphinx-apidoc -o docs/ ./cdp/
+	sphinx-apidoc -f -o docs/ ./cdp/
+
+.PHONY: local-docs
+local-docs: docs
+	cd docs && make html && open ./_build/html/index.html