\ No newline at end of file
diff --git a/classes/_semaphore_protocol_data.SemaphoreSubgraph.html b/classes/_semaphore_protocol_data.SemaphoreSubgraph.html
new file mode 100644
index 000000000..d1c2128be
--- /dev/null
+++ b/classes/_semaphore_protocol_data.SemaphoreSubgraph.html
@@ -0,0 +1,33 @@
+SemaphoreSubgraph | Semaphore SDK
\ No newline at end of file
diff --git a/classes/_semaphore_protocol_group.Group.html b/classes/_semaphore_protocol_group.Group.html
new file mode 100644
index 000000000..6e744a901
--- /dev/null
+++ b/classes/_semaphore_protocol_group.Group.html
@@ -0,0 +1,58 @@
+Group | Semaphore SDK
The Semaphore group is a LeanIMT
+(Lean Incremental Merkle Tree), i.e. an optimized version of the incremental binary Merkle tree
+used by Semaphore V3. The new tree does not use zero hashes, and its depth is dynamic.
+The members of a Semaphore group, or the leaves of a tree, are the identity commitments.
+Thanks to the properties of Merkle trees, it can be efficiently demonstrated that a group
+member belongs to the group.
+This class supports operations such as member addition, update, removal and Merkle proof
+generation and verification. Groups can also be exported or imported.
Creates a new instance of the Group. Optionally, a list of identity commitments can
+be passed as a parameter. Adding members in chunks is more efficient than adding
+them one by one with the addMember function.
Returns the members (i.e. identity commitments) of the group.
+
Returns bigint[]
The list of members of the group.
+
root
get root(): bigint
Returns the root hash of the tree.
+
Returns bigint
The root hash as a string.
+
size
get size(): number
Returns the size of the tree (i.e. number of leaves).
+
Returns number
The tree size as a number.
+
Methods
addMember
addMember(member): void
Adds a new member to the group.
+
Parameters
member: BigNumber
The new member to be added.
+
Returns void
addMembers
addMembers(members): void
Adds new members to the group.
+
Parameters
members: BigNumber[]
New members.
+
Returns void
export
export(): string
Enables the conversion of the group into a JSON string that
+can be re-used for future imports. This approach is beneficial for
+large groups, as it avoids re-calculating the tree hashes.
Imports an entire group by initializing the tree without calculating
+any hashes. Note that it is crucial to ensure the integrity of the
+exported group.
\ No newline at end of file
diff --git a/classes/_semaphore_protocol_heyauthn.HeyAuthn.html b/classes/_semaphore_protocol_heyauthn.HeyAuthn.html
new file mode 100644
index 000000000..d452e0743
--- /dev/null
+++ b/classes/_semaphore_protocol_heyauthn.HeyAuthn.html
@@ -0,0 +1,17 @@
+HeyAuthn | Semaphore SDK
\ No newline at end of file
diff --git a/classes/_semaphore_protocol_heyauthn.Identity.html b/classes/_semaphore_protocol_heyauthn.Identity.html
new file mode 100644
index 000000000..33d67ae7a
--- /dev/null
+++ b/classes/_semaphore_protocol_heyauthn.Identity.html
@@ -0,0 +1,55 @@
+Identity | Semaphore SDK
The Semaphore identity is essentially an EdDSA
+public/private key pair. The EdDSA implementation
+in this library uses Baby Jubjub for public key generation
+and Poseidon for signatures.
+In addition, the commitment, i.e. the hash of the public key, is used to represent
+Semaphore identities in groups, adding an additional layer of privacy and security.
+The private key of the identity is stored as a hexadecimal string or text.
+The other attributes are stored as stringified bigint.
Initializes the class attributes based on a given private key, which must be a hexadecimal string or a text.
+Hexadecimal strings must not start with '0x' or '0X'.
+If the private key is not passed as a parameter, a random hexadecimal key will be generated.
+The EdDSAPoseidon class is used to generate the secret scalar and the public key.
+Additionally, the constructor computes a commitment of the public key using a hash function (Poseidon).
+
Parameters
OptionalprivateKey: string
The private key used to derive the public key (hexadecimal or string).
Generates a signature for a given message using the private key.
+This method demonstrates how to sign a message and could be used
+for authentication or data integrity.
+
Parameters
message: BigNumberish
The message to be signed.
+
Returns Signature<bigint>
A Signature object containing the signature components.
Verifies a signature against a given message and public key.
+This static method allows for the verification of signatures without needing
+an instance of the Identity class. It's useful for cases where you only have
+the public key, the message and a signature, and need to verify if they match.
+
Parameters
message: BigNumberish
The message that was signed.
+
signature: Signature
The signature to verify.
+
publicKey: Point
The public key to use for verification.
+
Returns boolean
A boolean indicating whether the signature is valid.
\ No newline at end of file
diff --git a/classes/_semaphore_protocol_identity.Identity.html b/classes/_semaphore_protocol_identity.Identity.html
new file mode 100644
index 000000000..73555833d
--- /dev/null
+++ b/classes/_semaphore_protocol_identity.Identity.html
@@ -0,0 +1,55 @@
+Identity | Semaphore SDK
The Semaphore identity is essentially an EdDSA
+public/private key pair. The EdDSA implementation
+in this library uses Baby Jubjub for public key generation
+and Poseidon for signatures.
+In addition, the commitment, i.e. the hash of the public key, is used to represent
+Semaphore identities in groups, adding an additional layer of privacy and security.
+The private key of the identity is stored as a hexadecimal string or text.
+The other attributes are stored as stringified bigint.
Initializes the class attributes based on a given private key, which must be a hexadecimal string or a text.
+Hexadecimal strings must not start with '0x' or '0X'.
+If the private key is not passed as a parameter, a random hexadecimal key will be generated.
+The EdDSAPoseidon class is used to generate the secret scalar and the public key.
+Additionally, the constructor computes a commitment of the public key using a hash function (Poseidon).
+
Parameters
OptionalprivateKey: string
The private key used to derive the public key (hexadecimal or string).
Generates a signature for a given message using the private key.
+This method demonstrates how to sign a message and could be used
+for authentication or data integrity.
+
Parameters
message: BigNumberish
The message to be signed.
+
Returns Signature<bigint>
A Signature object containing the signature components.
Verifies a signature against a given message and public key.
+This static method allows for the verification of signatures without needing
+an instance of the Identity class. It's useful for cases where you only have
+the public key, the message and a signature, and need to verify if they match.
+
Parameters
message: BigNumberish
The message that was signed.
+
signature: Signature
The signature to verify.
+
publicKey: Point
The public key to use for verification.
+
Returns boolean
A boolean indicating whether the signature is valid.
\ No newline at end of file
diff --git a/functions/_semaphore_protocol_proof.generateProof.html b/functions/_semaphore_protocol_proof.generateProof.html
new file mode 100644
index 000000000..783333d30
--- /dev/null
+++ b/functions/_semaphore_protocol_proof.generateProof.html
@@ -0,0 +1,19 @@
+generateProof | Semaphore SDK
It generates a Semaphore proof, i.e. a zero-knowledge proof that an identity that
+is part of a group has shared an anonymous message.
+The message may be any arbitrary user-defined value (e.g. a vote), or the hash of that value.
+The scope is a value used like a topic on which users can generate a valid proof only once,
+for example the id of an election in which voters can only vote once.
+The hash of the identity's scope and secret scalar is called a nullifier and can be
+used to verify whether that identity has already generated a valid proof in that scope.
+The depth of the tree determines which zero-knowledge artifacts to use to generate the proof.
+If it is not defined, it will be inferred from the group or Merkle proof passed as the second parameter.
+Finally, the artifacts themselves can be passed manually with file paths,
+or they will be automatically fetched.
\ No newline at end of file
diff --git a/functions/_semaphore_protocol_proof.packGroth16Proof.html b/functions/_semaphore_protocol_proof.packGroth16Proof.html
new file mode 100644
index 000000000..53abb7246
--- /dev/null
+++ b/functions/_semaphore_protocol_proof.packGroth16Proof.html
@@ -0,0 +1,4 @@
+packGroth16Proof | Semaphore SDK
\ No newline at end of file
diff --git a/functions/_semaphore_protocol_proof.unpackGroth16Proof.html b/functions/_semaphore_protocol_proof.unpackGroth16Proof.html
new file mode 100644
index 000000000..8e6b98756
--- /dev/null
+++ b/functions/_semaphore_protocol_proof.unpackGroth16Proof.html
@@ -0,0 +1,4 @@
+unpackGroth16Proof | Semaphore SDK
\ No newline at end of file
diff --git a/functions/_semaphore_protocol_proof.verifyProof.html b/functions/_semaphore_protocol_proof.verifyProof.html
new file mode 100644
index 000000000..5552658d8
--- /dev/null
+++ b/functions/_semaphore_protocol_proof.verifyProof.html
@@ -0,0 +1,5 @@
+verifyProof | Semaphore SDK
Verifies whether a Semaphore proof is valid. Depending on the depth of the tree used to
+generate the proof, a different verification key will be used.
\ No newline at end of file
diff --git a/functions/_semaphore_protocol_utils.decodeMessage.html b/functions/_semaphore_protocol_utils.decodeMessage.html
new file mode 100644
index 000000000..d558a38c3
--- /dev/null
+++ b/functions/_semaphore_protocol_utils.decodeMessage.html
@@ -0,0 +1,9 @@
+decodeMessage | Semaphore SDK
Typically used for decoding on-chain Semaphore messages.
+When Semaphore messages are text they are converted to bigints before
+the proof is generated (and eventually sent on-chain).
+This function help devs converting bigint messages to text again.
+If the original message was not text the output of this
+function won't probably be human-readable text.
\ No newline at end of file
diff --git a/functions/_semaphore_protocol_utils.getDeployedContract.html b/functions/_semaphore_protocol_utils.getDeployedContract.html
new file mode 100644
index 000000000..5052e57db
--- /dev/null
+++ b/functions/_semaphore_protocol_utils.getDeployedContract.html
@@ -0,0 +1,4 @@
+getDeployedContract | Semaphore SDK
\ No newline at end of file
diff --git a/functions/_semaphore_protocol_utils.getHardhatNetworks.html b/functions/_semaphore_protocol_utils.getHardhatNetworks.html
new file mode 100644
index 000000000..d05935d7e
--- /dev/null
+++ b/functions/_semaphore_protocol_utils.getHardhatNetworks.html
@@ -0,0 +1,5 @@
+getHardhatNetworks | Semaphore SDK
\ No newline at end of file
diff --git a/functions/_semaphore_protocol_utils.isSupportedNetwork.html b/functions/_semaphore_protocol_utils.isSupportedNetwork.html
new file mode 100644
index 000000000..de21ac7fb
--- /dev/null
+++ b/functions/_semaphore_protocol_utils.isSupportedNetwork.html
@@ -0,0 +1,3 @@
+isSupportedNetwork | Semaphore SDK
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100644
index 000000000..b287a4e60
--- /dev/null
+++ b/index.html
@@ -0,0 +1,333 @@
+Semaphore SDK
Semaphore is a generic privacy layer. Leveraging zero-knowledge technology, users can prove their membership in groups and send messages (extending from votes to endorsements) off-chain or across EVM-compatible blockchains, all without revealing their personal identity.
+
+
+
+
The core of the Semaphore protocol is in the circuit logic. However, Semaphore also provides Solidity contracts and JavaScript libraries to make the steps for offchain proof creation and onchain/offchain verification easier. To learn more about Semaphore visit semaphore.pse.dev.
yarnversion:bump <version> # e.g. yarn version:bump 2.0.0
+
+
It will create a commit and a git tag that will need to pushed on the main branch. A workflow will be triggered and will
+publish the Semaphore packages on npm and release a new version on Github with its changelogs automatically.
\ No newline at end of file
diff --git a/modules/_semaphore_protocol_core.html b/modules/_semaphore_protocol_core.html
new file mode 100644
index 000000000..b364cb8b1
--- /dev/null
+++ b/modules/_semaphore_protocol_core.html
@@ -0,0 +1,64 @@
+@semaphore-protocol/core | Semaphore SDK
This library is a simple re-export of the Semaphore core libraries: @semaphore-protocol/identity, @semaphore-protocol/group, @semaphore-protocol/proof. So that developers can install a single package to use all the core functionalities of the protocol.
\ No newline at end of file
diff --git a/modules/_semaphore_protocol_data.html b/modules/_semaphore_protocol_data.html
new file mode 100644
index 000000000..53865812a
--- /dev/null
+++ b/modules/_semaphore_protocol_data.html
@@ -0,0 +1,117 @@
+@semaphore-protocol/data | Semaphore SDK
This library allows you to query the Semaphore.sol contract data (i.e. groups) using the Semaphore subgraph or Ethers. It can be used on Node.js and browsers.
\ No newline at end of file
diff --git a/modules/_semaphore_protocol_group.html b/modules/_semaphore_protocol_group.html
new file mode 100644
index 000000000..76d0f819d
--- /dev/null
+++ b/modules/_semaphore_protocol_group.html
@@ -0,0 +1,95 @@
+@semaphore-protocol/group | Semaphore SDK
This library is an abstraction of the LeanIMT data structure (part of @zk-kit/imt). The main goal is to make it easier to create offchain groups, which are also used to generate Semaphore proofs. Semaphore groups are actually Merkle trees, and the group members are tree leaves.
\ No newline at end of file
diff --git a/modules/_semaphore_protocol_heyauthn.html b/modules/_semaphore_protocol_heyauthn.html
new file mode 100644
index 000000000..3a1190f34
--- /dev/null
+++ b/modules/_semaphore_protocol_heyauthn.html
@@ -0,0 +1,79 @@
+@semaphore-protocol/heyauthn | Semaphore SDK
This library allows developers to create and manage Semaphore identities using WebAuthn as a cross-device biometric authentication in a way that is more convenient, smoother and secure than localStorage, Chrome extensions, or password manager based solutions.
// Now you could also save the identity commitment in your DB (pseudocode). fetch("/api/register"/* Replace this with your endpoint */, { identity.commitment // ... })
// STEP 3: Authenticate existing WebAuthn credential and signal.
// Get existing group and signal anonymously (pseudocode). import { Group } from"@semaphore-protocol/group" import { generateProof } from"@semaphore-protocol/proof" import { utils } from"ethers"
\ No newline at end of file
diff --git a/modules/_semaphore_protocol_identity.html b/modules/_semaphore_protocol_identity.html
new file mode 100644
index 000000000..c6755acd0
--- /dev/null
+++ b/modules/_semaphore_protocol_identity.html
@@ -0,0 +1,76 @@
+@semaphore-protocol/identity | Semaphore SDK
This library provides a class that can be used to create identities compatible with the Semaphore circuits. Each identity contains an EdDSA private key, its public key, and the identity commitment, which is the Poseidon hash of the public key.
\ No newline at end of file
diff --git a/modules/_semaphore_protocol_proof.html b/modules/_semaphore_protocol_proof.html
new file mode 100644
index 000000000..aaaf96149
--- /dev/null
+++ b/modules/_semaphore_protocol_proof.html
@@ -0,0 +1,85 @@
+@semaphore-protocol/proof | Semaphore SDK
This library provides utility functions to generate and verify Semaphore proofs compatible with the Semaphore circuits. Generating valid zero-knowledge proofs requires files that can only be obtained in an attested trusted-setup ceremony.
\ No newline at end of file
diff --git a/modules/_semaphore_protocol_utils.constants.html b/modules/_semaphore_protocol_utils.constants.html
new file mode 100644
index 000000000..2f82f13c8
--- /dev/null
+++ b/modules/_semaphore_protocol_utils.constants.html
@@ -0,0 +1,3 @@
+constants | Semaphore SDK
\ No newline at end of file
diff --git a/modules/_semaphore_protocol_utils.html b/modules/_semaphore_protocol_utils.html
new file mode 100644
index 000000000..9f74f9f5d
--- /dev/null
+++ b/modules/_semaphore_protocol_utils.html
@@ -0,0 +1,70 @@
+@semaphore-protocol/utils | Semaphore SDK
For more information on the functions and modules provided by @semaphore-protocol/utils, please refer to the TypeDoc documentation.
+
// You can import functions/parameters from the main bundle. import { supportedNetworks, decodeMessage } from"@semaphore-protocol/utils"
// Or by using conditional exports. importsupportedNetworksfrom"@semaphore-protocol/utils/supported-networks" importdecodeMessagefrom"@semaphore-protocol/utils/decode-message"
+
\ No newline at end of file
diff --git a/types/_semaphore_protocol_data.EthersNetwork.html b/types/_semaphore_protocol_data.EthersNetwork.html
new file mode 100644
index 000000000..ebd99855e
--- /dev/null
+++ b/types/_semaphore_protocol_data.EthersNetwork.html
@@ -0,0 +1 @@
+EthersNetwork | Semaphore SDK
\ No newline at end of file
diff --git a/types/_semaphore_protocol_data.EthersOptions.html b/types/_semaphore_protocol_data.EthersOptions.html
new file mode 100644
index 000000000..be3e76300
--- /dev/null
+++ b/types/_semaphore_protocol_data.EthersOptions.html
@@ -0,0 +1 @@
+EthersOptions | Semaphore SDK
\ No newline at end of file
diff --git a/types/_semaphore_protocol_data.GroupOptions.html b/types/_semaphore_protocol_data.GroupOptions.html
new file mode 100644
index 000000000..324970971
--- /dev/null
+++ b/types/_semaphore_protocol_data.GroupOptions.html
@@ -0,0 +1 @@
+GroupOptions | Semaphore SDK
\ No newline at end of file
diff --git a/types/_semaphore_protocol_data.GroupResponse.html b/types/_semaphore_protocol_data.GroupResponse.html
new file mode 100644
index 000000000..e5b896afe
--- /dev/null
+++ b/types/_semaphore_protocol_data.GroupResponse.html
@@ -0,0 +1 @@
+GroupResponse | Semaphore SDK
\ No newline at end of file
diff --git a/types/_semaphore_protocol_group.MerkleProof.html b/types/_semaphore_protocol_group.MerkleProof.html
new file mode 100644
index 000000000..2ae9060da
--- /dev/null
+++ b/types/_semaphore_protocol_group.MerkleProof.html
@@ -0,0 +1,9 @@
+MerkleProof | Semaphore SDK
The Merkle Proof contains the necessary parameters to enable the
+verifier to be certain that a leaf belongs to the tree. Given the value
+of the leaf and its index, it is possible to traverse the tree by
+recalculating the hashes up to the root and using the node siblings.
+If the calculated root matches the root in the proof, then the leaf
+belongs to the tree. It's important to note that the function used
+to generate the proof and the one used to verify it must use the
+same hash function.
\ No newline at end of file
diff --git a/types/_semaphore_protocol_heyauthn.AuthenticationOptions.html b/types/_semaphore_protocol_heyauthn.AuthenticationOptions.html
new file mode 100644
index 000000000..8b2ebb350
--- /dev/null
+++ b/types/_semaphore_protocol_heyauthn.AuthenticationOptions.html
@@ -0,0 +1 @@
+AuthenticationOptions | Semaphore SDK
\ No newline at end of file
diff --git a/types/_semaphore_protocol_heyauthn.RegistrationOptions.html b/types/_semaphore_protocol_heyauthn.RegistrationOptions.html
new file mode 100644
index 000000000..b0c4dba21
--- /dev/null
+++ b/types/_semaphore_protocol_heyauthn.RegistrationOptions.html
@@ -0,0 +1 @@
+RegistrationOptions | Semaphore SDK
\ No newline at end of file
diff --git a/types/_semaphore_protocol_proof.SemaphoreProof.html b/types/_semaphore_protocol_proof.SemaphoreProof.html
new file mode 100644
index 000000000..c999ccf57
--- /dev/null
+++ b/types/_semaphore_protocol_proof.SemaphoreProof.html
@@ -0,0 +1 @@
+SemaphoreProof | Semaphore SDK
\ No newline at end of file
diff --git a/types/_semaphore_protocol_proof.SnarkArtifacts.html b/types/_semaphore_protocol_proof.SnarkArtifacts.html
new file mode 100644
index 000000000..be60d7edd
--- /dev/null
+++ b/types/_semaphore_protocol_proof.SnarkArtifacts.html
@@ -0,0 +1 @@
+SnarkArtifacts | Semaphore SDK
\ No newline at end of file
diff --git a/types/_semaphore_protocol_utils.SupportedNetwork.html b/types/_semaphore_protocol_utils.SupportedNetwork.html
new file mode 100644
index 000000000..7a8b62623
--- /dev/null
+++ b/types/_semaphore_protocol_utils.SupportedNetwork.html
@@ -0,0 +1 @@
+SupportedNetwork | Semaphore SDK
\ No newline at end of file
diff --git a/variables/_semaphore_protocol_utils.constants.MAX_DEPTH.html b/variables/_semaphore_protocol_utils.constants.MAX_DEPTH.html
new file mode 100644
index 000000000..37bc684a3
--- /dev/null
+++ b/variables/_semaphore_protocol_utils.constants.MAX_DEPTH.html
@@ -0,0 +1 @@
+MAX_DEPTH | Semaphore SDK
\ No newline at end of file
diff --git a/variables/_semaphore_protocol_utils.constants.MIN_DEPTH.html b/variables/_semaphore_protocol_utils.constants.MIN_DEPTH.html
new file mode 100644
index 000000000..199b6b41f
--- /dev/null
+++ b/variables/_semaphore_protocol_utils.constants.MIN_DEPTH.html
@@ -0,0 +1 @@
+MIN_DEPTH | Semaphore SDK
\ No newline at end of file
diff --git a/variables/_semaphore_protocol_utils.defaultNetwork.html b/variables/_semaphore_protocol_utils.defaultNetwork.html
new file mode 100644
index 000000000..928d84cb8
--- /dev/null
+++ b/variables/_semaphore_protocol_utils.defaultNetwork.html
@@ -0,0 +1 @@
+defaultNetwork | Semaphore SDK
\ No newline at end of file
diff --git a/variables/_semaphore_protocol_utils.deployedContracts.html b/variables/_semaphore_protocol_utils.deployedContracts.html
new file mode 100644
index 000000000..1787c820a
--- /dev/null
+++ b/variables/_semaphore_protocol_utils.deployedContracts.html
@@ -0,0 +1 @@
+deployedContracts | Semaphore SDK
\ No newline at end of file
diff --git a/variables/_semaphore_protocol_utils.supportedNetworks.html b/variables/_semaphore_protocol_utils.supportedNetworks.html
new file mode 100644
index 000000000..b76db7653
--- /dev/null
+++ b/variables/_semaphore_protocol_utils.supportedNetworks.html
@@ -0,0 +1 @@
+supportedNetworks | Semaphore SDK
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
Initializes the Ethers object with an Ethereum network or custom URL.
+