@celo/identity › "odis/phone-number-identifier"

Module: "odis/phone-number-identifier"

Index

Interfaces

Variables

Functions

Variables

Const ODIS_MINIMUM_CELO_BALANCE

• ODIS_MINIMUM_CELO_BALANCE: 0.005 = 0.005

Defined in packages/sdk/identity/src/odis/phone-number-identifier.ts:21

Const ODIS_MINIMUM_DOLLAR_BALANCE

• ODIS_MINIMUM_DOLLAR_BALANCE: 0.01 = 0.01

Defined in packages/sdk/identity/src/odis/phone-number-identifier.ts:19

Functions

getBlindedPhoneNumber

▸ getBlindedPhoneNumber(e164Number: string, blsBlindingClient: BlsBlindingClient, seed?: Buffer): Promise‹string›

Defined in packages/sdk/identity/src/odis/phone-number-identifier.ts:88

Blinds the phone number in preparation for the ODIS request Caller should use the same blsBlindingClient instance for unblinding

Parameters:

Name Type
e164Number string
blsBlindingClient BlsBlindingClient
seed? Buffer

Returns: Promise‹string›

getBlindedPhoneNumberSignature

▸ getBlindedPhoneNumberSignature(account: string, signer: AuthSigner, context: ServiceContext, base64BlindedMessage: string, selfPhoneHash?: undefined | string, clientVersion?: undefined | string, sessionID?: undefined | string): Promise‹string›

Defined in packages/sdk/identity/src/odis/phone-number-identifier.ts:103

Query ODIS for the blinded signature Response can be passed into getPhoneNumberIdentifierFromSignature to retrieve the on-chain identifier

Parameters:

Name Type
account string
signer AuthSigner
context ServiceContext
base64BlindedMessage string
selfPhoneHash? undefined | string
clientVersion? undefined | string
sessionID? undefined | string

Returns: Promise‹string›

getPepperFromThresholdSignature

▸ getPepperFromThresholdSignature(sigBuf: Buffer): string

Defined in packages/sdk/identity/src/odis/phone-number-identifier.ts:153

Parameters:

Name Type
sigBuf Buffer

Returns: string

getPhoneNumberIdentifier

▸ getPhoneNumberIdentifier(e164Number: string, account: string, signer: AuthSigner, context: ServiceContext, blindingFactor?: undefined | string, selfPhoneHash?: undefined | string, clientVersion?: undefined | string, blsBlindingClient?: BlsBlindingClient, sessionID?: undefined | string): Promise‹PhoneNumberHashDetails›

Defined in packages/sdk/identity/src/odis/phone-number-identifier.ts:38

Retrieve the on-chain identifier for the provided phone number Performs blinding, querying, and unblinding

Parameters:

Name Type
e164Number string
account string
signer AuthSigner
context ServiceContext
blindingFactor? undefined | string
selfPhoneHash? undefined | string
clientVersion? undefined | string
blsBlindingClient? BlsBlindingClient
sessionID? undefined | string

Returns: Promise‹PhoneNumberHashDetails›

getPhoneNumberIdentifierFromSignature

▸ getPhoneNumberIdentifierFromSignature(e164Number: string, base64BlindedSignature: string, blsBlindingClient: BlsBlindingClient): Promise‹PhoneNumberHashDetails›

Defined in packages/sdk/identity/src/odis/phone-number-identifier.ts:136

Unblind the response and return the on-chain identifier

Parameters:

Name Type
e164Number string
base64BlindedSignature string
blsBlindingClient BlsBlindingClient

Returns: Promise‹PhoneNumberHashDetails›

isBalanceSufficientForSigRetrieval

▸ isBalanceSufficientForSigRetrieval(dollarBalance: BigNumber.Value, celoBalance: BigNumber.Value): boolean

Defined in packages/sdk/identity/src/odis/phone-number-identifier.ts:161

Check if balance is sufficient for quota retrieval

Parameters:

Name Type
dollarBalance BigNumber.Value
celoBalance BigNumber.Value

Returns: boolean