Everscale WalletKit

This library is a part of Everscale SDK for JavaScript.

WalletKit is built over the @eversdk/appkit package and purposed to simplify work with wallets on Everscale.

WalletKit works with the following types of wallets:

• Safe multisig wallet
• Set code multisig wallet
• Surf wallet

Have a question? Get quick help in our channel:

Table of Contents

• Useful links
• Before You Start
• Installation
• Setup Client Library
  • NodeJs:
  • Web:
  • React Native:
• Create Client Instance
• Use Wallet Object
• API Reaference
• Sample source code
• Run an example

Useful links

• SDK guides - to get a deeper understanding dive into our sdk guides where you can find extensive explanations and descriptions of each step of DApp development on Everscale.

• @eversdk/appkit - a package that greatly simplifies writing applications on Everscale.

Before You Start

Installation

# Install core package
npm i --save @eversdk/core

# Install lib-node bridge if you write node js application
npm i --save @eversdk/lib-node

# Or install lib-web bridge if you write web/browser application
npm i --save @eversdk/lib-web

# Or install lib-react-native if you write react-native mobile application
npm i --save @eversdk/lib-react-native

# And finally install walletkit itself
npm i --save @eversdk/walletkit

Setup Client Library

NodeJs:

const { TonClient } = require("@eversdk/core")
const { libNode } = require("@eversdk/lib-node")

TonClient.useBinaryLibrary(libNode)

Web:

import { TonClient } from "@eversdk/core"
import { libWeb } from "@eversdk/lib-web"

TonClient.useBinaryLibrary(libWeb)

By default, the library loads wasm module from relative URL /tonclient.wasm.

You can specify alternative URL if you want to place (or rename) wasm module.

import { TonClient } from "@eversdk/core"
import { libWeb, libWebSetup } from "@eversdk/lib-web"

// You have to setup libWeb if the `tonclient.wasm`
// isn't located at root of your web site.
// Otherwise you havn't to call `libWebSetup`.
libWebSetup({
    binaryURL: "/assets/tonclient_1_2_3.wasm",
})

TonClient.useBinaryLibrary(libWeb)

React Native:

import { TonClient } from "@eversdk/core"
import { libReactNative } from "@eversdk/lib-react-native"

TonClient.useBinaryLibrary(libReactNative)

Create Client Instance

You have to create an instance of TonClient to use it later with WalletKit objects.

const client = new TonClient({
    network: { endpoints: ["http://localhost"] },
})

In this sample we create a client instance configured to use local blockchain Evernode SE instance.

If you want to work with Developer Network or Everscale main network, please use the list of endpoints, listed here.
Attention: You must specify all the endpoints as an array in endpoints parameter, because each endpoint does not guarantee its availability, but we guarantee that at least one endpoint is operational at the moment.

Use Wallet Object

Below we use a code snippets to illustrate how to deploy Surf wallet.
We suppose that we are using lib-node bridge (NodeJs) to write examples. Also, we use the library to deal with local Evernode SE instance.

const { TonClient } = require("@eversdk/core")
const { libNode } = require("@eversdk/lib-node")
const { Account } = require("@eversdk/walletkit")

TonClient.useBinaryLibrary(libNode)
;(async () => {
    const endpoint = process.env.TON_NETWORK_ADDRESS || "http://localhost"
    const client = new TonClient({ network: { endpoints: [endpoint] } })
    try {
        await main(client)
    } catch (err) {
        console.error(err)
    } finally {
        client.close()
    }
})()

async function main(client) {
    // Generate new keys pair for new wallet
    const keys = await client.crypto.generate_random_sign_keys()

    // Create owner (signer) instance for new account.
    const signer = signerKeys(keys)

    // Create an instance of `WalletTypes.Surf`
    //
    // Note that this account is not deployed in the blockchain yet.
    // We just create an object to deal with this account.
    const wallet = Wallet.create(WalletTypes.Surf, { signer, client })

    // We can determine the future addres of the account
    // and print it to the user before deploying.
    console.log(`New account future address: ${await wallet.getAddress()}`)

    // Deploy wallet with only one custodian to the blockchain.
    // Here we use TONOS SE giver to create a positive balance before deploying.
    await wallet.install({
        owners: ["0x" + keys.public],
        reqConfirms: 1,
        useGiver: true,
    })
}

API reference

At the moment, the Wallet class has only two methods of its own:

• Wallet.create( walletType: WalletTypes, {signer: Signer, client: TonClient} ) - static factory method for wallet instantiation

  • walletType - is a value from WalletTypes enum (SafeMultisig, SetcodeMultisig, Surf)

• wallet.install({owners: string[], reqConfirms: number, useGiver?: true | AccountGiver})
  Object method which deploys wallet contract into blockchain.\

  • owners - an array of custodian public keys of custodians. Make sure all public keys are enclosed in quotes and start with 0x.

  • reqConfirms - number of signatures needed to confirm a transaction

  • useGiver - Giver to be used to send amount of value to deploying address before deploying.
    If true then Account.getDefaultGiver() will be used. If omitted then application must prepay address using own logic. Most likely, if you are using EverOS SE, you set this option to true.

All other methods Wallet class inherits from Contract class of AppKit, find its full API reference here

Sample source code

Find the sample that demonstrates WalletKit usage source code here: src/example.ts

Run an example

To run an example or tests wou have to run EverOS SE

everdev se start

# if you want to run test
npm test

# if you want to run example
npm run build
node dist/example.js
``