README.md

MyCHIPs Documentation

Copyright MyCHIPs.org; See license in root of this package

Overview

This software was designed at a high level by writing the MyCHIPs Papers published on gotchoices.org starting about the beginning of 2018. The presentation there is quite extensive, and goes into some detail including possible financial derivative products and services that could develop surrounding a functioning MyCHIPs network.

While that original vision is still useful, many implementation details have become more clear in the process of developing actual source code. So the documents here are more current and more specific to the way MyCHIPs is actually being implemented.

Furthermore, the design is constantly evolving so even these documents can get out of date from time to time. When in doubt, consult the source code and/or consult the author additional helpful information.

Contents

• Using the Software

  • Docker Test Instance
  • Native Installation
  • Connecting the Admin UI
  • Testing the Server
  • System Certificates
  • User Mobile Application
    • Visual Balance Sheet
    • User API
    • Sample Command Line Client
  • Running Simulations
    • Docker Simulation (latest)
    • Network Simulation (older)
    • Local Simulation (oldest)
    • Agent Modeling

• Learning the Software

  • Theoretical Background:
    • A Complex Problem
    • Money as Credit
    • Decentralization
    • Maintaining Discipline
  • Implementation:
    • Users and Identities
    • Tallies and Chits
    • Tally Contracts
    • The Credit Lift
    • Network Topology
    • Peer to Peer Connections
    • Peer to Peer Protocol
    • Data Formats

• Working on the Software

  • Support Libraries
  • Modifying the Database Schema
  • Testing Environment
  • Development Projects You Can Help With
  • Future Design Documents
    • Schema Upgrades
  • Older Design Documents
    • Process Dialogs
    • Pre-1.0 Protocol Design Thoughts

• Reference Material

  • Frequently Asked Questions
  • Organization of Source Tree
  • Known Issues

Other Documents

The Notes folder contains scans of original hand sketches notes, and calculations which could be helpful in understanding the implementation of the software (if they can be read).

The Project folder contains specifications for coding projects developers might want to consider working on.

Design Figures

The figures included as .odg files can be opened in LibreOffice or a compatible program and are referenced at times from the documentation files.

This file chipglass.svg:

is an early attempt at a logo for MyCHIPs that indicates its origin in the notion that [time is money](http://gotchoices.org/mychips/whychips.html).

The file [chip.svg](figures/chip.svg):

is a first take at a typographical “chip sign” analogous to the “dollar sign” to indicate units of CHIPs. It can easily be hand written by making a “figure 8” with two vertical lines through. Alternately, one can write a “backwards 3” (or curly “E”) followed by a closely placed “3” (to approximate an hourglass) and then add the two vertical lines.

The file [MyCHIPs-logo.ai](figures/MyCHIPs-logo.ai):

contains a more stylized logo and monochrome typographical figure.

The intent of this is to make a standard international symbol for a more objective measure of value based on the essence of human time, and independent of the economic forces (such as supply and demand) that tend to change the price of human work in various economies. Admittedly, the MyCHIPs definition of value is still not entirely objective. However, it is much more objective than the modern definition of a Dollar, a Euro, or any other fiat currency.