# identity/claims/keybase

## Index

### Variables

* [keybaseFilePathToProof](#const-keybasefilepathtoproof)

### Functions

* [createKeybaseClaim](#const-createkeybaseclaim)
* [proofFileName](#const-prooffilename)
* [targetURL](#const-targeturl)
* [verifyKeybaseClaim](#verifykeybaseclaim)

## Variables

### `Const` keybaseFilePathToProof

• **keybaseFilePathToProof**: *".well-known/celo/"* = `.well-known/celo/`

*Defined in* [*packages/contractkit/src/identity/claims/keybase.ts:9*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/keybase.ts#L9)

## Functions

### `Const` createKeybaseClaim

▸ **createKeybaseClaim**(`username`: string): [*KeybaseClaim*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/_identity_claims_claim_#keybaseclaim)

*Defined in* [*packages/contractkit/src/identity/claims/keybase.ts:62*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/keybase.ts#L62)

**Parameters:**

| Name       | Type   |
| ---------- | ------ |
| `username` | string |

**Returns:** [*KeybaseClaim*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/_identity_claims_claim_#keybaseclaim)

### `Const` proofFileName

▸ **proofFileName**(`address`: [Address](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)): *string*

*Defined in* [*packages/contractkit/src/identity/claims/keybase.ts:10*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/keybase.ts#L10)

**Parameters:**

| Name      | Type                                                                                                     |
| --------- | -------------------------------------------------------------------------------------------------------- |
| `address` | [Address](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference) |

**Returns:** *string*

### `Const` targetURL

▸ **targetURL**(`username`: string, `address`: [Address](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)): *string*

*Defined in* [*packages/contractkit/src/identity/claims/keybase.ts:11*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/keybase.ts#L11)

**Parameters:**

| Name       | Type                                                                                                     |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| `username` | string                                                                                                   |
| `address`  | [Address](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference) |

**Returns:** *string*

### verifyKeybaseClaim

▸ **verifyKeybaseClaim**(`kit`: [ContractKit](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference), `claim`: [KeybaseClaim](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/_identity_claims_claim_#keybaseclaim), `signer`: [Address](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)): *Promise‹string | undefined›*

*Defined in* [*packages/contractkit/src/identity/claims/keybase.ts:16*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/claims/keybase.ts#L16)

**Parameters:**

| Name     | Type                                                                                                             |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| `kit`    | [ContractKit](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)     |
| `claim`  | [KeybaseClaim](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/_identity_claims_claim_#keybaseclaim) |
| `signer` | [Address](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)         |

**Returns:** *Promise‹string | undefined›*