https://github.com/jcam1/sdk-examples

Code examples for JPYC Node SDKs
https://github.com/jcam1/sdk-examples

astar avalanche ethereum gnosis hardhat japanese jpy jpyc node-js npm-package polygon sdk stablecoin typescript viem

Last synced: 3 months ago
JSON representation

Code examples for JPYC Node SDKs

• Host: GitHub
• URL: https://github.com/jcam1/sdk-examples
• Owner: jcam1
• License: mit
• Created: 2024-08-29T04:59:44.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T06:25:43.000Z (4 months ago)
• Last Synced: 2024-09-28T07:04:56.042Z (3 months ago)
• Topics: astar, avalanche, ethereum, gnosis, hardhat, japanese, jpy, jpyc, node-js, npm-package, polygon, sdk, stablecoin, typescript, viem
• Language: TypeScript
• Homepage:
• Size: 84 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# sdk-examples

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)

Code examples for JPYC Node SDKs

## 🌈 Available Code Examples

Please refer to `README`s of each SDK for the version specific details.

| SDK Version | `README`                               |

| ----------: | :------------------------------------- |

|        `v1` | [packages/v1](./packages/v1/README.md) |

## 🔨 Development

### Git Submodules

This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to be in sync with [JPYCv2](https://github.com/jcam1/JPYCv2/tree/main) repo.

To include submodules when cloning the repo, add `--recursive` option like below.

```sh

$ git clone --recursive https://github.com/jcam1/sdk-examples.git

```

### Yarn Workspaces

This repo uses [Yarn Workspaces](https://yarnpkg.com/features/workspaces) primarily as a monorepo management tool. Please refer to the inserted link for details.

> [!NOTE]

> Please use Node `v20.12.0` for this repo.

To install dependencies for all the workspaces, run the following.

```sh

# cd into this repo

$ cd sdk-examples

# Install dependencies

$ yarn

```

### Yarn Scripts

To run yarn scripts defined in workspaces, run the following.

```sh

$ yarn workspace ${workspace_name} run ${command_name}

```

### Dependencies

To add dependencies, run one of the following. To prevent unexpected behaviors, always pin the exact versions of the dependencies to be installed.

```sh

# Add dependencies to the specified workspace

$ yarn workspace ${workspace_name} add -E ${dependencies}

# Add dev dependencies to the specified workspace

$ yarn workspace ${workspace_name} add -E -D ${dependencies}

# Add dev dependencies to the workspaces root

$ yarn add -E -D -W ${dependencies}

```

To remove dependencies, run one of the following.

```sh

# Remove dependencies from the specified workspace

$ yarn workspace ${workspace_name} remove ${dependencies}

# Remove dependencies from the workspaces root

$ yarn remove -W ${dependencies}

```