w3s-web-core-sdk

Repository for the Circle Modular Wallet Web SDK (aka. BW Web SDK or Buidl Wallet Web SDK)

Examples

We've created some example apps in the examples folder:

• Circle Smart Account

You should be able to run these example apps locally and please follow the instructions under each example's README file.

Setup Guide

Please follow this guide to setup your development environment and start building!

Install dependencies

Please ensure you are using the correct Node.js version.

We have provided a .nvmrc file which can be understood by nvm, fnm, and n:

nvm use || fnm use || n auto

Note

If you are unfamiliar with Node.js version managers, please refer to our example using nvm

Confirm that you are using the correct Node.js version listed in the .nvmrc file with:

node -v

This project uses yarn to install dependencies, please ensure you have it installed.

Tip

Since Node.js v14.19, you can use the corepack command to enable yarn:

corepack enable

You can confirm that you have yarn installed with:

yarn -v

You can now install the project dependencies using yarn:

yarn install

Tip

It is good practice to run the yarn install command every time dependencies in the package.json are changed when updating your branch

Example: installing a node version manager

Install nvm to use different versions of node and npm easily.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

You can then install the Node.js version of the project by using:

nvm use

Lint

To lint the project:

yarn lint

Test

To run all unit tests, run:

yarn test

To generate coverage reports:

yarn test:coverage