Class Web3IdSigner

A wrapper around an ed25519 keypair which is used by CIS4Contract methods for signing as various entities.

Hierarchy

Web3IdSigner

Index

Constructors

Properties

privateKey publicKey

Accessors

Methods

Constructors

constructor

new Web3IdSigner(privateKey: string, publicKey: string): Web3IdSigner
Builds a Web3IdSigner from ed25519 keypair
Parameters
- privateKey: string
  
  the ed25519 private key used for signing
- publicKey: string
  
  the ed25519 public key used for verifcation of signature
Returns Web3IdSigner
- Defined in packages/sdk/src/cis4/util.ts:421

Properties

`Private` privateKey

privateKey: string

the ed25519 private key used for signing

`Private` publicKey

publicKey: string

the ed25519 public key used for verifcation of signature

Accessors

pubKey

get pubKey(): string
Public key of signer

Returns string
- Defined in packages/sdk/src/cis4/util.ts:439

Methods

sign

sign(message: ArrayBuffer): Promise<Buffer>
Signs the message given

Returns
the signature on message
Parameters
- message: ArrayBuffer
  
  the message to sign
Returns Promise<Buffer>
- Defined in packages/sdk/src/cis4/util.ts:450

`Static` from

from(privateKey: string): Promise<Web3IdSigner>
Builds a Web3IdSigner from ed25519 private key

Returns
signer structure.
Parameters
- privateKey: string
  
  the ed25519 private key used for signing
Returns Promise<Web3IdSigner>
- Defined in packages/sdk/src/cis4/util.ts:433

Generated using TypeDoc