Skip to content

Commit

Permalink
docs: bootstrap a glossary, with p/ and r/
Browse files Browse the repository at this point in the history
Signed-off-by: Manfred Touron <94029+moul@users.noreply.github.com>
  • Loading branch information
moul committed Aug 10, 2023
1 parent ffe18b0 commit 2084d66
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/glossary.md
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.

0 comments on commit 2084d66

Please sign in to comment.