Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 3.25 KB

README.md

File metadata and controls

80 lines (57 loc) · 3.25 KB


Ylide Documentation Ylide Discord

Ylide Protocol is an open-source cross-chain wallet-to-wallet communications solution for Web3 projects. We anticipate that for the mass adoption of the Web3 it is crucial to have native decentralized and secure communications layer. That's what's Ylide purpose is.

Quick Start

For all examples we will use EVM connectors for Polygon from @ylide/ethereum. To install core of the SDK, run:

npm install --save @ylide/sdk

On the next step you should install some blockchain connector to be able to read and send messages:

npm install --save @ylide/ethereum

So, first of all you should import these connectors:

import { evmBlockchainFactories, evmWalletFactories, EVMNetwork } from '@ylide/ethereum';

Afterward, you should register them in the Ylide singleton:

Ylide.registerBlockchainFactory(evmBlockchainFactories[EVMNetwork.POLYGON]);
Ylide.registerWalletFactory(evmWalletFactories.metamask);

You can easily verify availability of MetaMask (or other Ethereum wallet) in user’s browser:

const isWalletAvailable = await evmWalletFactories.metamask.isWalletAvailable();

Documentation

Please see our full documentation here. You can start with:

Reporting Bugs and Contributing Code