git ssb

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

Table of Contents

• onModuleInit
• MCLBN_CURVE_FP254BNB
• MCLBN_CURVE_FP382_1
• MCLBN_CURVE_FP382_2
• init
• secretKey
• publicKey
• signature
• free
• freeArray
• idSetInt
• sign
• verify
• publicKeyExport
• secretKeyExport
• signatureExport
• hashToSecretKey
• secretKeyDeserialize
• secretKeyImport
• publicKeyDeserialize
• publicKeyImport
• signatureDeserialize
• signatureImport
• secretKeyRecover
• publicKeyRecover
• signatureRecover
• secretKeyShare
• publicKeyShare

onModuleInit

index.js:13-20

takes a callback that is called once the module is setup

Parameters

• cb

MCLBN_CURVE_FP254BNB

index.js:25-25

the FP254BNB curve

MCLBN_CURVE_FP382_1

index.js:30-30

the FP382_1 curve

MCLBN_CURVE_FP382_2

index.js:35-35

the FP382_2 curve

init

index.js:52-54

intailizes the libary to use a given curve

Parameters

• curve number the curves that can be used are MCLBN_CURVE_FP254BNB, MCLBN_CURVE_FP382_1 or MCLBN_CURVE_FP382_2 (optional, default exports.MCLBN_CURVE_FP254BNB)

secretKey

index.js:60-62

allocates a secret key

Returns number the pointer to the key

publicKey

index.js:68-70

allocates a secret key

Returns number the pointer to the key

signature

index.js:76-78

allocates a signature

Returns number the pointer to the signture

free

index.js:83-85

frees a pointer

Parameters

• x

freeArray

index.js:90-92

frees an array of pointers

Parameters

• a

idSetInt

index.js:99-104

creates an ID to use in with threshold groups

Parameters

• sk number a pointer to the secret key, secret key stuct is used to hold the id
• n number a int repsenting the ID. n cannot be zero.

sign

index.js:112-112

signs a message

Parameters

• sig number a pointer to the a signature
• sk number a pointer to the secret key
• msg (TypedArray | String) the message to sign

verify

index.js:120-120

verifies a signature

Parameters

• sig number a pointer to the a signature
• pk number a pointer to the secret key
• msg (TypedArray | String) the message that was signed

publicKeyExport

index.js:127-127

given a pointer to a public key this returns 64 byte Int8Array containing the key

Parameters

• pk number a pointer to the secret key

Returns TypedArray

secretKeyExport

index.js:134-134

given a pointer to a secret key this returns 32 byte Int8Array containing the key

Parameters

• pk number a pointer to the secret key

Returns TypedArray

signatureExport

index.js:141-141

given a pointer to a signature this returns 32 byte Int8Array containing the signature

Parameters

• pk number a pointer to the secret key

Returns TypedArray

hashToSecretKey

index.js:148-148

generates a secret key given a seed phrase.

Parameters

• sk number a pointer to a secret key
• seed (String | TypedArray) the seed phrase

secretKeyDeserialize

index.js:155-155

write a secretKey to memory

Parameters

• sk number a pointer to a secret key
• array TypedArray the secret key as a 32 byte TypedArray

secretKeyImport

index.js:163-167

write a secretKey to memory and returns a pointer to it

Parameters

• buf
• sk number a pointer to a secret key
• array TypedArray the secret key as a 32 byte TypedArray

Returns Number

publicKeyDeserialize

index.js:174-174

write a publicKey to memory

Parameters

• sk number a pointer to a public key
• array TypedArray the secret key as a 64 byte TypedArray

publicKeyImport

index.js:181-185

write a publicKey to memory and returns a pointer to it

Parameters

• buf
• array TypedArray the secret key as a 64 byte TypedArray

Returns Number

signatureDeserialize

index.js:192-192

write a signature to memory

Parameters

• sig number a pointer to a signature
• array TypedArray the signature as a 32 byte TypedArray

signatureImport

index.js:199-203

write a signature to memory and returns a pointer to it

Parameters

• buf
• array TypedArray the signature as a 32 byte TypedArray

Returns Number

secretKeyRecover

index.js:211-211

Recovers a secret key for a group given the groups secret keys shares and the groups ids

Parameters

• sk number a pointer to a secret key that will be generated
• sksArray Array&lt;number> an array of pointers to the groups secret key shares. The length of the array should be the threshold number for the group
• idArrah Array&lt;numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group

publicKeyRecover

index.js:219-219

Recovers a public key for a group given the groups public keys shares and the groups ids

Parameters

• pk number a pointer to a secret key that will be generated
• pksArray Array&lt;number> an array of pointers to the groups public key shares. The length of the array should be the threshold number for the group
• idArrah Array&lt;numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group

signatureRecover

index.js:227-227

Recovers a signature for a group given the groups public keys shares and the groups ids

Parameters

• sig number a pointer to the signature that will be generated
• sigArray Array&lt;number> an array of pointers to signature shares. The length of the array should be the threshold number for the group
• idArrah Array&lt;numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group

secretKeyShare

index.js:235-235

Creates a secket key share for a group member given the groups members id (which is a the secret key) and array of master secret keys

Parameters

• skshare number a pointer to a secret key that will be generated
• msk Array&lt;number> an array of master secret keys. The number of keys is the threshould of the group.
• id number the id of the member

publicKeyShare

index.js:243-243

Creates a public key share for a group member given the groups members id (which is a the secret key) and array of master public keys

Parameters

• pkshare number a pointer to a secret key that will be generated
• mpk Array&lt;number> an array of master public keys. The number of keys is the threshould of the group.
• id number the id of the member