Skip to content

Latest commit

 

History

History
359 lines (204 loc) · 5.79 KB

SignerService.md

File metadata and controls

359 lines (204 loc) · 5.79 KB

Class: SignerService

Table of contents

Constructors

Accessors

Methods

Constructors

constructor

new SignerService(_signer, _providerType)

Parameters

Name Type
_signer Required<SignerT>
_providerType ProviderType

Accessors

accountInfo

get accountInfo(): AccountInfo

Returns

AccountInfo


address

get address(): string

Returns

string


chainId

get chainId(): number

Returns

number


did

get did(): string

Returns

string


didHex

get didHex(): string

Returns

string


isEthSigner

get isEthSigner(): boolean

Returns

boolean


provider

get provider(): Provider

Returns

Provider


providerType

get providerType(): ProviderType

Returns

ProviderType


signer

get signer(): Required<SignerT>

Returns

Required<SignerT>

Methods

balance

balance(): Promise<BigNumber>

Returns

Promise<BigNumber>


call

call(__namedParameters): Promise<string>

Makes a (readonly) call to a smart contract https://docs.ethers.io/v5/single-page/#/v5/api/providers/provider/-%23-Provider-call

Parameters

Name Type
__namedParameters TransactionRequest

Returns

Promise<string>

The result of the call


chainName

chainName(): string

Returns

string


closeConnection

closeConnection(): Promise<boolean>

Returns

Promise<boolean>


connect

connect(signer, providerType): Promise<void>

Parameters

Name Type
signer Required<SignerT>
providerType ProviderType

Returns

Promise<void>


emit

emit(e): Promise<void>

Parameters

Name Type
e ProviderEvent

Returns

Promise<void>


init

init(): Promise<void>

Returns

Promise<void>


initEventHandlers

initEventHandlers(): void

Add event handler for certain events

requires to be called after the connection to wallet was initialized

Returns

void


on

on(event, cb): void

Parameters

Name Type
event ProviderEvent
cb any

Returns

void


onInit

onInit(initializer): void

Registers reinitialization of dependent service on signer reconnection

Parameters

Name Type
initializer ServiceInitializer

Returns

void


publicKey

publicKey(): Promise<string>

Returns

Promise<string>


publicKeyAndIdentityToken

publicKeyAndIdentityToken(): Promise<IPubKeyAndIdentityToken>

Returns

Promise<IPubKeyAndIdentityToken>


send

send(__namedParameters): Promise<TransactionReceipt>

Parameters

Name Type
__namedParameters TransactionRequest

Returns

Promise<TransactionReceipt>


signMessage

signMessage(message): Promise<string>

description Tries to create eth_sign conformant signature (https://eth.wiki/json-rpc/API#eth_sign) Whether or not to hash the message prior to signature is determined by signature performed during login. When running in browser isEthSigner variable should be stored in local storage

Parameters

Name Type Description
message Uint8Array The message to be signed. The message should have binary representation to avoid confusion of text with hexadecimal binary data

Returns

Promise<string>


signTypedData

signTypedData(domain, types, message): Promise<string>

description Tries to create conformant signature (https://eips.ethereum.org/EIPS/eip-712)

Parameters

Name Type
domain TypedDataDomain
types Record<string, TypedDataField[]>
message Record<string, unknown>

Returns

Promise<string>