Semaphore identity
A library to create Semaphore identities.
| This library provides a class that can be used to create identities compatible with the Semaphore [circuits](https://github.com/semaphore-protocol/semaphore/tree/main/circuits). Each identity contains an [EdDSA](https://www.rfc-editor.org/rfc/rfc8032) private key, its public key, and the identity commitment, which is the [Poseidon](https://eprint.iacr.org/2019/458.pdf) hash of the public key. |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
## 🛠 Install
### npm or yarn
Install the `@semaphore-protocol/identity` package with npm:
```bash
npm i @semaphore-protocol/identity
```
or yarn:
```bash
yarn add @semaphore-protocol/identity
```
## 📜 Usage
For more information on the functions provided by `@semaphore-protocol/identity`, please refer to the [TypeDoc documentation](https://js.semaphore.pse.dev/modules/_semaphore_protocol_identity).
\# **new Identity**(privateKey?: _BigNumberish_): _Identity_
```typescript
import { Identity } from "@semaphore-protocol/identity"
// The identity will be generated randomly.
const { privateKey, publicKey, commitment } = new Identity()
// Alternatively, you can pass your private key.
const identity = new Identity("your-private-key")
```
\# **identity.export**(): _string_
```typescript
import { Identity } from "@semaphore-protocol/identity"
const identity = new Identity()
const privateKey = identity.export()
```
\# **identity.import**(privateKey: _string_): _Identity_
```typescript
import { Identity } from "@semaphore-protocol/identity"
const identity = new Identity()
const privateKey = identity.export()
const identity2 = Identity.import(privateKey)
```
\# **identity.signMessage**(message: _BigNumberish_): _Signature\_
```typescript
import { Identity } from "@semaphore-protocol/identity"
const message = "message"
const identity = new Identity()
const signature = identity.signMessage(message)
```
\# **Identity.verifySignature**(message: _BigNumberish_, signature: _Signature_, publicKey: _Point_): _boolean_
```typescript
import { Identity } from "@semaphore-protocol/identity"
const message = "message"
const identity = new Identity()
const signature = identity.signMessage(message)
Identity.verifySignature(message, signature, identity.publicKey)
```
\# **Identity.generateCommitment**(publicKey: _Point_): _bigint_
```typescript
import { Identity } from "@semaphore-protocol/identity"
Identity.generateCommitment(identity.publicKey)
```