Class AbstractWalletController`Abstract`

Description

It's an abstract class designated to define an interface to send messages through blockchain and publish public keys

Example

Example of how to define your own ancestor:

import { AbstractWalletController } from '@ylide/sdk';

class EverscaleWalletController extends AbstractWalletController {
    readonly registryContract: RegistryContract;

    constructor(options: { dev?: boolean } = {}) {
        super(options);

        // ...
    }

    async attachPublicKey(publicKey: Uint8Array) {
          const me = await this.getAuthenticatedAccount();
          if (!me) {
              throw new Error('Not authorized');
          }
          await this.blockchainController.registryContract.attachPublicKey(me.address, publicKey);
    }

    // Other implementations ...
}

Hierarchy

EventEmitter<WalletEvent>
- AbstractWalletController

Constructors

constructor

new AbstractWalletController(options?: any): AbstractWalletController
Parameters
- Optional options: any
Returns AbstractWalletController
Overrides EventEmitter<WalletEvent>.constructor
- Defined in src/abstracts/AbstractWalletController.ts:55

Properties

onSwitchAccountRequest

onSwitchAccountRequest: null | SwitchAccountCallback = null

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): AbstractWalletController
Type Parameters
- T extends WalletEvent
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns AbstractWalletController
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:45

`Abstract` addressToUint256

addressToUint256(address: string): Uint256
Method to convert address to 32 bytes lowercase hex string (widely used in SDK)
Parameters
- address: string
Returns Uint256
- Defined in src/abstracts/AbstractWalletController.ts:181

`Abstract` attachPublicKey

attachPublicKey(account: WalletAccount<any>, publicKey: Uint8Array, keyVersion: YlideKeyVersion, registrar: number, options?: any): Promise<void>
Method to register user's public key, so other users can discover it and send him messages.
Parameters
- account: WalletAccount<any>
  
  Account for which connection should occur
- publicKey: Uint8Array
  
  public key to attach to user's address
- keyVersion: YlideKeyVersion
  
  version of the key (e.g. YlideKeyVersion.KEY_V3)
- registrar: number
  
  registrar code (e.g. 1 for Ylide Social Hub)
- Optional options: any
  
  additional options for this wallet (e.g. "network" for EVM-wallets)
Returns Promise<void>
- Defined in src/abstracts/AbstractWalletController.ts:170

`Abstract` blockchainGroup

blockchainGroup(): string
Method to get blockchain group name

Description
Blockchain group is a name of the group of blockchains which are compatible with each other (e.g. "evm")

Returns string
- Defined in src/abstracts/AbstractWalletController.ts:81

`Abstract` decryptMessageKey

decryptMessageKey(recipientAccount: WalletAccount<any>, senderPublicKey: EncryptionPublicKey, encryptedKey: Uint8Array): Promise<Uint8Array>
Method to decrypt message key using native wallet encryption system
Parameters
- recipientAccount: WalletAccount<any>
  
  Account of the recipient
- senderPublicKey: EncryptionPublicKey
  
  Public key of the sender (needed to calculate shared secret key)
- encryptedKey: Uint8Array
  
  Encrypted message key bytes
Returns Promise<Uint8Array>
- Defined in src/abstracts/AbstractWalletController.ts:190

`Abstract` disconnectAccount

disconnectAccount(account: WalletAccount<any>): Promise<void>
Method to request wallet to revoke authenticaion of this app
Parameters
- account: WalletAccount<any>
Returns Promise<void>
- Defined in src/abstracts/AbstractWalletController.ts:119

emit

emit<T>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends WalletEvent
Parameters
- event: T
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): WalletEvent[]
Return an array listing the events for which the emitter has registered listeners.

Returns WalletEvent[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:15

`Abstract` getAuthenticatedAccount

getAuthenticatedAccount(): Promise<null | WalletAccount<any>>
Method to get account currently authenticated by the wallet for this app

Returns Promise<null | WalletAccount<any>>
- Defined in src/abstracts/AbstractWalletController.ts:109

`Abstract` getCurrentBlockchain

getCurrentBlockchain(): Promise<string>
Method to get name of the currently selected blockchain in this wallet

Returns Promise<string>
- Defined in src/abstracts/AbstractWalletController.ts:104

`Abstract` getFaucet

getFaucet(options?: any): Promise<AbstractFaucetService>
Method to get Ylide faucet service for this wallet
Parameters
- Optional options: any
  
  additional options for this wallet (e.g. "faucetType" for EVM-wallets)
Returns Promise<AbstractFaucetService>
- Defined in src/abstracts/AbstractWalletController.ts:206

`Abstract` init

init(): Promise<void>
Method to init controller. Must be called once before any other method. Automatically called when you instantiate using Ylide signleton.

Returns Promise<void>
- Defined in src/abstracts/AbstractWalletController.ts:92

`Abstract` isFaucetAvailable

isFaucetAvailable(): boolean
Method to get whether Ylide faucet is generally available for this wallet or not

Returns boolean
- Defined in src/abstracts/AbstractWalletController.ts:199

`Abstract` isMultipleAccountsSupported

isMultipleAccountsSupported(): boolean
Method to get whether wallet natively supports multiple accounts connection or not If not - you can still emulate multiaccounts by connection/disconnecting accounts automatically

Returns boolean
- Defined in src/abstracts/AbstractWalletController.ts:99

listenerCount

listenerCount(event: WalletEvent): number
Return the number of listeners listening to a given event.
Parameters
- event: WalletEvent
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends WalletEvent
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): AbstractWalletController
Type Parameters
- T extends WalletEvent
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns AbstractWalletController
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:69

on

on(event: BLOCKCHAIN_CHANGED, fn: ((newBlockchain: string) => void), context?: any): AbstractWalletController
Parameters
- event: BLOCKCHAIN_CHANGED
- fn: ((newBlockchain: string) => void)
  - - (newBlockchain: string): void
    - Parameters
      
      newBlockchain: string
      
      Returns void
- Optional context: any
Returns AbstractWalletController
Overrides EventEmitter.on
- Defined in src/abstracts/AbstractWalletController.ts:65
on(event: ACCOUNT_CHANGED | LOGIN, fn: ((newAccount: WalletAccount<any>) => void), context?: any): AbstractWalletController
Parameters
- event: ACCOUNT_CHANGED | LOGIN
- fn: ((newAccount: WalletAccount<any>) => void)
  - - (newAccount: WalletAccount<any>): void
    - Parameters
      
      newAccount: WalletAccount<any>
      
      Returns void
- Optional context: any
Returns AbstractWalletController
Overrides EventEmitter.on
- Defined in src/abstracts/AbstractWalletController.ts:66
on(event: LOGOUT, fn: (() => void), context?: any): AbstractWalletController
Parameters
- event: LOGOUT
- fn: (() => void)
  - - (): void
    - Returns void
- Optional context: any
Returns AbstractWalletController
Overrides EventEmitter.on
- Defined in src/abstracts/AbstractWalletController.ts:71

once

once<T>(event: T, fn: ((...args: any[]) => void), context?: any): AbstractWalletController
Add a one-time listener for a given event.
Type Parameters
- T extends WalletEvent
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns AbstractWalletController
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: WalletEvent): AbstractWalletController
Remove all listeners, or those of the specified event.
Parameters
- Optional event: WalletEvent
Returns AbstractWalletController
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): AbstractWalletController
Remove the listeners of a given event.
Type Parameters
- T extends WalletEvent
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns AbstractWalletController
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:63

`Abstract` requestAuthentication

requestAuthentication(): Promise<null | WalletAccount<any>>
Method to request wallet to authenticate some account for this app

Returns Promise<null | WalletAccount<any>>
- Defined in src/abstracts/AbstractWalletController.ts:114

`Abstract` sendBroadcast

sendBroadcast(from: WalletAccount<any>, feedId: Uint256, contentData: Uint8Array, options?: any): Promise<SendBroadcastResult>
Method to publish non-encrypted broadcasted message using Ylide Protocol.
Parameters
- from: WalletAccount<any>
  
  Account from which publish should occur
- feedId: Uint256
  
  broadcasting feedId to publish to
- contentData: Uint8Array
  
  raw bytes content to publish
- Optional options: any
  
  additional options for this wallet (e.g. "network" for EVM-wallets)
Returns Promise<SendBroadcastResult>
- Defined in src/abstracts/AbstractWalletController.ts:154

`Abstract` sendMail

sendMail(from: WalletAccount<any>, feedId: Uint256, contentData: Uint8Array, recipients: {
address: Uint256;
messageKey: MessageKey;
}[], options?: any): Promise<SendMailResult>
Method to publish encrypted direct message using Ylide Protocol.
Parameters
- from: WalletAccount<any>
  
  Account from which publish should occur
- feedId: Uint256
  
  mailing feedId to publish to (usually YLIDE_MAIN_FEED_ID)
- contentData: Uint8Array
  
  raw bytes content to publish
- recipients: {
  address: Uint256;
  messageKey: MessageKey;
  }[]
  
  array of recipients (address-public key pairs)
- Optional options: any
  
  additional options for this wallet (e.g. "network" for EVM-wallets)
Returns Promise<SendMailResult>
- Defined in src/abstracts/AbstractWalletController.ts:138

`Abstract` signMagicString

signMagicString(account: WalletAccount<any>, magicString: string): Promise<Uint8Array>
Method used to create Ylide keypair: it gets signature from the wallet for a certain magicString
Parameters
- account: WalletAccount<any>
  
  Account for which you request signature
- magicString: string
  
  string which you get from YlideKeysRegistry
Returns Promise<Uint8Array>
- Defined in src/abstracts/AbstractWalletController.ts:127

`Protected` switchAccountRequest

switchAccountRequest(currentAccount: null | WalletAccount<any>, needAccount: WalletAccount<any>): Promise<void>
Parameters
- currentAccount: null | WalletAccount<any>
- needAccount: WalletAccount<any>
Returns Promise<void>
- Defined in src/abstracts/AbstractWalletController.ts:59

`Abstract` wallet

wallet(): string
Method to get wallet name (e.g. "metamask")

Returns string
- Defined in src/abstracts/AbstractWalletController.ts:86

Class AbstractWalletControllerAbstract

Description

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: any

Returns AbstractWalletController

Properties

onSwitchAccountRequest

Static prefixed

Methods

addListener

Type Parameters

T extends WalletEvent

Parameters

event: T

fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns AbstractWalletController

Abstract addressToUint256

Parameters

address: string

Returns Uint256

Abstract attachPublicKey

Parameters

account: WalletAccount<any>

publicKey: Uint8Array

keyVersion: YlideKeyVersion

registrar: number

Optional options: any

Returns Promise<void>

Abstract blockchainGroup

Description

Returns string

Abstract decryptMessageKey

Parameters

recipientAccount: WalletAccount<any>

senderPublicKey: EncryptionPublicKey

encryptedKey: Uint8Array

Returns Promise<Uint8Array>

Abstract disconnectAccount

Parameters

account: WalletAccount<any>

Returns Promise<void>

emit

Type Parameters

T extends WalletEvent

Parameters

event: T

Rest ...args: any[]

Returns boolean

eventNames

Returns WalletEvent[]

Abstract getAuthenticatedAccount

Returns Promise<null | WalletAccount<any>>

Abstract getCurrentBlockchain

Returns Promise<string>

Abstract getFaucet

Parameters

Optional options: any

Returns Promise<AbstractFaucetService>

Abstract init

Returns Promise<void>

Abstract isFaucetAvailable

Returns boolean

Abstract isMultipleAccountsSupported

Returns boolean

listenerCount

Parameters

event: WalletEvent

Returns number

Class AbstractWalletController`Abstract`

`Optional` options: any

`Static` prefixed

`Rest` ...args: any[]

`Optional` context: any

`Abstract` addressToUint256

`Abstract` attachPublicKey

`Optional` options: any

`Abstract` blockchainGroup

`Abstract` decryptMessageKey

`Abstract` disconnectAccount

`Rest` ...args: any[]

`Abstract` getAuthenticatedAccount

`Abstract` getCurrentBlockchain

`Abstract` getFaucet

`Optional` options: any

`Abstract` init

`Abstract` isFaucetAvailable

`Abstract` isMultipleAccountsSupported

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean

`Optional` context: any

`Optional` context: any

`Optional` context: any

`Rest` ...args: any[]

`Optional` context: any

`Optional` event: WalletEvent

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean

`Abstract` requestAuthentication