This repository has been archived by the owner on Jan 13, 2023. It is now read-only.
PyOTA v2.2.0-beta1 #280
Merged
PyOTA v2.2.0-beta1 #280
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PyOTA v2.1.0
As part of the extended api (Iota class), this function takes a tail transaction hash of a bundle and re-broadcasts the entire bundle. It does so by fetching and validating the bundle from the Tangle, and calling broadcast_transactions() core api.
Implement broadcast_bundle Api Command
Checks if a list of tails can be promoted or not by calling checkConsistency core API and performing extra checks on the attachment_timestamp of the transactions fetched from the Tangle.
Motivation: Provide the same api calls as in the other iota libs. The difference between get_bundles and traverse_bundle is subtle: get_bundles validates the fetched bundle. Moved previous test cases related to traverse_bundle into new test file, refactored tests for get_bundles.
Refactor traverse_bundle into Extended Api Command
Implement is_promotable Extended API Command
- Restructured API documentation into 3 parts: - API classes - Core API commands - Extended API commands - Improve docstrings of API calls and types. - Introduce autodoc support for shpinx to generate documentation from docstrings. - Add autosectionlabel extension to sphinx.
Improve API documentation
Add docs build step to Travis CI
The method can insert custom messages or signatures into transactions in a ProposedBundle object. Must be called before bundle is finalized.
add_signature_or_message method for ProposedBundle
Two new methods in Address class: - add_checksum: appends a valid checksum to the Address object. - remove_checksum: slices off the checksum from an Address object.
Make the response dict consistent with check_consistency. Delete 'info' key in response if 'promotable' is True.
Support adding/removing address checksums
Fine-tune is_promotable response dictionary
Add a page describing basic IOTA concepts with references to the official docs site.
docs: add `Basic Concepts` page
- complete rewerite of types.rst - Add/extend/polish docstrings for several type classes - small correction in basic_concepts.rst
…new_addresses` So far only `findTransactions` check was made in the the two methods above, this changes is needed to achieve identical behavior with the JS lib. Based on @pdecol's implementation.
docs: re-write PyOTA types page
Add `wereAddressesSpentFrom` check to used/new address discovery
- add figure depicting address generation - explain address generation algorithm - document AddressGenerator - general improvements in text
docs: improve `Generating Addresses` page
- add more documentation on adapter classes - add examples on debugging http requests to file or console - remove sandbox adapter section - restructure RoutingWrapper section
docs: improve `Adapters and Wrappers` page
- Removed auto command discovery in API class, as it was only used in tests. - Modified test cases. - Removed custom __getattr__() from API class.
Explain the inner workings of an API command for advanced users/developers of the the library.
docs: add `Advanced: PyOTA Commands` page & refactoring commands
Sandbox environment not in use anymore.
Remove SandboxAdapter
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature changes
broadcast_bundleextended API command. [broadcast_bundle command to match JS lib #246]is_promotableextended API command. [Makeis_promotablehelper function a proper extended API command #251]traverse_bundleextended API command. [Refactortraverse_bundlemethod into an extended API command #252]add_signature_or_messagemethod forProposedBundleclass. [Implementadd_signature_or_messagemethod on ProposedBundle #253]add_checksumandremove_checksummethods forAddressclass. [RefactorAddressmethods #254]Seedin top leveliotapackage.were_addresses_spent_fromcheck toiter_used_addressesandget_new_addresses. [Snapshot proof commands #244]commands. [docs: addAdvanced: PyOTA Commandspage & refactoring #275]SandboxAdapter. [DeprecateSandboxAdapter#273]Documentation changes [#268]
autodocsupport for Sphinx.Basic Conceptspage to docs.PyOTA Typespage.Generating Addressespage, add figure and more info.Adapters and Wrapperspage.PyOTA Commandspage, intended for advanced users/developers of the lib.