Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code cleanup #8764

Merged
merged 7 commits into from
Oct 12, 2021
Merged

Code cleanup #8764

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
30e1d58
first batch of misc changes
alecps Oct 8, 2021
949510d
update README
alecps Oct 8, 2021
f4c77f1
adds/resolves some todo comments
alecps Oct 8, 2021
504f5a1
resolves some todos
alecps Oct 8, 2021
e7d9fd8
resolves last couple todo items
alecps Oct 10, 2021
b15e8c4
addresses feedback
alecps Oct 12, 2021
aa6759b
removes TODO statement
alecps Oct 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update README
  • Loading branch information
@alecps
alecps committed Oct 8, 2021
commit 949510dbfd95758dd9f9f71bb2bcc2332cf498d4
10 changes: 6 additions & 4 deletions packages/attestation-service/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ You can use the following environment variables to configure the attestation ser
- `ATTESTATION_SIGNER_ADDRESS` - The address of the key with which attestations should be signed.
- `SMS_PROVIDERS` - A comma-separated list of providers you want to configure, we currently support:

`nexmo`
`vonage`

- `NEXMO_KEY` - The API key to the Nexmo API
- `NEXMO_SECRET` - The API secret to the Nexmo API
- `NEXMO_BLACKLIST` - A comma-sperated list of country codes you do not want to serve
- `VONAGE_KEY` - The API key to the Vonage API
- `VONAGE_SECRET` - The API secret to the Vonage API
- `VONAGE_BLACKLIST` - A comma-sperated list of country codes you do not want to serve

`twilio`

Expand Down Expand Up @@ -55,6 +55,8 @@ Here is a list of the error codes and messages returned by the Attestation Servi

- `Mismatching issuer, I am ${address}` - The attestation request references an issuer address that does not match that of the AS that actually received the request.
- `NO_INCOMPLETE_ATTESTATION_FOUND_ERROR / 'No incomplete attestation found'` - The Attestations contract has no record that this AS was randomly assigned as an issuer for the given account/identifier pair.
- `I am not an authorized issuer for this account` - The AS is not authorized to issue a PhoneNumberType VerifiableCredential for this user. This means the Attestations contract has no record that this AS was randomly assigned as an issuer for the given account/identifier pair.
- `Can't issue a credential for an incomplete attestation` - The user has requested a PhoneNumberType VerifiableCredential from an issuer with whom the user has not completed a phone number ownership attestation.
- `ATTESTATION_ERROR / 'Valid attestation could not be provided'` - A call to validateAttestationCode in the Attestations contract has failed. This method checks that (1) there is a non-expired incomplete attestation assigned to the issuer whose signature constitutes the given attestation code.
- `'Invalid securityCodePrefix'` - A security code prefix with an incorrect length was provided in the attestation request.
- `'Invalid smsRetrieverAppSig'` - The provided smsRetrieverAppSig does not match the regex `'^[\\w+]{5,12}$'`
Expand Down