@celo/phone-number-privacy-signer v1.0.1

Phone Number Privacy - Signer Service

A service run by distributed partners that generates unique partial signatures for phone number salts. Using a threshold BLS signature scheme, when K/N signatures are combined, a deterministic signature is obtained.

Configuration

You can use the following environment variables to configure the Phone Number Privacy - Signer service:

• NODE_ENV - eg. development or production
• SERVER_PORT - The port on which the express node app runs (8080 by default).
• BLOCKCHAIN_PROVIDER - The blockchain node provider for on chain requests. This could be a node with RPC set up. For development testing you can use https://alfajores-forno.celo-testnet.org
• DB_HOST - The URL under which your database is accessible. Supports Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle.
• DB_USERNAME - DB configuration: The DB username (postgres by default).
• DB_PASSWORD - DB configuration: The DB password.
• DB_DATABASE DB configuration: The DB database name (phoneNumberPrivacy by default).

Currently, the service only supports a key maintained in Azure Key Vault (AKV). You can set the following environment variables to configure the AKV connection. These values are generated when creating a service principal account (see Configuring your Key Vault)

• KEYVAULT_AZURE_CLIENT_ID - The clientId of the service principal account that has Get, List access to secrets.
• KEYVAULT_AZURE_CLIENT_SECRET - The client Secret of the same service principal account.
• KEYVAULT_AZURE_TENANT - The tenant that the service principal is a member of.
• KEYVAULT_AZURE_VAULT_NAME - The name of your Azure Key Vault.
• KEYVAULT_AZURE_SECRET_NAME - The name of the secret that holds your BLS key.

Operations

Setup

The service requires a connection to a SQL database. The SQL connection parameters should be configured with the DB_* configs stated above.

Once the database connection is established, the tables can be set up with the migration script. Set the DB env variables and then run: yarn db:migrate

Running locally

• yarn install
• yarn start

Error logs will be prefixed with CELO_PNP_ERROR_XX. You can see a full list of them in error.utils.ts.

Running in docker

Docker images for the signer service are published to Celo's container registry on Google Cloud. Search for images with tag phone-number-privacy-*.

• docker pull us.gcr.io/celo-testnet/celo-monorepo:phone-number-privacy-{LATEST_TAG_HERE}
• docker run -d -p 80:8080 {ENV_VARS_HERE} {CONTAINER_TAG_HERE}