Hello World contract family #63
Open
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
cmickeyb
force-pushed
the
mic.sep17.hello_world
branch
from
92a78b1 to
bf4a82d
Compare
|
#64 should be committed first. |
cmickeyb
force-pushed
the
mic.sep17.hello_world
branch
from
bf4a82d to
768421c
Compare
There was a problem hiding this comment.
Great detailed hello world tutorial. It really helped to get an idea how to start writing my first contract family.
However, I was not able to run my helloworld contract within my personal time limit of ~45min.
Is there a dev container image that helps me to kickstart and provides me all the tools/deps needed as described in docs/install.md?
Comment on lines
+7
to
+9
| This directory contains a number of pdo-shell scripts to test the | ||
| digital asset contract family. The scripts assume that a complete | ||
| installation of the PDO client is complete. |
There was a problem hiding this comment.
You mean the example contact family I guess?!
Comment on lines
+23
to
+24
| This script sets up and runs the functional test suite for the digital asset | ||
| contract family. The actual tests will be found in the pdo-shell script |
There was a problem hiding this comment.
example contract familiy?
|
|
||
| **The protocols and software are for reference purposes only and not intended for production usage.** | ||
|
|
||
| # Example Contract Family # |
There was a problem hiding this comment.
In your PR you call it Hello World Contract Family ... maybe that is a better name than Example, in particular, if there are folders in the recommended project structure that is called example.
example-contract/README.md
Outdated
|
|
||
| 1. Copy the `example-contract` directory to a new directory. To be | ||
| picked up by the build system automatically, the new directory | ||
| should be named with `myfirst-contract`. |
There was a problem hiding this comment.
to be consistent with your PR title ... helloworld-contract maybe call is?
cmickeyb
force-pushed
the
mic.sep17.hello_world
branch
from
cff4977 to
e46de56
Compare
cmickeyb
force-pushed
the
mic.sep17.hello_world
branch
from
e46de56 to
62b1591
Compare
cmickeyb
force-pushed
the
mic.sep17.hello_world
branch
2 times, most recently
from
e6fbcda to
f18c5ca
Compare
Initial commit for the example contract family. The example contract family is primarily used as a means of documenting the process of writing, building, and extending a contract family. In addition, the example contract family provides a template for building a new contract family. Copying the example contract family to a new directory and editing family.cmake should be sufficient to create a new family. Signed-off-by: Mic Bowman <[email protected]>
Signed-off-by: Mic Bowman <[email protected]>
Adds a simple, getting started target for building and running the example contract. Add a docker target to start a contracts container that is running Jupyter. The current source directory is mounted in /project/pdo/dev inside the container. When used with the Jupyter shell, this provides a relatively easy way to develop and test contracts, specifically the example contract. Do not remove model during docker cleanup. There is no particular reason to remove the downloaded model during docker clean up. This should save some time during build/debug/test cycles. The model can be removed with the clean_model target. Signed-off-by: Mic Bowman <[email protected]>
Adds the basic factory/template model for the example contract. This should allow for, more or less, a cut and paste for creating a new contract that preserved the counter. That is, the factory & template are for the specific contract type and would have to be replaced completely for a new contract. Signed-off-by: Mic Bowman <[email protected]>
Signed-off-by: Mic Bowman <[email protected]>
Signed-off-by: Mic Bowman <[email protected]>
Signed-off-by: Mic Bowman <[email protected]>
cmickeyb
force-pushed
the
mic.sep17.hello_world
branch
from
f18c5ca to
248bd09
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Initial commit for the example contract family. The example contract family is primarily used as a means of documenting the process of writing, building, and extending a contract family. In addition, the example contract family provides a template for building a new contract family. Copying the example contract family to a new directory and editing family.cmake should be sufficient to create a new family.
Detailed documentation is provided that includes an explanation of the various parts of a contract family, how to create a new one, and how to define additional methods in a contract family. Most of this is provided as a step-by-step guide.
A functioning Jupyter notebook is also provided. However, documentation for customizing Jupyter is still work in progress.
NOTE: This PR depends on #64