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
Copy file name to clipboardExpand all lines: README.md
+24-20Lines changed: 24 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,7 @@ Options:
37
37
--help Show this message and exit.
38
38
39
39
Commands:
40
+
backup Database dump and restore commands
40
41
catch-up Let the DB catch up with the data sources
41
42
load Load data from their original sources
42
43
schema Database schema migration commands
@@ -104,6 +105,7 @@ Options:
104
105
Commands:
105
106
associations Load associations into the DB
106
107
distribution-txs Load distribution outflows into the DB
108
+
impact-projects Load impact projects into the DB
107
109
minted-blocks Load minted blocks into the DB
108
110
retirements Load retirements into the DB
109
111
sinking-txs Load sinking transactions into the DB
@@ -182,14 +184,14 @@ The Python API is located at `sc_audit.views.sink_status` and returns the sinkin
182
184
183
185
```python
184
186
def view_sinking_txs(
185
-
for_funder: str|None=None,
186
-
for_recipient: str|None=None,
187
-
from_date: dt.date |None=None,
188
-
before_date: dt.date |None=None,
189
-
finalized: bool|None=None,
190
-
cursor: int|None=None,
191
-
limit: int|None=None,
192
-
order: Literal['asc', 'desc'] ='desc',
187
+
for_funder: str|None=None,
188
+
for_recipient: str|None=None,
189
+
from_date: dt.date |None=None,
190
+
before_date: dt.date |None=None,
191
+
finalized: bool|None=None,
192
+
cursor: int|None=None,
193
+
limit: int|None=None,
194
+
order: Literal['asc', 'desc'] ='desc',
193
195
) -> pd.DataFrame
194
196
```
195
197
@@ -216,24 +218,26 @@ The Python API is located at `sc_audit.views.retirement` and returns the retirem
216
218
217
219
```python
218
220
def view_retirements(
219
-
for_beneficiary: str|None=None,
220
-
from_date: dt.date |None=None,
221
-
before_date: dt.date |None=None,
222
-
project: int|None=None,
223
-
cursor: int|None=None,
224
-
limit: int|None=None,
225
-
order: Literal['asc', 'desc'] ='desc',
221
+
for_beneficiary: str|None=None,
222
+
from_date: dt.date |None=None,
223
+
before_date: dt.date |None=None,
224
+
project: int|None=None,
225
+
cursor: int|None=None,
226
+
limit: int|None=None,
227
+
order: Literal['asc', 'desc'] ='desc',
226
228
) -> pd.DataFrame
227
229
```
228
230
229
231
### Configuration
230
232
231
-
There isn't much to configure in sc-audit. Two variables can be overriden by environment variables.
233
+
There isn't much to configure in sc-audit. Several settings can be overriden by environment variables.
232
234
233
-
| env variable | description |
234
-
|------------------|---------------------------|
235
-
|`SC_DBAPI_URL`| default: `sqlite+pysqlite:///{get_default_db_path()}`<br>The default value places an SQLite DBfilein the working dirorin a subdir of the home dir. |
236
-
|`SC_HORIZON_URL`| default: `https://horizon.stellar.org`<br>Set this value to a Horizon instance with full history to be able to do a fresh load. |
|`SC_DBAPI_URL`| default: `sqlite+pysqlite:///{get_default_db_path()}`<br>The default value places an SQLite DBfilein the working dirorin a subdir of the home dir. |
238
+
|`SC_HORIZON_URL`| default: `https://horizon.stellar.org`<br>Set this value to a Horizon instance with full history to be able to do a fresh load. |
239
+
|`SC_MERCURY_KEY`| Provide a Mercury key generated from your own account (persistent; not the JWT) |
240
+
|`SC_RETROSHADES_MD5`| default: latest `SinkContract`<br>You'll need to do your own Mercury deployment, and check if the WASM MD5 hash is the same as the default value here. |
0 commit comments