Update TransactionDatasets.md

TransactionDatasets.md

@@ -8,17 +8,27 @@ As well as user generated data and field surveys collected in Kenya. Fields desc
 Datasets Starting 2020 are pulled from the xDAI blockchain for each user ex. https://blockscout.com/poa/core/address/0xcb55fc893000a984a5ad73011f93d1540a5f0895/tokens
 As well as user generated data and field surveys collected in Kenya. Fields described below.
 
-Brief description: Using a simple feature phone interface with USSD each user (people living below the poverty line in Kenya) starts with an allottment of initial tokens and adverstises what they sell to neighbors and on a digital market place avalaible on the same interface (USSD). There are no transaction fees. The tokens are used often as a top-up to missing Kenyan shillings. Pre 2020 - each user only has one token assigned to them by GE based on where they live. Post 2020 all users moved to the Sarafu token while we prepare for user generated tokens again. Pre 2020 with multiple tokens - When a user sends a token to another user that holds a different token a conversion is made automatically after receipt. This conversion uses a bonding curve (based on the Bancor Protocol) to adjust the token prices relative to eachother. Conversions can be seen as transactions to a contract address then that contract address sending the new token to the user. In 2020 the Sarafu token which all users held is considered ~1:1 with the national currency. For more information please contact us https://www.grassrootseconomics.org/contact
+**Brief description:** 
+Using a simple feature phone interface with USSD each user (people living below the poverty line in Kenya) starts with an allottment of initial tokens and adverstises what they sell to neighbors and on a digital market place avalaible on the same interface (USSD). There are no transaction fees. The tokens are used often as a top-up to missing Kenyan shillings.   <br />
+**Pre 2020** - each user only has one token assigned to them by GE based on where they live.   <br />
+**Post 2020** - all users moved to the Sarafu token while we prepare for user generated tokens again.   <br /> 
+**Pre 2020 with multiple tokens** - When a user sends a token to another user that holds a different token a conversion is made automatically after receipt. This conversion uses a bonding curve (based on the Bancor Protocol) to adjust the token prices relative to each other. Conversions can be seen as transactions to a contract address then that contract address sending the new token to the user.   <br />
+In 2020 the Sarafu token which all users held is considered ~1:1 with the national currency.   <br />
+For more information please contact us https://www.grassrootseconomics.org/contact
 
 
 --------
 
-Post 2020 xDAI data (current)
+# Post 2020 xDAI data (current)
 The Transaction csv fields:
 
 1. id - internal transaction ID number
 1. timeset - date and time of transaction
-1. transfer_subtype - internal typing: DISBURSMENT = from Grassroots Economics Foundation, RECLAMATION = Back to GE, STANDARD =  a trade between users, AGENT = when a group account is cashing out (see held_roles) below
+1. transfer_subtype - internal typing: 
+     -  DISBURSMENT = from Grassroots Economics Foundation, 
+     -  RECLAMATION = Back to GE, 
+     -  STANDARD =  a trade between users, 
+     -  AGENT = when a group account is cashing out (see held_roles) below
 1. source - wallet ID of sender 
 1. target - wallet ID of recipent 
 1. token_name - the token that was traded
@@ -34,9 +44,16 @@ The user summary csv fields:
 1. final_bal - current balance of Sarafu as of file date
 1. area_name - Regional area in Kenya (generalized from private user data)
 1. area_type - Rural, Peri urban or Urban (generalized from private user data)
-1. held_roles - Standard transactions are between Beneficiaries, anything to an Admin is a Reclamation or from and Admin is a Disbursment and anything to a Agent is a Agent_out
+1. held_roles - 
+    - BENEFICIARY, standard user / standard transactions
+    - GROUP_ACCOUNT, local savings and loans groups (Chamas) 
+    - ADMIN, account of Grassroots Economics staff 
+    - TOKEN_AGENT, account used to cash out tokens to Mpesa
+    - VENDOR - to be deleted
 1. gender - user input gender
 1. business_type - Input by GE staff based on what the users sell
+
+**Additional User Statistics:**
 1. ovol_in - total number of tokens that came into this account from non-STANDARD transactions
 1. ovol_out - total number of tokens that left this account from non-STANDARD transactions
 1. otxns_in - number of transactions incomming from non-STANDARD transactions
@@ -51,9 +68,9 @@ The user summary csv fields:
 1. sunique_out
 
 
-----
+-----------------------------------------------------------------------------------------
 
-Pre 2020 POA
+# Pre 2020 POA
 The Transaction csv fields:
 1. timeset - date and time of transaction
 1. tx_hash - hashed transaction on blockchain can be found on https://blockscout.com/poa/core/a
@@ -82,6 +99,8 @@ The user summary csv fields:
 1. gender
 1. business_type - Input by staff based on what they sell
 1. directory - input by user a specific item they sell
+
+**Additional User Statistics:**
 1. vol_trans_in - total number of tokens that came into this account
 1. vol_trans_out
 1. n_trans_in - number of transactions incomming