Add an experimental command for importing and exporting collections of contracts #472
Conversation
There was a problem hiding this comment.
Code looks in general good -- but of course i couldn't resist giving some 5c comments ;-) --. Didn't run it though to check whether everything works as intened. Would be nice to have an executable test case (which would also serve as an example)? Also seems the text from the issue #471 could be useful to add (more or less as-is?) as documentation, in particular as such collection file would be external file-formats?
Agreed. Not sure where to put it and wanted to make sure it was kept somewhere |
| @@ -7,6 +7,7 @@ | |||
| ./pdo/client/builder/shell.py | |||
| ./pdo/client/builder/state.py | |||
| ./pdo/client/commands/__init__.py | |||
| ./pdo/client/commands/collection.py | |||
There was a problem hiding this comment.
How about updating scripts/Entrypoint.py and setup.py ? (for the 'do_collection' command)
There was a problem hiding this comment.
good suggestion. will do
| save_files = [] | ||
| for k, v in context.items() : | ||
| if k == 'save_file' : | ||
| save_files.append(v) |
There was a problem hiding this comment.
Here you are making assumptions about the schema of the context file (by looking for key word 'save_file'). My concern is that the pdo repo AFAIK, does not have any examples of context files. The context files are only introduced in the pdo contracts repo (may be I am wrong?). If this is the case, makes me wonder why we wouldn't maintain some of the client/commands (such as collection, and even context.py) as part of the pdo/contacts repo? Thanks!
There was a problem hiding this comment.
This is pretty well documented in the issue so i don't feel a particular need for examples. There is a need for a more thorough test that involves multiple users with completely distinct key sets. We do not currently have the infrastructure to do that. I would suggest that the right way to address this is to add an issue on multi user tests.
There was a problem hiding this comment.
Suggestion: include the (nice!!) description in #471 as an md file in the client folder.
In fact, this PR adds an experimental support for collections, and #471 nicely describes such support, rather than an issue. The issue could instead be a list of enhancements that need discussion and/or implementation.
…f contracts Often a contract is meaningful only in the context of other contracts. For example, an asset issuer contract object may depend upon an asset type contract object. The type object is necessary to establish trust in the scope of the asset being issued. In order to simplify sharing, a contract collection file packages information about a collection of contracts and their relationship to each other into a single bundle. The file that is created includes a context file that describes the relationships between the contracts and a list of contract description files that can be used to operate on the contract objects. Signed-off-by: Mic Bowman <[email protected]>
Added documentation (client/docs/collection.md). Added entrypoint for a collection command. Updated types. Signed-off-by: Mic Bowman <[email protected]>
cmickeyb
force-pushed
the
mic.feb20.collections
branch
from
1e3aa47 to
903ec71
Compare
Often a contract is meaningful only in the context of other contracts. For example, an asset issuer contract object may depend upon an asset type contract object. The type object is necessary to establish trust in the scope of the asset being issued.
In order to simplify sharing, a contract collection file packages information about a collection of contracts and their relationship to each other into a single bundle. The file that is created includes a context file that describes the relationships between the contracts and a list of contract description files that can be used to operate on the contract objects.
Note: collection operations are marked as experimental. Any use will generate a warning message when logging is turned on.
Details of the proposed functionality are found in Issue #471.