diff --git a/packages/base/src/async.ts b/packages/base/src/async.ts index b54384bacb5..7f5f28af0ea 100644 --- a/packages/base/src/async.ts +++ b/packages/base/src/async.ts @@ -1,3 +1,5 @@ +import { Logger } from './logger' + const TAG = 'utils/src/async' /** Sleep for a number of milliseconds */ @@ -13,7 +15,8 @@ export const retryAsync = async ( inFunction: InFunction, tries: number, params: T, - delay = 100 + delay = 100, + logger: Logger | null = null ) => { let saveError for (let i = 0; i < tries; i++) { @@ -23,7 +26,9 @@ export const retryAsync = async ( } catch (error) { await sleep(delay) saveError = error - console.info(`${TAG}/@retryAsync, Failed to execute function on try #${i}:`, error) + if (logger) { + logger(`${TAG}/@retryAsync, Failed to execute function on try #${i}:`, error) + } } } @@ -37,7 +42,8 @@ export const retryAsyncWithBackOff = async ( tries: number, params: T, delay = 100, - factor = 1.5 + factor = 1.5, + logger: Logger | null = null ) => { let saveError for (let i = 0; i < tries; i++) { @@ -47,7 +53,9 @@ export const retryAsyncWithBackOff = async ( } catch (error) { await sleep(Math.pow(factor, i) * delay) saveError = error - console.info(`${TAG}/@retryAsync, Failed to execute function on try #${i}`, error) + if (logger) { + logger(`${TAG}/@retryAsync, Failed to execute function on try #${i}`, error) + } } } @@ -63,7 +71,8 @@ export const selectiveRetryAsyncWithBackOff = async ( dontRetry: string[], params: T, delay = 100, - factor = 1.5 + factor = 1.5, + logger: Logger | null = null ) => { let saveError for (let i = 0; i < tries; i++) { @@ -75,7 +84,9 @@ export const selectiveRetryAsyncWithBackOff = async ( throw error } saveError = error - console.info(`${TAG}/@retryAsync, Failed to execute function on try #${i}`, error) + if (logger) { + logger(`${TAG}/@retryAsync, Failed to execute function on try #${i}`, error) + } } if (i < tries - 1) { await sleep(Math.pow(factor, i) * delay) diff --git a/packages/contractkit/src/identity/claims/verify.ts b/packages/contractkit/src/identity/claims/verify.ts index bdb73d0b5cf..086a10d3c07 100644 --- a/packages/contractkit/src/identity/claims/verify.ts +++ b/packages/contractkit/src/identity/claims/verify.ts @@ -16,12 +16,12 @@ import { ClaimTypes } from './types' * @param address The address that is making the claim * @returns If valid, returns undefined. If invalid or unable to verify, returns a string with the error */ -export async function verifyClaim(kit: ContractKit, claim: Claim, address: string) { +export async function verifyClaim(kit: ContractKit, claim: Claim, address: string, tries = 3) { switch (claim.type) { case ClaimTypes.KEYBASE: return verifyKeybaseClaim(kit, claim, address) case ClaimTypes.ACCOUNT: - return verifyAccountClaim(kit, claim, address) + return verifyAccountClaim(kit, claim, address, tries) case ClaimTypes.DOMAIN: return verifyDomainRecord(kit, claim, address) default: @@ -33,7 +33,8 @@ export async function verifyClaim(kit: ContractKit, claim: Claim, address: strin export const verifyAccountClaim = async ( kit: ContractKit, claim: AccountClaim, - address: string + address: string, + tries = 3 ) => { const metadataURL = await (await kit.contracts.getAccounts()).getMetadataURL(claim.address) @@ -43,7 +44,7 @@ export const verifyAccountClaim = async ( let metadata: IdentityMetadataWrapper try { - metadata = await IdentityMetadataWrapper.fetchFromURL(kit, metadataURL) + metadata = await IdentityMetadataWrapper.fetchFromURL(kit, metadataURL, tries) } catch (error) { return `Metadata could not be fetched for ${ claim.address diff --git a/packages/contractkit/src/identity/metadata.ts b/packages/contractkit/src/identity/metadata.ts index ce1a33fd864..81417e50616 100644 --- a/packages/contractkit/src/identity/metadata.ts +++ b/packages/contractkit/src/identity/metadata.ts @@ -1,4 +1,5 @@ import { Address, eqAddress } from '@celo/base/lib/address' +import { selectiveRetryAsyncWithBackOff } from '@celo/base/lib/async' import { Signer } from '@celo/base/lib/signatureUtils' import { AddressType, SignatureType } from '@celo/utils/lib/io' import { guessSigner, verifySignature } from '@celo/utils/lib/signatureUtils' @@ -37,12 +38,19 @@ export class IdentityMetadataWrapper { }) } - static async fetchFromURL(kit: ContractKit, url: string) { - const resp = await fetch(url) - if (!resp.ok) { - throw new Error(`Request failed with status ${resp.status}`) - } - return this.fromRawString(kit, await resp.text()) + static async fetchFromURL(kit: ContractKit, url: string, tries = 3) { + return selectiveRetryAsyncWithBackOff( + async () => { + const resp = await fetch(url) + if (!resp.ok) { + throw new Error(`Request failed with status ${resp.status}`) + } + return this.fromRawString(kit, await resp.text()) + }, + tries, + ['Request failed with status 404'], + [] + ) } static fromFile(kit: ContractKit, path: string) { diff --git a/packages/contractkit/src/wrappers/Attestations.ts b/packages/contractkit/src/wrappers/Attestations.ts index 56f99d3066d..cd5e69ed008 100644 --- a/packages/contractkit/src/wrappers/Attestations.ts +++ b/packages/contractkit/src/wrappers/Attestations.ts @@ -270,7 +270,8 @@ export class AttestationsWrapper extends BaseWrapper { */ async getActionableAttestations( identifier: string, - account: Address + account: Address, + tries = 3 ): Promise { const result = await this.contract.methods .getCompletableAttestations(identifier, account) @@ -279,7 +280,7 @@ export class AttestationsWrapper extends BaseWrapper { const results = await concurrentMap( 5, parseGetCompletableAttestations(result), - this.isIssuerRunningAttestationService + this.makeIsIssuerRunningAttestationService(tries) ) return results.map((_) => (_.isValid ? _.result : null)).filter(notEmpty) @@ -290,7 +291,11 @@ export class AttestationsWrapper extends BaseWrapper { * @param identifier Attestation identifier (e.g. phone hash) * @param account Address of the account */ - async getNonCompliantIssuers(identifier: string, account: Address): Promise { + async getNonCompliantIssuers( + identifier: string, + account: Address, + tries = 3 + ): Promise { const result = await this.contract.methods .getCompletableAttestations(identifier, account) .call() @@ -298,40 +303,46 @@ export class AttestationsWrapper extends BaseWrapper { const withAttestationServiceURLs = await concurrentMap( 5, parseGetCompletableAttestations(result), - this.isIssuerRunningAttestationService + this.makeIsIssuerRunningAttestationService(tries) ) return withAttestationServiceURLs.map((_) => (_.isValid ? null : _.issuer)).filter(notEmpty) } - private isIssuerRunningAttestationService = async (arg: { - blockNumber: number - issuer: string - metadataURL: string - }): Promise => { - try { - const metadata = await IdentityMetadataWrapper.fetchFromURL(this.kit, arg.metadataURL) - const attestationServiceURLClaim = metadata.findClaim(ClaimTypes.ATTESTATION_SERVICE_URL) - - if (attestationServiceURLClaim === undefined) { - throw new Error(`No attestation service URL registered for ${arg.issuer}`) - } + private makeIsIssuerRunningAttestationService = (tries = 3) => { + return async (arg: { + blockNumber: number + issuer: string + metadataURL: string + }): Promise => { + try { + const metadata = await IdentityMetadataWrapper.fetchFromURL( + this.kit, + arg.metadataURL, + tries + ) + const attestationServiceURLClaim = metadata.findClaim(ClaimTypes.ATTESTATION_SERVICE_URL) + + if (attestationServiceURLClaim === undefined) { + throw new Error(`No attestation service URL registered for ${arg.issuer}`) + } - const nameClaim = metadata.findClaim(ClaimTypes.NAME) - - // TODO: Once we have status indicators, we should check if service is up - // https://github.com/celo-org/celo-monorepo/issues/1586 - return { - isValid: true, - result: { - blockNumber: arg.blockNumber, - issuer: arg.issuer, - attestationServiceURL: attestationServiceURLClaim.url, - name: nameClaim ? nameClaim.name : undefined, - }, + const nameClaim = metadata.findClaim(ClaimTypes.NAME) + + // TODO: Once we have status indicators, we should check if service is up + // https://github.com/celo-org/celo-monorepo/issues/1586 + return { + isValid: true, + result: { + blockNumber: arg.blockNumber, + issuer: arg.issuer, + attestationServiceURL: attestationServiceURLClaim.url, + name: nameClaim ? nameClaim.name : undefined, + }, + } + } catch (error) { + return { isValid: false, issuer: arg.issuer } } - } catch (error) { - return { isValid: false, issuer: arg.issuer } } } diff --git a/packages/docs/developer-resources/contractkit/reference/classes/_identity_metadata_.identitymetadatawrapper.md b/packages/docs/developer-resources/contractkit/reference/classes/_identity_metadata_.identitymetadatawrapper.md index aed5c98927c..6c493c8d3f3 100644 --- a/packages/docs/developer-resources/contractkit/reference/classes/_identity_metadata_.identitymetadatawrapper.md +++ b/packages/docs/developer-resources/contractkit/reference/classes/_identity_metadata_.identitymetadatawrapper.md @@ -38,7 +38,7 @@ \+ **new IdentityMetadataWrapper**(`data`: [IdentityMetadata](../modules/_identity_metadata_.md#identitymetadata)): *[IdentityMetadataWrapper](_identity_metadata_.identitymetadatawrapper.md)* -*Defined in [packages/contractkit/src/identity/metadata.ts:120](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L120)* +*Defined in [packages/contractkit/src/identity/metadata.ts:128](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L128)* **Parameters:** @@ -54,7 +54,7 @@ Name | Type | • **data**: *[IdentityMetadata](../modules/_identity_metadata_.md#identitymetadata)* -*Defined in [packages/contractkit/src/identity/metadata.ts:28](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L28)* +*Defined in [packages/contractkit/src/identity/metadata.ts:29](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L29)* ## Accessors @@ -62,7 +62,7 @@ Name | Type | • **get claims**(): *object | object | object | object | object | object[]* -*Defined in [packages/contractkit/src/identity/metadata.ts:126](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L126)* +*Defined in [packages/contractkit/src/identity/metadata.ts:134](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L134)* **Returns:** *object | object | object | object | object | object[]* @@ -72,7 +72,7 @@ Name | Type | ▸ **addClaim**(`claim`: [Claim](../modules/_identity_claims_claim_.md#claim), `signer`: Signer): *Promise‹object | object | object | object | object | object›* -*Defined in [packages/contractkit/src/identity/metadata.ts:141](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L141)* +*Defined in [packages/contractkit/src/identity/metadata.ts:149](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L149)* **Parameters:** @@ -89,7 +89,7 @@ ___ ▸ **filterClaims**<**K**>(`type`: K): *Array‹[ClaimPayload](../modules/_identity_claims_claim_.md#claimpayload)‹K››* -*Defined in [packages/contractkit/src/identity/metadata.ts:181](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L181)* +*Defined in [packages/contractkit/src/identity/metadata.ts:189](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L189)* **Type parameters:** @@ -109,7 +109,7 @@ ___ ▸ **findClaim**<**K**>(`type`: K): *[ClaimPayload](../modules/_identity_claims_claim_.md#claimpayload)‹K› | undefined* -*Defined in [packages/contractkit/src/identity/metadata.ts:177](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L177)* +*Defined in [packages/contractkit/src/identity/metadata.ts:185](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L185)* **Type parameters:** @@ -129,7 +129,7 @@ ___ ▸ **hashOfClaims**(): *string* -*Defined in [packages/contractkit/src/identity/metadata.ts:130](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L130)* +*Defined in [packages/contractkit/src/identity/metadata.ts:138](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L138)* **Returns:** *string* @@ -139,7 +139,7 @@ ___ ▸ **toString**(): *string* -*Defined in [packages/contractkit/src/identity/metadata.ts:134](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L134)* +*Defined in [packages/contractkit/src/identity/metadata.ts:142](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L142)* **Returns:** *string* @@ -147,16 +147,17 @@ ___ ### `Static` fetchFromURL -▸ **fetchFromURL**(`kit`: [ContractKit](_kit_.contractkit.md), `url`: string): *Promise‹[IdentityMetadataWrapper](_identity_metadata_.identitymetadatawrapper.md)‹››* +▸ **fetchFromURL**(`kit`: [ContractKit](_kit_.contractkit.md), `url`: string, `tries`: number): *Promise‹[IdentityMetadataWrapper](_identity_metadata_.identitymetadatawrapper.md)‹››* -*Defined in [packages/contractkit/src/identity/metadata.ts:40](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L40)* +*Defined in [packages/contractkit/src/identity/metadata.ts:41](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L41)* **Parameters:** -Name | Type | ------- | ------ | -`kit` | [ContractKit](_kit_.contractkit.md) | -`url` | string | +Name | Type | Default | +------ | ------ | ------ | +`kit` | [ContractKit](_kit_.contractkit.md) | - | +`url` | string | - | +`tries` | number | 3 | **Returns:** *Promise‹[IdentityMetadataWrapper](_identity_metadata_.identitymetadatawrapper.md)‹››* @@ -166,7 +167,7 @@ ___ ▸ **fromEmpty**(`address`: [Address](../modules/_base_.md#address)): *[IdentityMetadataWrapper](_identity_metadata_.identitymetadatawrapper.md)‹›* -*Defined in [packages/contractkit/src/identity/metadata.ts:30](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L30)* +*Defined in [packages/contractkit/src/identity/metadata.ts:31](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L31)* **Parameters:** @@ -182,7 +183,7 @@ ___ ▸ **fromFile**(`kit`: [ContractKit](_kit_.contractkit.md), `path`: string): *Promise‹[IdentityMetadataWrapper](_identity_metadata_.identitymetadatawrapper.md)‹››* -*Defined in [packages/contractkit/src/identity/metadata.ts:48](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L48)* +*Defined in [packages/contractkit/src/identity/metadata.ts:56](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L56)* **Parameters:** @@ -199,7 +200,7 @@ ___ ▸ **fromRawString**(`kit`: [ContractKit](_kit_.contractkit.md), `rawData`: string): *Promise‹[IdentityMetadataWrapper](_identity_metadata_.identitymetadatawrapper.md)‹››* -*Defined in [packages/contractkit/src/identity/metadata.ts:79](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L79)* +*Defined in [packages/contractkit/src/identity/metadata.ts:87](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L87)* **Parameters:** @@ -216,7 +217,7 @@ ___ ▸ **verifySigner**(`kit`: [ContractKit](_kit_.contractkit.md), `hash`: any, `signature`: any, `metadata`: any): *Promise‹boolean›* -*Defined in [packages/contractkit/src/identity/metadata.ts:52](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L52)* +*Defined in [packages/contractkit/src/identity/metadata.ts:60](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L60)* **Parameters:** @@ -235,7 +236,7 @@ ___ ▸ **verifySignerForAddress**(`kit`: [ContractKit](_kit_.contractkit.md), `hash`: any, `signature`: any, `address`: [Address](../modules/_base_.md#address)): *Promise‹boolean›* -*Defined in [packages/contractkit/src/identity/metadata.ts:56](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L56)* +*Defined in [packages/contractkit/src/identity/metadata.ts:64](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L64)* **Parameters:** diff --git a/packages/docs/developer-resources/contractkit/reference/classes/_wrappers_attestations_.attestationswrapper.md b/packages/docs/developer-resources/contractkit/reference/classes/_wrappers_attestations_.attestationswrapper.md index eeb24f22d8e..6722fbe8eaa 100644 --- a/packages/docs/developer-resources/contractkit/reference/classes/_wrappers_attestations_.attestationswrapper.md +++ b/packages/docs/developer-resources/contractkit/reference/classes/_wrappers_attestations_.attestationswrapper.md @@ -346,7 +346,7 @@ ___ ▸ **complete**(`identifier`: string, `account`: [Address](../modules/_base_.md#address), `issuer`: [Address](../modules/_base_.md#address), `code`: string): *Promise‹[CeloTransactionObject](_wrappers_basewrapper_.celotransactionobject.md)‹void››* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:345](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L345)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:356](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L356)* Completes an attestation with the corresponding code @@ -367,7 +367,7 @@ ___ ▸ **findMatchingIssuer**(`identifier`: string, `account`: [Address](../modules/_base_.md#address), `code`: string, `issuers`: string[]): *Promise‹string | null›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:367](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L367)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:378](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L378)* Given a list of issuers, finds the matching issuer for a given code @@ -386,7 +386,7 @@ ___ ### getActionableAttestations -▸ **getActionableAttestations**(`identifier`: string, `account`: [Address](../modules/_base_.md#address)): *Promise‹[ActionableAttestation](../interfaces/_wrappers_attestations_.actionableattestation.md)[]›* +▸ **getActionableAttestations**(`identifier`: string, `account`: [Address](../modules/_base_.md#address), `tries`: number): *Promise‹[ActionableAttestation](../interfaces/_wrappers_attestations_.actionableattestation.md)[]›* *Defined in [packages/contractkit/src/wrappers/Attestations.ts:271](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L271)* @@ -395,10 +395,11 @@ service urls **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`identifier` | string | Attestation identifier (e.g. phone hash) | -`account` | [Address](../modules/_base_.md#address) | Address of the account | +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`identifier` | string | - | Attestation identifier (e.g. phone hash) | +`account` | [Address](../modules/_base_.md#address) | - | Address of the account | +`tries` | number | 3 | - | **Returns:** *Promise‹[ActionableAttestation](../interfaces/_wrappers_attestations_.actionableattestation.md)[]›* @@ -426,7 +427,7 @@ ___ ▸ **getAttestationServiceStatus**(`validator`: [Validator](../interfaces/_wrappers_validators_.validator.md)): *Promise‹[AttestationServiceStatusResponse](../interfaces/_wrappers_attestations_.attestationservicestatusresponse.md)›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:591](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L591)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:602](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L602)* Gets the relevant attestation service status for a validator @@ -444,7 +445,7 @@ ___ ▸ **getConfig**(`tokens`: string[]): *Promise‹[AttestationsConfig](../interfaces/_wrappers_attestations_.attestationsconfig.md)›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:396](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L396)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:407](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L407)* Returns the current configuration parameters for the contract. @@ -464,7 +465,7 @@ ___ ▸ **getHumanReadableConfig**(`tokens`: string[]): *Promise‹object›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:413](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L413)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:424](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L424)* **`dev`** Returns human readable configuration of the attestations contract @@ -482,18 +483,19 @@ ___ ### getNonCompliantIssuers -▸ **getNonCompliantIssuers**(`identifier`: string, `account`: [Address](../modules/_base_.md#address)): *Promise‹[Address](../modules/_base_.md#address)[]›* +▸ **getNonCompliantIssuers**(`identifier`: string, `account`: [Address](../modules/_base_.md#address), `tries`: number): *Promise‹[Address](../modules/_base_.md#address)[]›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:293](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L293)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:294](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L294)* Returns an array of issuer addresses that were found to not run the attestation service **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`identifier` | string | Attestation identifier (e.g. phone hash) | -`account` | [Address](../modules/_base_.md#address) | Address of the account | +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`identifier` | string | - | Attestation identifier (e.g. phone hash) | +`account` | [Address](../modules/_base_.md#address) | - | Address of the account | +`tries` | number | 3 | - | **Returns:** *Promise‹[Address](../modules/_base_.md#address)[]›* @@ -524,7 +526,7 @@ ___ ▸ **getRevealStatus**(`phoneNumber`: string, `account`: [Address](../modules/_base_.md#address), `issuer`: [Address](../modules/_base_.md#address), `serviceURL`: string, `pepper?`: undefined | string): *Promise‹Response›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:538](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L538)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:549](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L549)* Returns reveal status from validator's attestation service @@ -584,7 +586,7 @@ ___ ▸ **lookupIdentifiers**(`identifiers`: string[]): *Promise‹[IdentifierLookupResult](../modules/_wrappers_attestations_.md#identifierlookupresult)›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:425](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L425)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:436](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L436)* Lookup mapped wallet addresses for a given list of identifiers @@ -602,7 +604,7 @@ ___ ▸ **request**(`identifier`: string, `attestationsRequested`: number): *Promise‹[CeloTransactionObject](_wrappers_basewrapper_.celotransactionobject.md)‹void››* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:466](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L466)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:477](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L477)* Requests a new attestation @@ -621,7 +623,7 @@ ___ ▸ **revealPhoneNumberToIssuer**(`phoneNumber`: string, `account`: [Address](../modules/_base_.md#address), `issuer`: [Address](../modules/_base_.md#address), `serviceURL`: string, `pepper?`: undefined | string, `smsRetrieverAppSig?`: undefined | string): *Promise‹Response›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:506](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L506)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:517](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L517)* Reveal phone number to issuer @@ -644,7 +646,7 @@ ___ ▸ **revoke**(`identifer`: string, `account`: [Address](../modules/_base_.md#address)): *Promise‹[CeloTransactionObject](_wrappers_basewrapper_.celotransactionobject.md)‹void››* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:703](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L703)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:714](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L714)* **Parameters:** @@ -661,7 +663,7 @@ ___ ▸ **selectIssuers**(`identifier`: string): *[CeloTransactionObject](_wrappers_basewrapper_.celotransactionobject.md)‹void›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:478](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L478)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:489](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L489)* Selects the issuers for previously requested attestations for a phone number @@ -679,7 +681,7 @@ ___ ▸ **selectIssuersAfterWait**(`identifier`: string, `account`: string, `timeoutSeconds?`: undefined | number, `pollDurationSeconds?`: undefined | number): *Promise‹[CeloTransactionObject](_wrappers_basewrapper_.celotransactionobject.md)‹void››* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:487](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L487)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:498](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L498)* Waits appropriate number of blocks, then selects issuers for previously requested phone number attestations @@ -700,7 +702,7 @@ ___ ▸ **validateAttestationCode**(`identifier`: string, `account`: [Address](../modules/_base_.md#address), `issuer`: [Address](../modules/_base_.md#address), `code`: string): *Promise‹boolean›* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:564](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L564)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:575](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L575)* Validates a given code by the issuer on-chain diff --git a/packages/docs/developer-resources/contractkit/reference/enums/_wrappers_attestations_.attestationservicestatusstate.md b/packages/docs/developer-resources/contractkit/reference/enums/_wrappers_attestations_.attestationservicestatusstate.md index ff01b7bbd8c..72c6742ac95 100644 --- a/packages/docs/developer-resources/contractkit/reference/enums/_wrappers_attestations_.attestationservicestatusstate.md +++ b/packages/docs/developer-resources/contractkit/reference/enums/_wrappers_attestations_.attestationservicestatusstate.md @@ -21,7 +21,7 @@ • **InvalidMetadata**: = "InvalidMetadata" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:716](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L716)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:727](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L727)* ___ @@ -29,7 +29,7 @@ ___ • **MetadataTimeout**: = "MetadataTimeout" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:723](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L723)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:734](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L734)* ___ @@ -37,7 +37,7 @@ ___ • **NoAttestationServiceURL**: = "NoAttestationServiceURL" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:717](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L717)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:728](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L728)* ___ @@ -45,7 +45,7 @@ ___ • **NoAttestationSigner**: = "NoAttestationSigner" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:714](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L714)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:725](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L725)* ___ @@ -53,7 +53,7 @@ ___ • **NoMetadataURL**: = "NoMetadataURL" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:715](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L715)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:726](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L726)* ___ @@ -61,7 +61,7 @@ ___ • **Unhealthy**: = "Unhealthy" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:721](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L721)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:732](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L732)* ___ @@ -69,7 +69,7 @@ ___ • **UnreachableAttestationService**: = "UnreachableAttestationService" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:718](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L718)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:729](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L729)* ___ @@ -77,7 +77,7 @@ ___ • **UnreachableHealthz**: = "UnreachableHealthz" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:720](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L720)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:731](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L731)* ___ @@ -85,7 +85,7 @@ ___ • **Valid**: = "Valid" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:719](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L719)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:730](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L730)* ___ @@ -93,4 +93,4 @@ ___ • **WrongAccount**: = "WrongAccount" -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:722](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L722)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:733](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L733)* diff --git a/packages/docs/developer-resources/contractkit/reference/interfaces/_wrappers_attestations_.attestationservicestatusresponse.md b/packages/docs/developer-resources/contractkit/reference/interfaces/_wrappers_attestations_.attestationservicestatusresponse.md index fa7c4742f67..23043bb1570 100644 --- a/packages/docs/developer-resources/contractkit/reference/interfaces/_wrappers_attestations_.attestationservicestatusresponse.md +++ b/packages/docs/developer-resources/contractkit/reference/interfaces/_wrappers_attestations_.attestationservicestatusresponse.md @@ -34,7 +34,7 @@ • **address**: *[Address](../modules/_base_.md#address)* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:727](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L727)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:738](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L738)* ___ @@ -42,7 +42,7 @@ ___ • **affiliation**: *string | null* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:730](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L730)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:741](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L741)* ___ @@ -50,7 +50,7 @@ ___ • **ageOfLatestBlock**: *number | null* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:744](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L744)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:755](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L755)* ___ @@ -58,7 +58,7 @@ ___ • **attestationServiceURL**: *string | null* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:734](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L734)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:745](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L745)* ___ @@ -66,7 +66,7 @@ ___ • **attestationSigner**: *string* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:733](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L733)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:744](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L744)* ___ @@ -74,7 +74,7 @@ ___ • **blacklistedRegionCodes**: *string[] | null* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:739](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L739)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:750](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L750)* ___ @@ -82,7 +82,7 @@ ___ • **blsPublicKey**: *string* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:729](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L729)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:740](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L740)* ___ @@ -90,7 +90,7 @@ ___ • **ecdsaPublicKey**: *string* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:728](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L728)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:739](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L739)* ___ @@ -98,7 +98,7 @@ ___ • **error**: *null | Error* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:737](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L737)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:748](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L748)* ___ @@ -106,7 +106,7 @@ ___ • **hasAttestationSigner**: *boolean* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:732](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L732)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:743](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L743)* ___ @@ -114,7 +114,7 @@ ___ • **metadataURL**: *string | null* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:735](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L735)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:746](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L746)* ___ @@ -122,7 +122,7 @@ ___ • **name**: *string* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:726](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L726)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:737](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L737)* ___ @@ -130,7 +130,7 @@ ___ • **okStatus**: *boolean* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:736](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L736)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:747](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L747)* ___ @@ -138,7 +138,7 @@ ___ • **rightAccount**: *boolean* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:740](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L740)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:751](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L751)* ___ @@ -146,7 +146,7 @@ ___ • **score**: *BigNumber* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:731](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L731)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:742](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L742)* ___ @@ -154,7 +154,7 @@ ___ • **signer**: *string* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:741](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L741)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:752](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L752)* ___ @@ -162,7 +162,7 @@ ___ • **smsProviders**: *string[]* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:738](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L738)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:749](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L749)* ___ @@ -170,7 +170,7 @@ ___ • **state**: *[AttestationServiceStatusState](../enums/_wrappers_attestations_.attestationservicestatusstate.md)* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:742](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L742)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:753](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L753)* ___ @@ -178,4 +178,4 @@ ___ • **version**: *string | null* -*Defined in [packages/contractkit/src/wrappers/Attestations.ts:743](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L743)* +*Defined in [packages/contractkit/src/wrappers/Attestations.ts:754](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/wrappers/Attestations.ts#L754)* diff --git a/packages/docs/developer-resources/contractkit/reference/modules/_identity_claims_verify_.md b/packages/docs/developer-resources/contractkit/reference/modules/_identity_claims_verify_.md index 136d620311e..e11fd891433 100644 --- a/packages/docs/developer-resources/contractkit/reference/modules/_identity_claims_verify_.md +++ b/packages/docs/developer-resources/contractkit/reference/modules/_identity_claims_verify_.md @@ -12,17 +12,18 @@ ### `Const` verifyAccountClaim -▸ **verifyAccountClaim**(`kit`: [ContractKit](../classes/_kit_.contractkit.md), `claim`: [AccountClaim](_identity_claims_account_.md#accountclaim), `address`: string): *Promise‹undefined | string›* +▸ **verifyAccountClaim**(`kit`: [ContractKit](../classes/_kit_.contractkit.md), `claim`: [AccountClaim](_identity_claims_account_.md#accountclaim), `address`: string, `tries`: number): *Promise‹undefined | string›* *Defined in [packages/contractkit/src/identity/claims/verify.ts:33](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/verify.ts#L33)* **Parameters:** -Name | Type | ------- | ------ | -`kit` | [ContractKit](../classes/_kit_.contractkit.md) | -`claim` | [AccountClaim](_identity_claims_account_.md#accountclaim) | -`address` | string | +Name | Type | Default | +------ | ------ | ------ | +`kit` | [ContractKit](../classes/_kit_.contractkit.md) | - | +`claim` | [AccountClaim](_identity_claims_account_.md#accountclaim) | - | +`address` | string | - | +`tries` | number | 3 | **Returns:** *Promise‹undefined | string›* @@ -30,7 +31,7 @@ ___ ### verifyClaim -▸ **verifyClaim**(`kit`: [ContractKit](../classes/_kit_.contractkit.md), `claim`: [Claim](_identity_claims_claim_.md#claim), `address`: string): *Promise‹undefined | string›* +▸ **verifyClaim**(`kit`: [ContractKit](../classes/_kit_.contractkit.md), `claim`: [Claim](_identity_claims_claim_.md#claim), `address`: string, `tries`: number): *Promise‹undefined | string›* *Defined in [packages/contractkit/src/identity/claims/verify.ts:19](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/verify.ts#L19)* @@ -38,11 +39,12 @@ Verifies a claim made by an account, i.e. whether a claim can be verified to be **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`kit` | [ContractKit](../classes/_kit_.contractkit.md) | ContractKit object | -`claim` | [Claim](_identity_claims_claim_.md#claim) | The claim to verify | -`address` | string | The address that is making the claim | +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`kit` | [ContractKit](../classes/_kit_.contractkit.md) | - | ContractKit object | +`claim` | [Claim](_identity_claims_claim_.md#claim) | - | The claim to verify | +`address` | string | - | The address that is making the claim | +`tries` | number | 3 | - | **Returns:** *Promise‹undefined | string›* @@ -54,7 +56,7 @@ ___ ▸ **verifyDomainRecord**(`kit`: [ContractKit](../classes/_kit_.contractkit.md), `claim`: [DomainClaim](_identity_claims_claim_.md#domainclaim), `address`: string, `dnsResolver`: dnsResolverFunction): *Promise‹undefined | string›* -*Defined in [packages/contractkit/src/identity/claims/verify.ts:71](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/verify.ts#L71)* +*Defined in [packages/contractkit/src/identity/claims/verify.ts:72](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/verify.ts#L72)* It verifies if a DNS domain includes in the TXT records an entry with name `celo-site-verification` and a valid signature in base64 diff --git a/packages/docs/developer-resources/contractkit/reference/modules/_identity_metadata_.md b/packages/docs/developer-resources/contractkit/reference/modules/_identity_metadata_.md index ca0ef1397f5..5182e78c1ab 100644 --- a/packages/docs/developer-resources/contractkit/reference/modules/_identity_metadata_.md +++ b/packages/docs/developer-resources/contractkit/reference/modules/_identity_metadata_.md @@ -30,7 +30,7 @@ Ƭ **IdentityMetadata**: *t.TypeOf‹typeof IdentityMetadataType›* -*Defined in [packages/contractkit/src/identity/metadata.ts:25](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L25)* +*Defined in [packages/contractkit/src/identity/metadata.ts:26](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L26)* ## Variables @@ -41,4 +41,4 @@ meta: MetaType, }) -*Defined in [packages/contractkit/src/identity/metadata.ts:21](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L21)* +*Defined in [packages/contractkit/src/identity/metadata.ts:22](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/metadata.ts#L22)*