@gala-chain/connect ∙ API

---

API > WebSigner

Class: abstract WebSigner

Contents

• Extends
• Constructors
• new WebSigner(options)
• Properties
• address
• eventEmitter
• options
• provider
• Accessors
• ethereumAddress
• galaChainAddress
• Methods
• calculatePersonalSignPrefix()
• abstract connect()
• emit()
• getPublicKey()
• off()
• on()
• abstract sign()
• signMessage()
• submit()

Extends

• CustomClient

Constructors

new WebSigner(options)

new WebSigner(options?): WebSigner

Parameters

▪ options?: GalaChainProviderOptions

Overrides

CustomClient.constructor

Source

chain-connect/src/GalaChainClient.ts:156

Properties

address

protected address: string

Source

chain-connect/src/GalaChainClient.ts:153

---

eventEmitter

private eventEmitter: EventEmitter\<MetaMaskEvents>

Source

chain-connect/src/GalaChainClient.ts:174

---

options

protected options?: GalaChainProviderOptions

Inherited from

CustomClient.options

Source

chain-connect/src/GalaChainClient.ts:39

---

provider

protected provider: undefined | BrowserProvider

Source

chain-connect/src/GalaChainClient.ts:154

Accessors

ethereumAddress

get ethereumAddress(): string

set ethereumAddress(val): void

Parameters

▪ val: string

Source

chain-connect/src/GalaChainClient.ts:166

---

galaChainAddress

get galaChainAddress(): string

Source

chain-connect/src/GalaChainClient.ts:170

Methods

calculatePersonalSignPrefix()

calculatePersonalSignPrefix(payload): string

Parameters

▪ payload: object

Inherited from

CustomClient.calculatePersonalSignPrefix

Source

chain-connect/src/GalaChainClient.ts:138

---

abstract connect()

abstract connect(): Promise\<string>

Source

chain-connect/src/GalaChainClient.ts:160

---

emit()

emit(event, data): boolean

Parameters

▪ event: keyof MetaMaskEvents

▪ data: null | string | string[]

Source

chain-connect/src/GalaChainClient.ts:186

---

getPublicKey()

getPublicKey(): Promise\<object>

Overrides

CustomClient.getPublicKey

Source

chain-connect/src/GalaChainClient.ts:190

---

off()

off(event, listener): WebSigner

Parameters

▪ event: keyof MetaMaskEvents

▪ listener: Listener\<null | string | string[]>

Source

chain-connect/src/GalaChainClient.ts:181

---

on()

on(event, listener): WebSigner

Parameters

▪ event: keyof MetaMaskEvents

▪ listener: Listener\<null | string | string[]>

Source

chain-connect/src/GalaChainClient.ts:176

---

abstract sign()

abstract sign\<T>(method, dto, signingType?): Promise\<T & object>

Type parameters

▪ T extends object

Parameters

▪ method: string

▪ dto: T

▪ signingType?: SigningType

Inherited from

CustomClient.sign

Source

chain-connect/src/GalaChainClient.ts:48

---

signMessage()

signMessage(message): Promise\<string>

Parameters

▪ message: string

Source

chain-connect/src/GalaChainClient.ts:204

---

submit()

submit\<T, U>(__namedParameters): Promise\<GalaChainResponseSuccess\<T>>

Type parameters

▪ T

▪ U extends object

Parameters

▪ __namedParameters: object

▪ __namedParameters.headers?: Record\<string, string>

▪ __namedParameters.method: string

▪ __namedParameters.payload: ConstructorArgs\<U>

▪ __namedParameters.requestConstructor?: ClassConstructor\<ChainCallDTO>

▪ __namedParameters.responseConstructor?: NonArrayClassConstructor\<T>

▪ __namedParameters.sign?: boolean

▪ __namedParameters.signingType?: SigningType

▪ __namedParameters.url: string

Inherited from

CustomClient.submit

Source

chain-connect/src/GalaChainClient.ts:53