Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hello World contract family #63

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

cmickeyb
Copy link
Contributor

@cmickeyb cmickeyb commented Sep 25, 2024

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 #62.

Split out the "contracts" module from the exchange contract and put it
into a new "common" contract family. While strictly speaking, this is
not a contract family, the build processes incorporat module creation
very easily. In addition, this provides a framework for adding common
functionality (like wrappers for tests, shared methods, etc).

Signed-off-by: Mic Bowman <[email protected]>
The widget and management notebooks are part of the common
contract family. Move the notebooks out of the root directory
and put them into the common directory.

Update references to the notebooks.

Signed-off-by: Mic Bowman <[email protected]>
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]>
Adds a simple, getting started target for building and
running the example contract.

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]>
@cmickeyb
Copy link
Contributor Author

cmickeyb commented Oct 2, 2024

#64 should be committed first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant