Module: "odis/query"
Index
Enumerations
Interfaces
Type aliases
Functions
Object literals
Type aliases
AuthSigner
Ƭ AuthSigner: WalletKeySigner | EncryptionKeySigner
Defined in packages/sdk/identity/src/odis/query.ts:36
MatchmakingRequest
Ƭ MatchmakingRequest: GetContactMatchesRequest
Defined in packages/sdk/identity/src/odis/query.ts:41
MatchmakingResponse
Ƭ MatchmakingResponse: GetContactMatchesResponse
Defined in packages/sdk/identity/src/odis/query.ts:42
SignMessageRequest
Ƭ SignMessageRequest: GetBlindedMessageSigRequest
Defined in packages/sdk/identity/src/odis/query.ts:40
SignMessageResponse
Ƭ SignMessageResponse: CombinerSignMessageResponse
Defined in packages/sdk/identity/src/odis/query.ts:51
deprecated Exported as SignMessageResponse for backwards compatibility.
Functions
getServiceContext
▸ getServiceContext(contextName: string): ServiceContext
Defined in packages/sdk/identity/src/odis/query.ts:86
Parameters:
| Name | Type | Default |
|---|---|---|
contextName |
string | "mainnet" |
Returns: ServiceContext
queryOdis
▸ queryOdis<ResponseType>(signer: AuthSigner, body: PhoneNumberPrivacyRequest, context: ServiceContext, endpoint: PhoneNumberPrivacyEndpoint | CombinerEndpoint): Promise‹ResponseType›
Defined in packages/sdk/identity/src/odis/query.ts:124
Make a request to lookup the phone number identifier or perform matchmaking
Type parameters:
▪ ResponseType
Parameters:
| Name | Type | Description |
|---|---|---|
signer |
AuthSigner | Type of key to sign with. May be undefined if the request is presigned. |
body |
PhoneNumberPrivacyRequest | Request to send in the body of the HTTP request. |
context |
ServiceContext | Contains service URL and public to determine which instance to contact. |
endpoint |
PhoneNumberPrivacyEndpoint | CombinerEndpoint | Endpoint to query (e.g. '/getBlindedMessagePartialSig', '/getContactMatches'). |
Returns: Promise‹ResponseType›
sendOdisDomainRequest
▸ sendOdisDomainRequest<RequestType>(body: RequestType, context: ServiceContext, endpoint: DomainEndpoint, responseSchema: Type‹DomainResponse‹RequestType››): Promise‹DomainResponse‹RequestType››
Defined in packages/sdk/identity/src/odis/query.ts:209
Send the given domain request to ODIS (e.g. to get a POPRF evaluation or check quota).
Type parameters:
▪ RequestType: DomainRequest‹Domain›
Parameters:
| Name | Type | Description |
|---|---|---|
body |
RequestType | Request to send in the body of the HTTP request. |
context |
ServiceContext | Contains service URL and public to determine which instance to contact. |
endpoint |
DomainEndpoint | Endpoint to query (e.g. '/domain/sign', '/domain/quotaStatus'). |
responseSchema |
Type‹DomainResponse‹RequestType›› | io-ts type for the expected response type. Provided to ensure type safety. |
Returns: Promise‹DomainResponse‹RequestType››
signWithDEK
▸ signWithDEK(msg: string, signer: EncryptionKeySigner): string
Defined in packages/sdk/identity/src/odis/query.ts:97
Parameters:
| Name | Type |
|---|---|
msg |
string |
signer |
EncryptionKeySigner |
Returns: string
signWithRawKey
▸ signWithRawKey(msg: string, rawKey: string): string
Defined in packages/sdk/identity/src/odis/query.ts:101
Parameters:
| Name | Type |
|---|---|
msg |
string |
rawKey |
string |
Returns: string
Object literals
Const ODIS_ALFAJORESSTAGING_CONTEXT
▪ ODIS_ALFAJORESSTAGING_CONTEXT: object
Defined in packages/sdk/identity/src/odis/query.ts:74
odisPubKey
• odisPubKey: string = "7FsWGsFnmVvRfMDpzz95Np76wf/1sPaK0Og9yiB+P8QbjiC8FV67NBans9hzZEkBaQMhiapzgMR6CkZIZPvgwQboAxl65JWRZecGe5V3XO4sdKeNemdAZ2TzQuWkuZoA"
Defined in packages/sdk/identity/src/odis/query.ts:76
odisUrl
• odisUrl: string = "https://us-central1-celo-phone-number-privacy-stg.cloudfunctions.net"
Defined in packages/sdk/identity/src/odis/query.ts:75
Const ODIS_ALFAJORES_CONTEXT
▪ ODIS_ALFAJORES_CONTEXT: object
Defined in packages/sdk/identity/src/odis/query.ts:68
odisPubKey
• odisPubKey: string = "kPoRxWdEdZ/Nd3uQnp3FJFs54zuiS+ksqvOm9x8vY6KHPG8jrfqysvIRU0wtqYsBKA7SoAsICMBv8C/Fb2ZpDOqhSqvr/sZbZoHmQfvbqrzbtDIPvUIrHgRS0ydJCMsA"
Defined in packages/sdk/identity/src/odis/query.ts:70
odisUrl
• odisUrl: string = "https://us-central1-celo-phone-number-privacy.cloudfunctions.net"
Defined in packages/sdk/identity/src/odis/query.ts:69
Const ODIS_MAINNET_CONTEXT
▪ ODIS_MAINNET_CONTEXT: object
Defined in packages/sdk/identity/src/odis/query.ts:80
odisPubKey
• odisPubKey: string = "FvreHfLmhBjwxHxsxeyrcOLtSonC9j7K3WrS4QapYsQH6LdaDTaNGmnlQMfFY04Bp/K4wAvqQwO9/bqPVCKf8Ze8OZo8Frmog4JY4xAiwrsqOXxug11+htjEe1pj4uMA"
Defined in packages/sdk/identity/src/odis/query.ts:82
odisUrl
• odisUrl: string = "https://us-central1-celo-pgpnp-mainnet.cloudfunctions.net"
Defined in packages/sdk/identity/src/odis/query.ts:81