Skip to content

Commit d9abb32

Browse files
committed
docs(cli): update for v0.10
1 parent f87fb81 commit d9abb32

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Options:
3737
--help Show this message and exit.
3838

3939
Commands:
40+
backup Database dump and restore commands
4041
catch-up Let the DB catch up with the data sources
4142
load Load data from their original sources
4243
schema Database schema migration commands
@@ -104,6 +105,7 @@ Options:
104105
Commands:
105106
associations Load associations into the DB
106107
distribution-txs Load distribution outflows into the DB
108+
impact-projects Load impact projects into the DB
107109
minted-blocks Load minted blocks into the DB
108110
retirements Load retirements into the DB
109111
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
182184

183185
```python
184186
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',
193195
) -> pd.DataFrame
194196
```
195197

@@ -216,24 +218,26 @@ The Python API is located at `sc_audit.views.retirement` and returns the retirem
216218

217219
```python
218220
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',
226228
) -> pd.DataFrame
227229
```
228230

229231
### Configuration
230232

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.
232234

233-
| env variable | description |
234-
|------------------|---------------------------|
235-
| `SC_DBAPI_URL` | default: `sqlite+pysqlite:///{get_default_db_path()}`<br>The default value places an SQLite DB file in the working dir or in 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. |
235+
| env variable | description |
236+
|----------------------|---------------------------|
237+
| `SC_DBAPI_URL` | default: `sqlite+pysqlite:///{get_default_db_path()}`<br>The default value places an SQLite DB file in the working dir or in 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. |
237241

238242
## Development
239243

0 commit comments

Comments
 (0)