opencbdc-ui

This repository contains an example web-browser-based wallet for a hypothetical CBDC. In particular, it demonstrates how you might leave key-custody with the user, but enable a service or intermediary to support storing all other information necessary for spending funds (namely, the UTXOs). This separation might allow for easy migration between intermediaries, allows users to remain in-control of the funds at all times (by maintaining sole control of the keys), and could enable interesting intermediated use-cases.

In its current form, this wallet does not support importing UTXOs or sending mint transactions, so while it can be configured to directly connect to an instance of opencbdc-tx, it cannot currently send transactions which will be accepted and processed. (See Issue #2 for more information.) It is purely a demonstration and proof-of-concept; much more functionality could be added (and likely should/would be for a production-grade system), and none of the functionality demonstrated necessarily needs to work as it does now.

Getting Started

Install node. N.B.: You should install the latest v16 version; you may run into errors trying to use more recent versions. A .nvmrc is provided in the repository if you use nvm

• Clone the code

  $ git clone "https://github.com/mit-dci/opencbdc-ui.git"

• Install the necessary dependencies

  $ npm install

• Browserify the backing javascript module

  $ npm run preprocess

• Run the development server (compiles and hot-reloads)

  $ npm run serve

• Build with minification

  $ npm run build

• Run the linter before you commit any changes

  $ npm run lint

• Install the dependencies for the REST server

  $ cd server
  $ npm install

• Run the REST server

  $ node server/main.js

Contributing

Patches are welcome! Please see the OpenCBDC contribution guide for more information!

Customize configuration

See Configuration Reference.

Runing in Docker

• docker-compose up --build
• Mint an initial mock output by running a curl request in the terminal

  $ curl -X POST http://localhost:3000/api/v1/mintTx 

• To send money back and forth between two different wallets, open up two wallets in two different tabs at http://localhost:8080
• Fund each wallet, then you can send money between them (copy and paste the address from one to the other)

Running outside docker

Setup postgresql (to store UTXOs)

1. Install and run postgresql.
2. Run psql postgres, and setup the needed user and database:

   CREATE USER wallet_admin WITH SUPERUSER CREATEROLE CREATEDB;
   CREATE DATABASE wallet_dev;
   exit

3. Reopen the postgresql repl using the newly created user and database:

   $ psql -d wallet_dev -U wallet_admin

4. Run psql postgres, and setup the outputs table:

   CREATE TABLE IF NOT EXISTS outputs (
     output_id            TEXT       UNIQUE NOT NULL,
     created_txid         TEXT       NOT NULL,
     created_timestamp    TIMESTAMP  NOT NULL DEFAULT now(),
     owner_pubkey         TEXT       NOT NULL,
     amount               INT        NOT NULL,
     index                INT        NOT NULL,
     witness_commitment   TEXT       NOT NULL,
     spend_txid           TEXT
   );

5. Double-check the table was created as-expected:

   \dt+

   You should see the newly-created table called outputs.
6. Exit the psql repl:

   exit

Now, you have a proper user, database, and outputs table configured.

Startup the wallet

• Uncomment src/components/Dashboard.vue:62 and comment-out the following line.
• Install the dependencies, run the preprocessor, and run the development server:

  $ npm install
  $ npm run preprocess
  $ npm run serve

• Install the dependencies for the REST server, and run it:

  $ cd server
  $ npm install
  $ cd ..
  $ node server/main.js

You now have a functional, local wallet and backend!

• Mint an initial mock output by running a curl request in the terminal:

  $ curl -X POST http://localhost:3000/api/v1/mintTx 

• To send money back and forth between two different wallets, open up two wallets in two different tabs at http://localhost:8080
• Fund each wallet, then you can send money between them (copy and paste the address from one to the other)