Release 2025-02-25 12:19:30 +0900

.github/actions/install-dependencies/action.yml

@@ -6,7 +6,7 @@ runs:
   steps:
     - uses: actions/setup-node@v4
       with:
-        node-version: 20
+        node-version: 20.12.0
         registry-url: 'https://registry.npmjs.org'
         scope: '@jpyc'
     - name: Install dependencies

.github/workflows/check.yml

@@ -16,7 +16,6 @@ jobs:
     outputs:
       root: ${{ steps.filter.outputs.root }}
       core: ${{ steps.filter.outputs.core }}
-      v1: ${{ steps.filter.outputs.v1 }}
     steps:
       - uses: actions/checkout@v4
       - uses: dorny/paths-filter@v3
@@ -27,10 +26,10 @@ jobs:
               - '.github/**'
               - 'docs/**'
               - 'README.md'
+              - 'package.json'
+              - 'yarn.lock'
             core:
               - 'packages/core/**'
-            v1:
-              - 'packages/v1/**'
 
   check-root:
     needs: detect-changes
@@ -65,21 +64,3 @@ jobs:
         run: yarn run format:dry-run
       - name: Run tests
         run: yarn run test
-
-  check-v1:
-    needs: detect-changes
-    if: ${{ needs.detect-changes.outputs.v1 == 'true' }}
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./packages/v1
-    timeout-minutes: 5
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ./.github/actions/install-dependencies
-      - name: Compile
-        run: yarn run compile
-      - name: Lint
-        run: yarn run lint:dry-run
-      - name: Format
-        run: yarn run format:dry-run

.github/workflows/deploy-docs.yml

@@ -0,0 +1,61 @@
+name: deploy documentation
+
+on:
+  push:
+    branches:
+      - 'main'
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+
+      - uses: ./.github/actions/install-dependencies
+
+      - name: Check format
+        run: |
+          yarn run format:dry-run docs
+
+  build:
+    needs: format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/core/html'
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -7,7 +7,6 @@ on:
     types: [closed]
     paths:
       - 'packages/core/**'
-      - 'packages/v1/**'
 
 jobs:
   detect-changes:
@@ -17,7 +16,6 @@ jobs:
       pull-requests: read
     outputs:
       core: ${{ steps.filter.outputs.core }}
-      v1: ${{ steps.filter.outputs.v1 }}
     steps:
       - uses: actions/checkout@v4
       - uses: dorny/paths-filter@v3
@@ -26,8 +24,6 @@ jobs:
           filters: |
             core:
               - 'packages/core/**'
-            v1:
-              - 'packages/v1/**'
 
   push-git-tag:
     runs-on: ubuntu-latest
@@ -88,21 +84,3 @@ jobs:
         with:
           working-directory: ./packages/core
           node-auth-token: ${{ secrets.NPM_TOKEN }}
-
-  publish-v1:
-    needs: [detect-changes, publish-release-note]
-    if: ${{ needs.detect-changes.outputs.v1 == 'true' }}
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./packages/v1
-    timeout-minutes: 5
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ./.github/actions/install-dependencies
-      - name: Build package
-        run: yarn run compile
-      - uses: ./.github/actions/publish-package
-        with:
-          working-directory: ./packages/v1
-          node-auth-token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -119,8 +119,10 @@ dist
 # TernJS port file
 .tern-port
 
-# Stores VSCode versions used for testing VSCode extensions
+# VS Code
+.vscode
 .vscode-test
+cspell.json
 
 # yarn v2
 .yarn/cache
@@ -131,4 +133,3 @@ dist
 
 # Misc
 .DS_Store
-.vscode

README.md

@@ -1,9 +1,9 @@
-# JPYC Node SDKs
+# JPYC SDKs
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/jcam1/sdks/issues/new/choose)
 
-Monorepo for JPYC Node SDKs.
+Monorepo for JPYC SDKs.
 
 ## 🌈 Available SDKs
 
@@ -12,7 +12,6 @@ Please refer to `README`s of each SDK for the version specific details.
 |    SDK | `README`                                   |
 | -----: | :----------------------------------------- |
 | `core` | [packages/core](./packages/core/README.md) |
-|   `v1` | [packages/v1](./packages/v1/README.md)     |
 
 ## 🔨 Development
 
@@ -52,17 +51,20 @@ $ 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.
+To add dependencies, run one of the following.
 
 ```sh
 # Add dependencies to the specified workspace
-$ yarn workspace ${workspace_name} add -E ${dependencies}
+$ yarn workspace ${workspace_name} add ${dependencies}
 
 # Add dev dependencies to the specified workspace
-$ yarn workspace ${workspace_name} add -E -D ${dependencies}
+$ yarn workspace ${workspace_name} add -D ${dependencies}
+
+# Add dependencies to the workspaces root
+$ yarn add -W ${dependencies}
 
 # Add dev dependencies to the workspaces root
-$ yarn add -E -D -W ${dependencies}
+$ yarn add -W -D ${dependencies}
 ```
 
 To remove dependencies, run one of the following.
@@ -113,4 +115,4 @@ Now, write code to implement the proposed features and/or to fix bugs.
 
 ### 5. Open a Pull Request
 
-Finally, open a new PR from your branch to `develop` branch to describe what you'll have done.
+Finally, open a new PR from your branch to `develop` branch, and describe what you'll have done.

docs/core/README.md

@@ -1,27 +1,109 @@
-**@jpyc/sdk-core** • [**Docs**](globals.md)
+**@jpyc/sdk-core**
 
 ---
 
 # JPYC Core SDK
 
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
 ![build](https://github.com/jcam1/sdks/actions/workflows/check.yml/badge.svg)
-[![Node version](https://img.shields.io/node/v/@jpyc/sdk-core.svg?style=flat)](https://nodejs.org/download/)
+[![npm version](https://badge.fury.io/js/@jpyc%2Fsdk-core.svg)](https://badge.fury.io/js/@jpyc%2Fsdk-core)
 
-JPYC core SDK implements a set of constants, types and functions, commonly used across different SDK versions.
+JPYC core SDK implements interfaces to interact with [JPYCv2 contracts](https://github.com/jcam1/JPYCv2) on different chains. Supported chains are Ethereum, Polygon, Gnosis, Avalanche, Astar and Shiden.
+
+## 💡 How to Use
+
+Please follow the following steps to configure the SDK.
+
+#### 1. Install Packages
+
+Install packages.
+
+```sh
+# yarn
+$ yarn add @jpyc/sdk-core
+
+# npm
+$ npm i @jpyc/sdk-core
+```
+
+#### 2. Set Environment Variables
+
+Some data, such as configuration variables (e.g., chain name) or sensitive data (e.g., private key), are embedded as environment variables. You need to set the following environment variables.
+
+|              Variable | Description & Instructions                                                                                                        |
+| --------------------: | :-------------------------------------------------------------------------------------------------------------------------------- |
+|             `SDK_ENV` | SDK environment. Set to `local` for local environment or any other sensible string for production environment.                    |
+|          `CHAIN_NAME` | Chain name. Set to one of the following\: `local`, `ethereum`, `polygon`, `gnosis`, `avalanche`, `astar` or `shiden`.             |
+|        `NETWORK_NAME` | Network name within the specified chain. Set to one of the following\: `mainnet`, `goerli`, `sepolia`, `amoy`, `chiado` or `fuji` |
+|        `RPC_ENDPOINT` | RPC endpoint to send transactions.                                                                                                |
+|         `PRIVATE_KEY` | Private key of an account.                                                                                                        |
+| `LOCAL_PROXY_ADDRESS` | Proxy contract address in local environment.                                                                                      |
+
+#### 3. Instantiate SDK
+
+Initialize an SDK instance that implements abstracted interfaces to the JPYCv2 contracts.
+
+```ts
+import {
+  ChainName,
+  Endpoint,
+  IJPYC,
+  ISdkClient,
+  JPYC,
+  NetworkName,
+  SdkClient,
+} from '@jpyc/sdk-core';
+
+// 1. Initialize an SdkClient instance
+const sdkClient: ISdkClient = new SdkClient({
+  chainName: process.env.CHAIN_NAME as ChainName,
+  networkName: process.env.NETWORK_NAME as NetworkName,
+  rpcEndpoint: process.env.RPC_ENDPOINT as Endpoint,
+});
+
+// 2. Generate an account from a private key
+export const account = sdkClient.createPrivateKeyAccount({});
+
+// 3. Generate a client with the account
+export const client = sdkClient.createLocalClient({
+  account: account,
+});
+
+// 4. Initialize an SDK instance
+export const jpyc: IJPYC = new JPYC({
+  client: client,
+});
+```
+
+#### 4. Use SDK
+
+Use the initialized SDK wherever you would like.
+
+```ts
+import { jpyc } from './YOUR/PATH/TO/INITIALIZATION/FILE';
+
+// Fetch `totalSupply` from `JPYCv2` contract
+const totalSupply = await jpyc.totalSupply();
+console.log(`totalSupply: ${totalSupply.toString()}`);
+```
+
+## ✨ Code Examples
+
+For your reference, we provide code examples in the separate [`sdk-examples` repository](https://github.com/jcam1/sdk-examples). Please follow the instructions specified in `README` files.
 
 ## 🤖 Available Commands
 
 The following commands are available as yarn scripts for local development & testing.
 
 |          Command | Description                                           |
 | ---------------: | :---------------------------------------------------- |
-|           `docs` | Generate Markdown documents from TSDoc-style comments |
-|        `compile` | Compile (transpile) TypeScript files                  |
+|        `compile` | Compile (transpile) SDK                               |
+|           `test` | Run unit tests (using jest)                           |
 |           `lint` | Run Eslint                                            |
 |   `lint:dry-run` | Run Eslint without fixing                             |
 |         `format` | Run Prettier                                          |
 | `format:dry-run` | Run Prettier without fixing                           |
-|           `test` | Run unit tests (via jest)                             |
+|           `docs` | Generate Markdown documents from TSDoc-style comments |
 
 ## 📚 Documentation
 

docs/core/_media/globals.md

@@ -1,9 +1,23 @@
-[**@jpyc/sdk-core**](README.md) • **Docs**
+[**@jpyc/sdk-core**](README.md)
 
 ---
 
 # @jpyc/sdk-core
 
+## Classes
+
+- [InvalidAddressError](classes/InvalidAddressError.md)
+- [InvalidChainNameError](classes/InvalidChainNameError.md)
+- [InvalidNetworkNameError](classes/InvalidNetworkNameError.md)
+- [InvalidTransactionError](classes/InvalidTransactionError.md)
+- [JPYC](classes/JPYC.md)
+- [SdkClient](classes/SdkClient.md)
+
+## Interfaces
+
+- [IJPYC](interfaces/IJPYC.md)
+- [ISdkClient](interfaces/ISdkClient.md)
+
 ## Type Aliases
 
 - [Address](type-aliases/Address.md)
@@ -14,6 +28,7 @@
 
 ## Variables
 
+- [JPYC_V2_ABI](variables/JPYC_V2_ABI.md)
 - [LOCAL_PROXY_ADDRESS](variables/LOCAL_PROXY_ADDRESS.md)
 - [SUPPORTED_CHAINS](variables/SUPPORTED_CHAINS.md)
 - [V2_PROXY_ADDRESS](variables/V2_PROXY_ADDRESS.md)