https://github.com/temarusanov/web3-development-kit

Nx monorepo for solidity and dApps (SDK support)
https://github.com/temarusanov/web3-development-kit

eth-sdk ethereum hardhat nx react sdk solidity typescript

Last synced: 13 days ago
JSON representation

Nx monorepo for solidity and dApps (SDK support)

• Host: GitHub
• URL: https://github.com/temarusanov/web3-development-kit
• Owner: temarusanov
• Created: 2022-12-19T10:28:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-20T07:42:05.000Z (about 2 years ago)
• Last Synced: 2023-06-15T13:29:38.852Z (over 1 year ago)
• Topics: eth-sdk, ethereum, hardhat, nx, react, sdk, solidity, typescript
• Language: TypeScript
• Homepage:
• Size: 466 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Web3 development kit

## What's this for?

Nx monorepo that prepared to develop contract and frontend in one repository. Main feature of that is contracts' SDK for web applications.

Develop and build full typed applications.

## Used with

- [Nx](https://nx.dev/). Monorepo orchestrator

- [eth-sdk](https://github.com/dethcrypto/eth-sdk). Type-safe, lightweight SDKs for Ethereum smart contracts

- [Hardhat](https://hardhat.org/). Ethereum development environment

## Usage

First, install dependencies. Installing will build contract SDK for you. If you have any config in `packages/contracts/sdk` folder

```bash

yarn install

```

Then, create a web application (React, Vue, Angular) and add `contracts` package for you dependencies

```json

// packages/sample/package.json

{

  "name": "sample",

  "version": "0.0.0",

  "main": "dist/index.js",

  "devDependencies": {},

  "scripts": {

    "build": "tsc index.ts --outDir dist"

  },

  "dependencies": {

    "contracts": "*" // <-- add this line

  }

}

```

It need to tell Nx that your package is depend on `contracts` package. After that on every `build` script in your package Nx will regenerate SDK for you.

So, you always have a fresh SDK of contracts

Configure your SDK using [`eth-sdk` package](https://github.com/dethcrypto/eth-sdk)

## Examples

Check out [the sample](./packages/sample/index.ts) for examples