Class Ylide

Description

It's a singleton entry point to all interactions with Ylide SDK

Example

import { Ylide } from '@ylide/sdk';
import { tvm } from '@ylide/everscale';

const keysRegistry = new YlideKeysRegistry();
const ylide = new Ylide(keysRegistry);
ylide.add(tvm);

const wallet = await ylide.instantiateWallet('everscale', 'everwallet');

const account = await wallet.getAuthenticatedAccount();

Hierarchy

Ylide

Constructors

constructor

new Ylide(keysRegistry?: YlideKeysRegistry, indexerBlockchains?: string[]): Ylide
Parameters
- Optional keysRegistry: YlideKeysRegistry
  
  Reference to YlideKeysRegistry instance
- Optional indexerBlockchains: string[]
  
  Array of blockchains that should be firstly read from Indexer. Omit if you want to use defaults
Returns Ylide
- Defined in src/Ylide.ts:44

Properties

`Private` _blockchainFactories

_blockchainFactories: BlockchainMap<BlockchainControllerFactory> = {}

`Private` _blockchainToGroupMap

_blockchainToGroupMap: Record<string, string> = {}

`Private` _isVerbose

_isVerbose: boolean = false

Accessors

blockchainToGroupMap

get blockchainToGroupMap(): Record<string, string>
Description
Getter of blockchain to blockchain group map. Like "ETHEREUM" -> "evm", "GNOSIS" => "evm"

Returns Record<string, string>
- Defined in src/Ylide.ts:80

blockchainsList

get blockchainsList(): {
blockchain: string;
factory: BlockchainControllerFactory;
}[]
Method to get registered blockchain controllers

Example
```
const ethereumChains = ylide.blockchainsList.filter(t => t.blockchain === 'ethereum');
```
Returns {
blockchain: string;
factory: BlockchainControllerFactory;
}[]
- Defined in src/Ylide.ts:251

isVerbose

get isVerbose(): boolean
Description
This method is used to check if SDK is verbose.

Returns boolean
- Defined in src/Ylide.ts:101

walletsList

get walletsList(): {
    blockchainGroup: string;
    factory: WalletControllerFactory;
    wallet: string;
}[]
Getter for the registered wallet controllers

Example
```
const evmWallets = ylide.walletsList.filter(t => t.blockchainGroup === 'evm');
```
Returns {
    blockchainGroup: string;
    factory: WalletControllerFactory;
    wallet: string;
}[]
- Defined in src/Ylide.ts:231

Methods

add

add(scope: ConnectorScope): void
Method to add all available crypto-wallets and blockchains of the certain connector in Ylide.
Parameters
- scope: ConnectorScope
  
  Connector scope got from the corresponding library, e.g. evm/tvm
Returns void
- Defined in src/Ylide.ts:157

getAvailableBlockchains

getAvailableBlockchains(): Promise<BlockchainControllerFactory[]>
Method to get a list of registered blockchain controllers

Example
```
const availableBlockchains = await ylide.getAvailableBlockchains();
```
Returns Promise<BlockchainControllerFactory[]>
- Defined in src/Ylide.ts:295

getAvailableWallets

getAvailableWallets(): Promise<WalletControllerFactory[]>
Method to get a list of registered wallet controllers that are available in the user's browser (wallets installed)

Example
```
const availableWallets = await ylide.getAvailableWallets();
```
Returns Promise<WalletControllerFactory[]>
- Defined in src/Ylide.ts:266

getBlockchainControllerFactory

getBlockchainControllerFactory(blockchain: string): BlockchainControllerFactory
Method to get blockchain controller factory for a certain blockchain
Parameters
- blockchain: string
  
  Name of blockchain
Returns BlockchainControllerFactory
- Defined in src/Ylide.ts:197

getWalletControllerFactory

getWalletControllerFactory(blockchainGroup: string, wallet: string): WalletControllerFactory
Method to get wallet controller factory for a certain blockchain group and wallet type
Parameters
- blockchainGroup: string
  
  Name of the blockchain group
- wallet: string
  
  Name of in-browser wallet
Returns WalletControllerFactory
- Defined in src/Ylide.ts:210

init

init(): Promise<void>
Returns Promise<void>
- Defined in src/Ylide.ts:355

instantiateBlockchain

instantiateBlockchain(blockchain: string, options?: any): Promise<AbstractBlockchainController>

Method to instantiate blockchain controller

Example

const blockchainController = await ylide.instantiateBlockchain('everscale');

const isMyAddressValid = blockchainController.isAddressValid('0:81f452f5aec2263ab10116f7108a20209d5051081bb3caed34f139f976a0e279');

Parameters

blockchain: string
Optional options: any

Returns Promise<AbstractBlockchainController>

instantiateWallet

instantiateWallet(blockchainGroup: string, wallet: string, options?: any): Promise<AbstractWalletController>
Method to instantiate wallet controller

Example
```
const wallet = await ylide.instantiateWallet('everscale', 'everwallet');

const account = await wallet.getAuthenticatedAccount();
```
Parameters
- blockchainGroup: string
- wallet: string
- Optional options: any
Returns Promise<AbstractWalletController>
- Defined in src/Ylide.ts:309

isBlockchainRegistered

isBlockchainRegistered(blockchain: string): boolean
Method to check availability of a certain blockchain connector

Example
```
ylide.isBlockchainRegistered('everscale'); // return true if `ylide.registerBlockchain` was called with this blockchain controller factory before
```
Parameters
- blockchain: string
  
  Name of blockchain you want to check
Returns boolean
- Defined in src/Ylide.ts:175

isWalletRegistered

isWalletRegistered(blockchain: string, wallet: string): boolean
Method to check availability of a certain blockchain for sending messages

Example
```
ylide.isWalletRegistered('everscale', 'everwallet'); // return true if `Ylide.registerWallet` was called with this wallet factory before
```
Parameters
- blockchain: string
  
  Name of blockchain you want to check
- wallet: string
Returns boolean
- Defined in src/Ylide.ts:188

registerBlockchainFactory

registerBlockchainFactory(factory: BlockchainControllerFactory): void
Use this method to register certain blockchain connector in Ylide.

Example
```
import { everscaleBlockchainFactory } from '@ylide/everscale';

ylide.registerBlockchain(everscaleBlockchainFactory);
```
Parameters
- factory: BlockchainControllerFactory
  
  Blockchain controller factory which you want to register
Returns void
- Defined in src/Ylide.ts:147

registerWalletFactory

registerWalletFactory(factory: WalletControllerFactory): void
Use this method to register certain crypto-wallet connector in Ylide.

Example
```
import { everscaleWalletFactory } from '@ylide/everscale';

ylide.registerWallet(everscaleWalletFactory);
```
Parameters
- factory: WalletControllerFactory
  
  Wallet controller factory which you want to register
Returns void
- Defined in src/Ylide.ts:129

silent

silent(): void
Description
This method is used to make SDK silent. It means that all extra logs will be hidden.

Returns void
- Defined in src/Ylide.ts:94

verbose

verbose(): void
Description
This method is used to make SDK verbose. It means that all extra logs will be printed to console.

Returns void
- Defined in src/Ylide.ts:87

`Private` verboseLogTick

verboseLogTick(...args: any[]): (() => void)
Parameters
- Rest ...args: any[]
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/Ylide.ts:105

Class Ylide

Description

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional keysRegistry: YlideKeysRegistry

Optional indexerBlockchains: string[]

Returns Ylide

Properties

Private _blockchainFactories

Private _blockchainToGroupMap

Private _isVerbose

Private _walletFactories

Readonly auth

Readonly controllers

Readonly core

Readonly keysRegistry

Readonly mailbox

Accessors

blockchainToGroupMap

Description

Returns Record<string, string>

blockchainsList

Example

Returns { blockchain: string; factory: BlockchainControllerFactory; }[]

isVerbose

Description

Returns boolean

walletsList

Example

Returns { blockchainGroup: string; factory: WalletControllerFactory; wallet: string; }[]

Methods

add

Parameters

scope: ConnectorScope

Returns void

getAvailableBlockchains

Example

Returns Promise<BlockchainControllerFactory[]>

getAvailableWallets

Example

Returns Promise<WalletControllerFactory[]>

getBlockchainControllerFactory

Parameters

blockchain: string

Returns BlockchainControllerFactory

getWalletControllerFactory

Parameters

blockchainGroup: string

wallet: string

Returns WalletControllerFactory

init

Returns Promise<void>

instantiateBlockchain

Example

Parameters

blockchain: string

Optional options: any

Returns Promise<AbstractBlockchainController>

instantiateWallet

Example

Parameters

blockchainGroup: string

wallet: string

Optional options: any

Returns Promise<AbstractWalletController>

isBlockchainRegistered

Example

Parameters

blockchain: string

Returns boolean

isWalletRegistered

Example

`Optional` keysRegistry: YlideKeysRegistry

`Optional` indexerBlockchains: string[]

`Private` _blockchainFactories

`Private` _blockchainToGroupMap

`Private` _isVerbose

`Private` _walletFactories

`Readonly` auth

`Readonly` controllers

`Readonly` core

`Readonly` keysRegistry

`Readonly` mailbox

Returns {
blockchain: string;
factory: BlockchainControllerFactory;
}[]

Returns {
blockchainGroup: string;
factory: WalletControllerFactory;
wallet: string;
}[]

`Optional` options: any

`Optional` options: any

`Private` verboseLogTick

`Rest` ...args: any[]