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

1248 - Introducing the factory pattern #1308

Merged
merged 11 commits into from
Feb 1, 2024
Merged

Conversation

ipopescu
Copy link
Collaborator

@ipopescu ipopescu commented Oct 23, 2023

What does this PR fix/introduce?

Add initial documentation on the factory pattern for contract authors. Closes #1248

Additional context

Future work:

  • I recommend creating some diagrams as part of another task:
    • a UML diagram explaining the factory pattern on Casper (entry points being the factories)
    • a diagram explaining the keys and contexts when using the factory pattern
  • I recommend writing another step-by-step tutorial using the Casper client under (/tutorials) or (/cli) for deploying and using the counter factory contract (on the Testnet or NCTL).
  • Finally, we need to decide whether to point to the casper-node as I did here (and wait for the future 2.0 branch), or put the counter factory example in the tutorials example wasm repository.
  • FYI: I avoided saying “factory contract”, unless I had to simplify the explanations. I tried to say “factory pattern” and “factory entry point” instead.

Checklist

  • Docs are successfully building - yarn install && yarn run build.
  • For new internal links I used relative file paths (with .md extension) - e.g. ../../faq/faq-general.md - instead of introducing absolute file path, or relative/absolute URL.
  • All external links have been verified with yarn run check:externals.
  • My changes follow the Casper docs style guidelines.

Reviewers

@ACStoneCL and @mpapierski
FYI @ramujin and @ShalmaliCL

Screenshot 2023-10-23 at 18 57 08

@github-actions
Copy link

github-actions bot commented Oct 23, 2023

Copy link
Contributor

@ACStone-MTS ACStone-MTS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small nits in the interim.

@ACStone-MTS ACStone-MTS added the v2.0 Merge to feat-2.0_docs label Dec 7, 2023
@ipopescu ipopescu merged commit d924177 into feat-2.0_docs Feb 1, 2024
9 checks passed
@ipopescu ipopescu deleted the 1248_factory_contracts branch February 1, 2024 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v2.0 Merge to feat-2.0_docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants