@@ -95,6 +95,13 @@ by doing a few test transactions in testnet.
95
95
set ` coldcard --rpc <url> ` if desired.
96
96
97
97
98
+ ### Development
99
+
100
+ Run tests and linting locally with ` make test ` and ` make lint ` . It's advisable to do
101
+ this before filing a PR, otherwise CI will likely fail due to [ ` black ` formatting
102
+ requirements] ( https://github.com/psf/black ) .
103
+
104
+
98
105
## Design
99
106
100
107
### Zero install process
@@ -143,37 +150,7 @@ supported, but I'm happy to add others that fit the criteria of
143
150
144
151
### Auditing
145
152
146
- The final script, ` coldcore ` , is dumbly compiled from the contents of ` src/coldcore/ `
147
- for convenience during development (per ` ./bin/compile ` ).
148
-
149
- If you want to read through, I recommend starting with the ` src/coldcore ` tree.
150
-
151
- ```
152
- .
153
- ├── bin
154
- │ ├── compile # generates final `coldcore` script
155
- │ └── sign_release
156
- ├── coldcore
157
- ├── sigs # signatures for verification
158
- │ └── coldcore-0.1.0-alpha.asc
159
- └── src
160
- ├── coldcore
161
- │ ├── crypto.py # a few basic cryptographic utilities
162
- │ ├── __init__.py
163
- │ ├── main.py # most logic is here; wallet ops, CLI, models
164
- │ ├── test_coldcard.py
165
- │ ├── test_crypto.py
166
- │ ├── thirdparty
167
- │ │ ├── bitcoin_rpc.py # taken from python-bitcoinlib
168
- │ │ ├── clii.py # taken from jamesob/clii
169
- │ │ ├── __init__.py
170
- │ │ └── py.typed
171
- │ └── ui.py # presentation logic, curses
172
- ├── requirements-dev.txt
173
- └── setup.py # for development use only
174
- ```
175
-
176
-
153
+ All source is contained in ` coldcore ` .
177
154
178
155
## Status
179
156
0 commit comments