This repository has been archived by the owner on Apr 17, 2019. It is now read-only.
Add platform independent Python lib and Batch example #1761
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
Signed-off-by: Igor Egorov <[email protected]>
igor-egorov
added
needs-review
lebdron
approved these changes
Oct 5, 2018
example/python/irohalib.py
Outdated
|
|
||
| class Iroha(object): | ||
| """ | ||
| Collection of fabric methods for transactions and queries creation |
example/python/irohalib.py
Outdated
| def transaction(self, commands, quorum=1, creator_account=None, created_time=None): | ||
| """ | ||
| Creates a protobuf transaction with specified set of entities | ||
| :param commands: list of commands generated via command fabric method |
example/python/irohalib.py
Outdated
| """ | ||
| Creates a protobuf transaction with specified set of entities | ||
| :param commands: list of commands generated via command fabric method | ||
| :param quorum: required amount of signatures, 1 is default |
There was a problem hiding this comment.
amount -> number, because signature is a countable noun
| def command(name, **kwargs): | ||
| """ | ||
| Creates a protobuf command to be inserted into a transaction | ||
| :param name: CamelCased name of command |
There was a problem hiding this comment.
Make these consistent in command and query please, CamelCased or CamelCase
| """ | ||
| Send a transaction to Iroha | ||
| :param transaction: protobuf Transaction | ||
| :return: None |
There was a problem hiding this comment.
It might be useful to return gRPC status to check whether the transaction was successfully sent. Same for other methods
example/python/irohalib.py
Outdated
| :param transaction: protobuf Transaction | ||
| :return: None | ||
| """ | ||
| channel = grpc.insecure_channel(self.address) |
There was a problem hiding this comment.
It looks like channel and stub can be made class fields
| 'TransferAsset', src_account_id='bob@test', dest_account_id='alice@test', asset_id='dogecoin#test', | ||
| amount='2' | ||
| )], | ||
| creator_account='bob@test' |
There was a problem hiding this comment.
Maybe leave a comment to clarify that alice does not know about bob's quorum.
Signed-off-by: Igor Egorov <[email protected]>
l4l
previously requested changes
Oct 8, 2018
example/python/batch-example.py
Outdated
| creator_account='bob@test' | ||
| # we intentionally omit here bob's quorum, since alice is the originator of the exchange and in general case | ||
| # alice does not know bob's quorum. | ||
| # bob knowing onw quorum in case of accept should sign the tx using all the number of missing keys at once |
example/python/irohalib.md
Outdated
| @@ -0,0 +1,30 @@ | |||
| # Python Iroha Lib Description | |||
|
|
|||
| irohalib.py is a possible implemetation of a platform-independent way of interaction with Iroha network via Python 3. | |||
There was a problem hiding this comment.
Possible is ok here and perfectly reflects the initial intention.
Thanks for commenting anyway - I have found a type in "implementation" word!
| :return: a proto command | ||
|
|
||
| Usage example: | ||
| cmd = Iroha.command('CreateDomain', domain_id='test', default_role='user') |
Signed-off-by: Igor Egorov <[email protected]>
added 2 commits
October 15, 2018 12:31
Signed-off-by: Igor Egorov <[email protected]>
…amples Signed-off-by: Igor Egorov <[email protected]>
l4l
approved these changes
Oct 15, 2018
Signed-off-by: Kitsu <[email protected]>
|
CI fail was caused by a separate bug that is fixed in hyperledger-iroha/iroha#1793 |
bakhtin
pushed a commit
that referenced
this pull request
Nov 2, 2018
* Add platform independent Python Iroha Lib and batch example Signed-off-by: Igor Egorov <[email protected]> Signed-off-by: Kitsu <[email protected]>
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.
Signed-off-by: Igor Egorov [email protected]
Description of the Change
Introduced SWIG-free Iroha lib for Python.
Batches usage example included.
Benefits
A little step towards user-friendly Iroha.
Possible Drawbacks
None ?
Usage Examples or Tests
Read irohalib.md and do the preparation steps
Run
python3 batch-example.py