You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -13,9 +21,9 @@ For higher-level conceptual explanations, as well as findings and conclusions re
13
21
Initially, we focused our work on achieving high transaction throughput, low latency, and resilience against multiple geographical datacenter outages without significant downtime or any data loss.
14
22
The design decisions we made to achieve these goals will help inform policy makers around the world about the spectrum of tradeoffs and available options for CBDC design.
15
23
16
-
# Important News
24
+
# News
17
25
18
-
**NOTE:** In cases where there are significant changes to the repository that might need manual intervention down-stream (or other important updates), we will [make a NEWS post](NEWS.md).
26
+
If there are significant changes to the repository that may require manual downstream intervention (or other important updates), we will make a [NEWS post](NEWS.md).
19
27
20
28
# Architecture
21
29
We have explored several architectures under two broad categories as follows:
@@ -54,81 +62,100 @@ The architecture is composed of two layers:
54
62
- Unmodified smart contracts from the Ethereum ecosystem can be deployed directly onto our EVM implementation.
55
63
56
64
Read the [PArSEC Architecture Guide](docs/parsec_architecture.md) for more details.
57
-
# Contributing
65
+
# Contributing and Discussion
58
66
59
-
You can [sign up](https://dci.mit.edu/opencbdc-interest) to receive updates from technical working groups and to learn more about our work.
67
+
You can join the [OpenCBDC mailing list](https://dci.mit.edu/opencbdc-interest) to receive updates from technical working groups and learn more about our work.
60
68
If you would like to join our technical discussions and help workshop proposals, you can join our [Zulip chat](https://opencbdc.zulipchat.com/register/).
61
69
62
70
For more information on how to contribute, please see our [Contribution Guide](docs/contributing.md)!
63
71
64
72
If you want to dive straight in, take a look at our issue tracker's list of [good first issues](https://github.com/mit-dci/opencbdc-tx/labels/difficulty%2F01-good-first-issue).
65
73
66
-
# Get the Code
74
+
# Setup
75
+
76
+
If you would like to install OpenCBDC and run it on your local machine, follow the steps below:
Use these directions if you want to build the source on your machine.
75
-
If you just want to run the system, see "Run the Code" below.
87
+
## Setup the build environment
88
+
89
+
Use these directions if you would like to build the source code on your machine.
90
+
Alternatively, if you just want to run the system, skip to the [Run the Code](#run-the-code) section below.
91
+
92
+
1. Setup the build-environment
76
93
77
-
1. Setup the build-environment.
78
94
Note that this script is just a convenience to install system-wide dependencies we expect.
79
95
As a result, it uses the system package manager, requires `sudo`, and should only be run **once**.
80
96
```console
81
97
# ./scripts/install-build-tools.sh
82
98
```
83
99
1. Setup project dependencies
84
-
This script builds and installs a local copy of several build-dependencies which are not widely packaged.
85
-
Because it installs to a local, configurable prefix (defaulting to `./prefix`), it does not need root permissions to run.
86
-
Furthermore, it should always be safe to delete `prefix` and rerun this script.
100
+
101
+
This script builds and installs a local copy of several build-dependencies that are not widely packaged.
102
+
Because the installation is done in a user-specific location (`./prefix` by default) rather than a system-wide one, you do not need root permission to run the script.
103
+
Additionally, if you want to remove the installed build-dependencies or restart the installation process, you can safely delete the `prefix` directory and rerun this script.
87
104
```console
88
105
$ ./scripts/setup-dependencies.sh
89
106
```
90
-
1. Run the build
107
+
1. Run the build script
91
108
```console
92
109
$ ./scripts/build.sh
93
110
```
94
111
95
-
## macOS
96
-
Note that if you have not already installed the xcode cli tools you will need to:
112
+
###macOS
113
+
Note: If you have not already installed the Xcode CLI tools, you will need to do so:
97
114
98
115
```console
99
116
# xcode-select --install
100
117
```
101
-
# Run the Code
118
+
# Documentation
102
119
103
-
The API Reference is now housed in [an external repository](https://github.com/mit-dci/opencbdc-tx-pages/).
104
-
See the [live deployment](https://mit-dci.github.io/opencbdc-tx-pages/) to browse.
120
+
Github Pages hosts the official copy of the OpenCBDC [API Reference](https://mit-dci.github.io/opencbdc-tx-pages/).
105
121
106
-
## UHS-based Architectures (2PC & Atomizer)
122
+
This reference is housed in [an external repository](https://github.com/mit-dci/opencbdc-tx-pages/).
123
+
124
+
## Running the Code
125
+
126
+
### UHS-based Architectures (2PC & Atomizer)
107
127
See the [2PC & Atomizer User Guide](docs/2pc_atomizer_user_guide.md)
108
-
## PArSEC Architecture
128
+
###PArSEC Architecture
109
129
See the [PArSEC User Guide](docs/parsec_user_guide.md)
130
+
110
131
# Testing
111
132
112
-
Running Unit & Integration Tests
133
+
Users can verify the setup by running both unit/integration and end-to-end tests on OpenCBDC.
134
+
135
+
## Unit and Integration Tests
136
+
137
+
### Running the tests:
138
+
139
+
1. Build all Docker images
113
140
114
-
1. Build all docker images
115
141
```console
116
142
$ ./scripts/build-docker.sh
117
143
```
118
-
1. Run Unit & Integration Tests
144
+
1. Run Unit and Integration Tests
145
+
119
146
```console
120
147
$ docker run -ti opencbdc-tx-builder ./scripts/test.sh
0 commit comments