Class NetworkSigner

constructor

• new NetworkSigner(
      wpClient: IWalletProviderServiceClient | INoAuthWpServiceClient,
      authModule?: AuthModule,
  ): NetworkSigner

  Facade class used to execute operations on Silent Network.

  Parameters

  • wpClient: IWalletProviderServiceClient | INoAuthWpServiceClient

    Wallet Provider backend client

  • OptionalauthModule: AuthModule

    Authentication module, used to get confirmation from the User before request execution

  Returns NetworkSigner

authModule

wpClient

addEphemeralKey

• addEphemeralKey(
      keyIdList: string[],
      eph_claim: EphKeyClaim,
  ): Promise<AddEphKeyResponse[]>

  Add new ephemeral key to an exist distributed key on the network. Uses authModule to authenticate the request by the User.

  Parameters

  • keyIdList: string[]

    the list of key id returned from keygen

  • eph_claim: EphKeyClaim

    the claim to be added

  Returns Promise<AddEphKeyResponse[]>

  AddEphKeyResponse

deletePolicy

• deletePolicy(keyId: string): Promise<SimpleResponse>

  Delete user's key policy on the network. This will try to delete to all the available nodes on the network. Uses authModule to authenticate the request by the User.

  Parameters

  • keyId: string

    the key id returned from keygen

  Returns Promise<SimpleResponse>

  DeletePolicyResponse

generateKey

• generateKey(
      threshold: number,
      totalNodes: number,
      signAlgs: string[],
      ephClaim?: EphKeyClaim,
      policy?: Policy,
  ): Promise<KeygenResponse[]>

  Generate a distributed key that's generated by Silent Network. Uses authModule to authenticate the User with the Silent Network.

  Parameters

  • threshold: number

    Number of nodes that needs to participate in protocol in order to generate valid signature. Also known as t.

  • totalNodes: number

    Number of nodes that participate in keygen operation. Also known as n.

  • signAlgs: string[]

    signature algorithms for which MPC keys will be generated.

  • OptionalephClaim: EphKeyClaim
  • Optionalpolicy: Policy

    optional policy that will be stored in the key metadata. The policy are validated during sign requests.

  Returns Promise<KeygenResponse[]>

  KeygenResponse containing keyId and the pubKey public part of the key

refreshKey

• refreshKey(
      threshold: number,
      keyId: string,
      signAlg: MPCSignAlgorithm,
  ): Promise<KeygenResponse>

  Refreshes the secret key shares without changing the common public key of the distributed key that's generated by Silent Network. Uses authModule to authenticate the User with the Silent Network.

  Parameters

  • threshold: number

    Number of nodes that needs to participate in protocol in order to generate valid signature. Also known as t.

  • keyId: string

    the key id returned from keygen

  • signAlg: MPCSignAlgorithm

    signature algorithm of the refresh key.

  Returns Promise<KeygenResponse>

  KeyRefreshResponse containing keyId, pubKey, signAlg

registerPasskey

• registerPasskey(options?: string): Promise<RegisterPasskeyResponse>

  Register new user's passkey on the network. This will try to register to all the available nodes on the network. Uses authModule to authenticate the request by the User.

  Parameters

  • Optionaloptions: string

    the options to customize the passkey authentication

  Returns Promise<RegisterPasskeyResponse>

  RegisterPasskeyResponse

revokeEphemeralKey

• revokeEphemeralKey(
      keyId: string,
      eph_claim: EphKeyClaim,
  ): Promise<SimpleResponse>

  Revoke ephemeral key of an exist distributed key on the network. Uses authModule to authenticate the request by the User.

  Parameters

  • keyId: string

    the key id returned from keygen

  • eph_claim: EphKeyClaim

    the claim to be revoked

  Returns Promise<SimpleResponse>

  RevokeEphKeyResponse

signMessage

• signMessage(
      threshold: number,
      keyId: string,
      signAlg: MPCSignAlgorithm,
      signRequest: string,
  ): Promise<SignResponse[]>

  Generate a signature by the distributed key of Silent Network. Uses authModule to authenticate the sign request by the User. The network chooses t nodes to execute the protocol.

  Parameters

  • threshold: number

    Number of nodes that needs to participate in protocol in order to generate valid signature. Also known as t.

  • keyId: string

    the key id returned from keygen

  • signAlg: MPCSignAlgorithm

    the signature algorithm to use for MPC signing, different form signAlg inside EphKeyClaim

  • signRequest: string

    the sign request containing the transaction id, request type and message to sign

  Returns Promise<SignResponse[]>

  SignResponse

updatePolicy

• updatePolicy(keyId: string, policy: Policy): Promise<SimpleResponse>

  Update user's key policy on the network. This will try to update to all the available nodes on the network. Uses authModule to authenticate the request by the User.

  Parameters

  • keyId: string

    the key id returned from keygen

  • policy: Policy

    the key policy to be updated

  Returns Promise<SimpleResponse>

  UpdatePolicyResponse

validateQuorumSetup

• validateQuorumSetup(
      __namedParameters: { threshold?: number; totalNodes?: number },
  ): void

  Parameters

  • __namedParameters: { threshold?: number; totalNodes?: number }

  Returns void