https://github.com/circlefin/modularwallets-web-sdk
https://github.com/circlefin/modularwallets-web-sdk
web3
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/circlefin/modularwallets-web-sdk
- Owner: circlefin
- License: apache-2.0
- Created: 2024-11-18T11:59:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-29T14:29:03.000Z (about 1 year ago)
- Last Synced: 2025-08-08T14:41:46.816Z (12 months ago)
- Topics: web3
- Language: TypeScript
- Homepage:
- Size: 689 KB
- Stars: 8
- Watchers: 8
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# 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](./examples/) folder:
- [Circle Smart Account](./examples/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](https://github.com/nvm-sh/nvm), [fnm](https://github.com/Schniz/fnm), and [n](https://github.com/tj/n):
```zsh
nvm use || fnm use || n auto
```
> [!NOTE]
> If you are unfamiliar with Node.js version managers, please refer to [our example using `nvm`](#example-installing-a-node-version-manager)
Confirm that you are using the correct Node.js version listed in the `.nvmrc` file with:
```zsh
node -v
```
This project uses `pnpm` to install dependencies, please ensure you have it installed.
> [!TIP]
> Since Node.js v16.13, you can use the [corepack](https://github.com/nodejs/corepack) command to enable `pnpm`:
>
> ```zsh
> corepack enable pnpm
> ```
You can confirm that you have `pnpm` installed with:
```zsh
pnpm -v
```
You can now install the project dependencies using `pnpm`:
```zsh
pnpm install
```
> [!TIP]
> It is good practice to run the `pnpm 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.
```zsh
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:
```zsh
nvm use
```
### Lint
To lint the project:
```zsh
pnpm lint
```
### Test
To run all unit tests, run:
```zsh
pnpm test
```
To generate coverage reports:
```zsh
pnpm test:coverage
```