data: add Account & Wallet sur, data model doc

Author: tomholford

desk/sur/account.hoon

@@ -0,0 +1,37 @@
+::  /sur/account.hoon
+|%
+::  Account ID - uuid string used for edit, del, query (not an ETH 0x...)
++$  id  @t
+::  Wallet ID - foreign key to parent wallet
++$  wallet-id  @t
+::  Account Name
++$  name  @t
+::  Note - optional description of the account
++$  note  @t
+::  TODO: tags, types
++$  account
+  $:  id=id
+      wallet-id=wallet-id
+      name=name
+      note=note
+  ==
+::  Accounts - map of account-id to account
++$  accounts  (map id account)
+++  action
+  =<
+  |%
+  +$  action
+    $%  [%add add]
+        [%del del]
+        [%edit edit]
+    ==
+  +$  add [=id =wallet-id =name =note]
+  +$  del [=id]
+  +$  edit [=id =wallet-id =name =note]
+  --
++$  update
+  $%  [%add =account]
+      [%del =id]
+      [%edit =account]
+  ==
+--

desk/sur/wallet.hoon

@@ -0,0 +1,34 @@
+::  /sur/wallet.hoon
+|%
+::  Wallet ID - uuid string used for edit, del, query (not an ETH 0x...)
++$  id  @t
+::  Wallet Name
++$  name  @t
+::  Note - optional description of the wallet
++$  note  @t
+::  TODO: tags, types
++$  wallet
+  $:  id=id
+      name=name
+      note=note
+  ==
+::  Wallets - map of wallet ids to wallets
++$  wallets  (map id wallet)
+++  action
+  =<  action
+  |%
+  +$  action
+    $%  [%add add]
+        [%del del]
+        [%edit edit]
+    ==
+  +$  add [=id =name =note]
+  +$  del [=id]
+  +$  edit [=id =name =note]
+  --
++$  update
+  $%  [%add =wallet]
+      [%del =id]
+      [%edit =wallet]
+  ==
+--

notes/data.md

@@ -0,0 +1,60 @@
+# Data Model
+
+## Wallets
+
+A wallet is a collection of accounts.
+
+```hoon
+::  Wallet ID - uuid string used for edit, del, query (not an ETH 0x...)
++$  id  @t
+::  Wallet Name
++$  name  @t
+::  Note - optional description of the wallet
++$  note  @t
+::  TODO: tags, types
+```
+
+## Accounts
+
+An account is a collection of transactions.
+
+```hoon
+::  Account ID - uuid string used for edit, del, query (not an ETH 0x...)
++$  id  @t
+::  Wallet ID - foreign key to parent wallet
++$  wallet-id  @t
+::  Account Name
++$  name  @t
+::  Note - optional description of the account
++$  note  @t
+::  TODO: tags, types
+```
+
+## Transactions
+
+A transaction is a credit or debit to an account.
+
+```hoon
+::  Transaction ID - uuid string used for edit, del, query (not an ETH 0x...)
++$  id  @t
+::  CoinGecko Coin ID - external ID that maps to a CG entity (e.g. BTC is 'bitcoin').
+::  Used for querying CG API
++$  coin-id  @t
+::  Timestamp of transaction
++$  date  @da
+::  Optional description of the TX
++$  note  @t
+::  TX Amount in currency
+::  Note usage of a string for storage; since no maths will be done in the app
+::  (for now!), it is simpler for a noob like me to work with. Eventually this 
+::  will be migrated to using an aura with numerical precision
++$  amount  @t
+::  optional: cost per unit at the time of the TX (can be roughly auto-populated
+::  with CoinGecko History API async, or manually entered by user... or if
+::  imported from a CEX, use that value). see note re: string usage for amount,
+::  same goes for this
++$  cost-basis  @t
+::  %buy, %sell
++$  type  @ta
+::  TODO: tags
+```