Skip to content

Commit 0034f5f

Browse files
committed
docs(identity): add links to zk-kit types
re #483
1 parent b4c2887 commit 0034f5f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

packages/identity/src/identity.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export default class Identity {
5353

5454
/**
5555
* Returns the private key.
56-
* @returns The private key as a bignumber-ish.
56+
* @returns The private key as a {@link https://zkkit.pse.dev/types/_zk_kit_utils.BigNumberish.html|BigNumberish}.
5757
*/
5858
public get privateKey(): BigNumberish {
5959
return this._privateKey
@@ -68,7 +68,7 @@ export default class Identity {
6868
}
6969

7070
/**
71-
* Returns the public key as a Baby Jubjub point.
71+
* Returns the public key as a Baby Jubjub {@link https://zkkit.pse.dev/types/_zk_kit_baby_jubjub.Point.html|Point}.
7272
* @returns The public key as a point.
7373
*/
7474
public get publicKey(): Point<string> {
@@ -93,7 +93,7 @@ export default class Identity {
9393
* const signature = identity.signMessage("message")
9494
*
9595
* @param message The message to be signed.
96-
* @returns A signature object containing the signature components.
96+
* @returns A {@link https://zkkit.pse.dev/types/_zk_kit_eddsa_poseidon.Signature.html|Signature} object containing the signature components.
9797
*/
9898
public signMessage(message: BigNumberish): Signature<string> {
9999
return signMessage(this.privateKey, message)

0 commit comments

Comments
 (0)