Skip to content

Commit

Permalink
Merge pull request #129 from celo-org/alecps/updateReadmes
Browse files Browse the repository at this point in the history
small README updates
  • Loading branch information
alecps authored Nov 1, 2023
2 parents 877e2fb + ddea08e commit da9483c
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 28 deletions.
24 changes: 0 additions & 24 deletions apps/combiner/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,3 @@
# ODIS Combiner

Orchestrates distributed BLS threshold signing with the set of ODIS signers.

## DB Migrations

### Add migration file

To update the combiner DB schema, first run `yarn db:migrate:make <migration_name>` to create a new migrations file. Then, fill in the new migration file as needed using the previous migration files as references.

### Whitelist your IP address

Go to [https://console.cloud.google.com/sql/instances?authuser=1&folder=&organizationId=&project=celo-phone-number-privacy] and navigate to the desired workspace and db instance. Then, add your IP address under `Connections -> Authorized networks`.

Remember to remove your IP address from the whitelist when finished.

### Add db credentials to config.ts

Run the command `yarn config:get:<network>` to fetch the necessary db credentials and add them to `src/config.ts` under the `DEV_MODE` section. DO NOT COMMIT THESE CREDENTIALS TO GITHUB.

Note: When you fill in the `host` field you may need to use the database's public IP, which can be found in the `Overview` section under the link above.

### Run migrations

Always run migrations in staging first and ensure all e2e tests pass before migrating in alfajores and mainnet.

Run `yarn db:migrate:<network>`
6 changes: 3 additions & 3 deletions apps/signer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

A service that generates unique partial signatures for blinded messages. Using a threshold BLS signature scheme, when K/N signatures are combined, a deterministic signature is obtained.

## APIs (ODIS v2)
## APIs

ODIS v2 provides support for three APIs, which need to be explicitly enabled ([see below](#enabling-apis-odis-v2) for configuration info):
ODIS provides support for three APIs, which need to be explicitly enabled ([see below](#enabling-apis) for configuration info):

- **PNP API**: retrieve signatures for blinded messages, rate-limited based on quota purchased on-chain in `OdisPayments.sol`.
- **Domains API**: retrieve signatures over domains with custom rate-limiting schemes, as defined in more detail in [CIP-40](https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0040.md).
Expand All @@ -20,7 +20,7 @@ You can use the following environment variables to configure the ODIS Signer ser
- `SERVER_SSL_KEY_PATH` - (Optional) Path to SSL .key file.
- `SERVER_SSL_CERT_PATH` - (Optional) Path to SSL .cert file.

### Enabling APIs (ODIS v2)
### Enabling APIs

Each API must be explicitly enabled by setting the following env vars to true (all are false by default):

Expand Down
2 changes: 1 addition & 1 deletion packages/identity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

@celo/identity simplifies interacting with ODIS, Celo’s lightweight identity layer based on phone numbers.

You can find an example of how to use this package to do ODIS lookups [here](https://github.com/critesjosh/register-number).
You can find examples of how to use this package to do ODIS lookups [here](https://github.com/celo-org/social-connect).

0 comments on commit da9483c

Please sign in to comment.