Skip to content

Latest commit

 

History

History
203 lines (132 loc) · 6.61 KB

README.md

File metadata and controls

203 lines (132 loc) · 6.61 KB
Raw

Everscale-Connect - Universal Everscale web provider

Provider available at https://everscale-connect.svoi.dev/everscale/getProvider.mjs

Version 0.1.3 Updates

  • Removed ExtraTon support
  • Added queryCollection method for all providers. Using same as *.net.query_collection from
  • Add wrapper contracts from TIP-4 tokens
  • ABI and contract caching

Connection

Direct web

If you are using pure ES6 imports you can use importing directly from the link https://everscale-connect.svoi.dev/everscale/getProvider.mjs

Otherwise, you can use a wrapper script to activate module functionality in the global scope:

<script src="https://everscale-connect.svoi.dev/everscale/index.mjs" type="module"></script>

<script>
    //Now we have window.EverscaleConnect available and can use it
    let EVER = await EverscaleConnect.getProvider({}, EverscaleConnect.PROVIDERS.EverscaleWallet);
    //Do you Everscale stuff
</script>

ES6 Module (recommended)

Simplest way to use EverscaleConnect is to use ES6 module import:

import {default as getProvider, PROVIDERS, UTILS} from "https://everscale-connect.svoi.dev/everscale/getProvider.mjs";

let EVER = await getProvider({}, PROVIDERS.EverscaleWallet);
//Do you Everscale stuff

Webpack

Due to the specific factors of the Everscale network connection, this module does not support webpack packaging.

You can try to download the module directly and import it into the webpack project, but most likely you will lose the availability of the EverWeb provider which provides a direct connection to the web from a browser.

Versioning

By default the module is using the latest version of the Everscale-Connect module.

You can choose version by using direct version links:

<!-- Import the module with the specific version -->
<script src="https://everscale-connect.svoi.dev/everscale/0.1.3/index.mjs" type="module"></script>

<script>
    //Import the module with the specific version
    import * from "https://everscale-connect.svoi.dev/everscale/0.1.3/getProvider.mjs";
</script>

Usage example

import {default as getProvider, PROVIDERS, UTILS} from "https://everscale-connect.svoi.dev/everscale/getProvider.mjs";

    window.getProvider = getProvider;
    window.PROVIDERS = PROVIDERS;
    window.UTILS = UTILS;


    const DEFAULT_WALLET = PROVIDERS.EVERWallet;

    let EVER = null;
    try {

        //Initialize provider
        EVER = await getProvider({}, PROVIDERS.EverBackendWeb);
        await EVER.requestPermissions();
        await EVER.start();
    } catch (e) {
        console.log(e);
        EVER = await getProvider({
            network: 'main',
            networkServer: 'alwaysonlineevermainnode.svoi.dev'
        }, PROVIDERS.EverBackendWeb);
        await EVER.requestPermissions();
        await EVER.start();

    }
    window.EVER = EVER;

    console.log('CURRENT WALLET', await EVER.getWallet());

See examples for mor information

Providers

Everscale-Connect now supports these providers and extensions:

  • ScaleWallet by SVOI.dev (EverscaleWallet)
  • EVER Wallet by Broxus (EVERWallet)
  • Internal: EverWeb - signing transactions and fetch blockchain information from webpage (EverWeb)
  • Internal: EverBackendWeb - only for fetching information from smart contracts (EverBackendWeb)

Removed providers:

Contracts

Everscale-Connect provides some ready-to-use contracts modules.

TIP-3.1 Broxus implementation

Import directly from https://everscale-connect.svoi.dev/everscale/contracts/TIP31Root.mjs

Demo:

import TIP31Root from "https://everscale-connect.svoi.dev/everscale/contracts/TIP31Root.mjs";

//EVER provider code stuff

//Some TIP-3.1 token address
const WHISKEY_TOKEN_ADDRESS = '0:d893fe68910b9d65446a7a4e8adb245e8c9bc5d981ced60a9dd1546dca9d6500';

//Get user wallet address
const CURRENT_USER_WALLET_ADDRESS = (await EVER.getWallet()).address;


//Initialize token root contract
let token = await (new TIP31Root(EVER)).init(WHISKEY_TOKEN_ADDRESS);

//Get user wallet objec
let wallet = await token.getWalletByMultisig(CURRENT_USER_WALLET_ADDRESS);

console.log('User balance', await wallet.getBalance());

//Transfer demo
const AMOUNT = 1;
const DESTINATION_MULTISIG = '0:6f62421724726e9f42c5af9b684af4f6d0d34eab4ae5e6dfa020d706e2ad97a1';

//Getting destination TIP-3.1 wallet address
const DESTINATION_WALLET = await token.getWalletAddressByMultisig(DESTINATION_MULTISIG);

//Getting transfer payload
let transferPayload = await wallet.transferPayload(DESTINATION_WALLET, AMOUNT);

//Making transfer
await EVER.walletTransfer(wallet.address, 1e9, transferPayload, true);

ERC721

Import directly from https://everscale-connect.svoi.dev/everscale/contracts/ERC721.mjs

Used only for current version of ScalePunks.com.

For demos see

TIP-4

Import directly from https://everscale-connect.svoi.dev/everscale/contracts/TIP4Collection.mjs

Required everscale-connect version > 0.1.3

For demos see

Demos

ScalePunks.com ERC721 demos:

TIP-3.1 demo

EVER transfer demo

TIP-4 demo

Projects using Everscale-Connect

Info

Developed with ❤️ by SVOI.dev Team https://svoi.dev