-
Notifications
You must be signed in to change notification settings - Fork 375
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: bootstrap a glossary, with p/ and r/
Signed-off-by: Manfred Touron <94029+moul@users.noreply.github.com>
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Glossary | ||
|
||
<!-- TODO: generate TOC --> | ||
|
||
## `p/` - "Pure" packages | ||
|
||
A `p/` package denotes a "pure" package within the system. These packages are | ||
crafted as self-contained units of code, capable of being independently imported | ||
and utilized. | ||
|
||
Unlike `r/` realms, `p/` packages do not possess states or assets. They are | ||
designed specifically to be called by other packages, whether those packages are | ||
pure or realms. | ||
|
||
## `r/` - "Realm" packages | ||
|
||
An `r/` realm designates a package endowed with advanced capabilities, referred | ||
to as a "realm". | ||
|
||
Realms can accommodate a diverse array of data and functionalities, including | ||
Bank State, Data State, and Address. | ||
|
||
They are purposed to furnish and expose features for both user-initiated calls | ||
and as components invoked by other realm packages. |