SLATE (Simple Ledger Application: a Temporary Expedient)
This is an extremely simple Flask application to support nested
open money payment
networks, each able to support multiple currencies.
This is a temporary system to allow networks/islands to form while
NESTS is still being developed (its
specification being still somewhat fluid at this stage). For this reason, the
names used to identify entities (agents and currencies) in
SLATE are compatible 1 with those of the
fully-nested (and much more capable) NESTS software.
Entity categories
There are five categories of entity:
- namespaces (a.k.a. network or island) in
which names of all entities (including other
namespaces) are contained.
- primary identities (primds - which anchor
an agent both within a namespace and to the real
world).
- secondary identities (secids - aliases of
primids - which can anchor that same agent within
any number of namespaces).
- currencies (limited to scalar values of type
money, in contrast to those supported by NESTS) - a set
of accounts.
- accounts(variables) each of which is a member of
one currency (set).
Agent categories
There are four categories of agent:
- A general agent - the set to which all
primidsand secids belong.
- A namespace's steward, a primid
assigned this role either by another primid already
holding it or by a global system administrator.
- A currency's steward, a primid
assigned this role either by another primid already
holding it or by a global system administrator.
- A global system administrator, assigned this role at setup or by
an existing global system administrator.
Internal representation
For convenience, each entity (namespace,
primid, secid, currency or
account) is identified internally by a unique number
(its FPH) serving (among other things) as the primary key in an
SQLite table. (NB, these numbers are fully compatible with the
FPH () used in NESTS.
These global mappings are:
- namespace:
namespace_hrns → namespace_fph
- namespace:
namespace_fph → namespace_hrns
- currency:
currency_hrns → currency_fph
- currency:
currency_fph → currency_hrns
- primid:
primid_hrns → primid_fph
- agent:
primid_fph → primid_hrns
- agent:
secid_hrns → secid_fph
- agent:
secid_fph → secid_hrns
- account:
account_hrns → account_fph
- account:
account_fph → account_hrns
As in NESTS, each entity (namespace,
currency, primid, secid or
account) is identified by a human-readable name string (HRNS)
placing it within a namespace.
Each namespace contains the names of
namespaces, currencies,
primds and secids and, as in NESTS,
the names of accounts may be contained within any
namespace (subject to authorization by its stewards.
This provides a sufficient entry point into a network fully compatible with
open money]
(although notably lacking provision for the construction of the rich
governance system that NESTS is intended to support).
The compatibility of the entity names (HRNS) and their equivalent
FPH, will be sufficient to enable convenient and complete migration from
SLATE to NESTS in due course.
Ledger files
Currency journal
Each currency has an associated journal in which all
payments are recorded, listing
- the payer account
- the payee account
- the amount
- an (optional) annotation (if specified by the payer)
The currency's journal can be exported at any time (either
as a CSV files or as a pretty-printed table) by one of its stewards or
by a global system administrator.
Agents' ledgers
Each account has an associated journal in which all
payments and receipts are recorded.
Each primd or secid (agent) has
access to at least one account (generally more), and a
separate ledger for each of these. The accounts' ledgers list
all transaction (payments and receipts). These ledgers each
comprise fields listing
- the name of the other account (whether a payer or
a payee)
- the amount paid or received (+ or -)
- the balance following this payment
- an annotation (if specified by the payer)
For each payment made
- the payer's balance in this currency is reduced by
amount
- the payee's balance in this currency is increased
by amount
- the payment is recorded in the this currency's
journal
Each primd or secid (agent) can
export its own accounts' ledgers, each
account being in a distinct currency.
The agent interface
The SLATE screens form a subset those used in NESTS, with
minimal, if any, modification.
Primid screens
- Registration
Once registered, the primidhas access to an
account in every currency for which it
has been authorized (by the stewards of both the
currency and the namespace in which it is
anchored (a matter of policy).
- namespace (selected from a drop-down list)
- primid name (entered in a text box)
- real name (entered in a text box) (optional)
- email address(es) (entered in a text box)
- password (entered in a text box)
- PIN (entered in a text box)
- Login recovery
A recovery link is sent by email.2
- email address or agent name (entered in a
text box)
- Payment
Each payment is recorded in the currency's
journal and in the ledgers of both payer and payee.
- payee identifier
- amount
- parallel amount paid in national currency (optional)
- currency (selected from drop-down list)
- annotation (optional)
- home screen
This is the screen displayed upon logging in, displaying
- balance in each currency
- links to
- transaction history in each currency
- export link for the ledger in each
currency
- a link to the parabola plots for each
currency
- a primid/secid update screen
- primid update screen allowing changes to
- agent name (entered in a text box)
- real name (entered in a text box) (optional)
- email address (entered in a text box)
- password (entered in a text box)
- PIN (entered in a text box)
This screen can be reached either when already logged in or via a
password reset received by email.
Secid screens
These are accessible only by the primidto which a
secid belongs. They allow the following:
- Creation of a secid (where authorized by the
stewards of the namespace in which it is to be
anchored.
- Suspension of a secid
- Re-enabling a secid
- Requesting deletion of a secid by a steward
of the namespace in which it is anchored.
Namespace stewards
When logged in, any agentregistered as a steward
of a namespace will see the following additional links in its
home screen:
- add steward
- add new currency
- confirm pending registration
- suspend primid
- re-enable primid
- suspend secid
- re-enable secid
Therefore the following additional screens are required:
- Add stewardfor this namespace
- Add currency for this namespace
- currency's name (entered in a text
box)
- currency prefix (entered in a text box)
(optional)
- currency suffix (entered in a text box)
(optional)
- initial steward name (entered in a text
box)
- Suspend primid
- primid name (entered in a text box)
- Re-enable secid
- agent name (selected from drop-down list)
- Re-enable secid
- agent name (selected from drop-down list)
Currency stewards
When logged in, any agent registered as a steward
of a currency will see the following additional links in its
home screen:
- add steward
- add new currency
- confirm pending registration
- suspend primidor secid
- re-enable primdor secid
- export journal (the record of payments)
- post a reversing transaction
Therefore the following additional screens are required:
- Add stewardfor this currency
- Suspend primid
- primid name (entered in a text box)
- Re-enable primid
- primid name (selected from drop-down list)
- Suspend secid
- secid name (entered in a text box)
- Re-enable secid
- secid name (selected from drop-down list)
- Export journal
- currency name (selected from drop-down list)
- Post reversing transaction3
- currency's name (selected from
drop-down list)
- transaction (selected from drop-down list displaying most
recent transactions in this currency).
Global administrators
When logged in, any primid registered as a global
administrator will see the following additional links in its home
screen:
- add new namespace
- add global administrator
- confirm pending registration
- suspend primid/secid
- re-enable primid/secid
- export journal (for any currency)
Therefore the following additional screens are required:
- Add new namespace
- namespace name (entered in a text box)
- Add global administrator
- primid name (entered in a text box)
- Suspend primid4
- primid name (entered in a text box)
- Re-enable primid
- primidname (selected from drop-down list of disabled
primids)
- Suspend secid5
- secid name (entered in a text box)
- Re-enable secid
- - secidname (selected from drop-down list of disabled
secids)
- Export journal
- currency name (selected from drop-down list)
- File download location (file dialogue)
Notes:
-
SLATE names are limited to UTF-8 Latin characters using only "." as
the namespace delimiter whereas NESTS names and the namespace
delimiter may be any UTF-8 character.
-
The password is not stored. Instead, a crypotographic hash of the password
is stored against which the access-recovery password entered can be
authenticated.
-
NB, this does not remove the original transaction from the journal.
Instead, it posts a reversing transaction.
-
When a primid is suspended, all of its secids
are also suspended.
-
When a secid is suspended, its secids are will
not necessarily also be suspended (although that may happen where the
stewards of the namespaces have configured such a
policy).