Merge pull request #49 from jcam1/develop

Release 2024-08-27 08:54:16 +0900

README.md

@@ -47,7 +47,7 @@ $ yarn
 To run yarn scripts defined in workspaces, run the following.
 
 ```sh
-$ yarn workspace <workspace name> run <command name>
+$ yarn workspace ${workspace_name} run ${command_name}
 ```
 
 ### Dependencies
@@ -56,23 +56,23 @@ To add dependencies, run one of the following. To prevent unexpected behaviors,
 
 ```sh
 # Add dependencies to the specified workspace
-$ yarn workspace <workspace name> add -E <dependencies>
+$ yarn workspace ${workspace_name} add -E ${dependencies}
 
 # Add dev dependencies to the specified workspace
-$ yarn workspace <workspace name> add -E -D <dependencies>
+$ yarn workspace ${workspace_name} add -E -D ${dependencies}
 
 # Add dev dependencies to the workspaces root
-$ yarn add -E -D -W <dependencies>
+$ 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>
+$ yarn workspace ${workspace_name} remove ${dependencies}
 
 # Remove dependencies from the workspaces root
-$ yarn remove -W <dependencies>
+$ yarn remove -W ${dependencies}
 ```
 
 ### Documentation
@@ -85,4 +85,32 @@ $ yarn run docs
 
 ## 🔥 How to Contribute
 
-Feel free to create new issues from [here](https://github.com/jcam1/sdks/issues/new/choose) to propose/request new features or report bugs.
+We appreciate your interest to contribute to this project! Please read the following steps to see how to contribute to this project.
+
+### 1. Create an Issue
+
+The first thing to do is to create a new issue. Feel free to create new issues from [here](https://github.com/jcam1/sdks/issues/new/choose) to propose/request new features or report bugs.
+
+### 2. Clone This Repository
+
+Next, clone this repo. Our default branch is `develop`.
+
+```sh
+$ git clone --recursive https://github.com/jcam1/sdks.git
+```
+
+### 3. Checkout to a New Branch
+
+You then need to checkout to a new branch (name whatever you would like) from the cloned `develop` branch.
+
+```sh
+$ git checkout -b ${your_branch_name}
+```
+
+### 4. Write Code
+
+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.

package.json

@@ -1,18 +1,15 @@
 {
   "name": "@jpyc/sdks",
+  "version": "1.7.1",
+  "private": true,
+  "license": "MIT",
   "description": "Node SDKs to build applications on top of JPYC protocol",
-  "keywords": [
-    "jpyc",
-    "stablecoin"
-  ],
   "repository": "https://github.com/jcam1/sdks.git",
-  "license": "MIT",
-  "version": "1.7.0",
+  "homepage": "https://github.com/jcam1/sdks.git#readme",
   "engines": {
     "node": "^20.12.0",
     "yarn": "^1.22.22"
   },
-  "private": true,
   "workspaces": [
     "packages/*"
   ],

packages/core/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 JPYC株式会社
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/core/README.md

@@ -1,5 +1,6 @@
 # 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)
 [![npm version](https://badge.fury.io/js/@jpyc%2Fsdk-core.svg)](https://badge.fury.io/js/@jpyc%2Fsdk-core)
 

packages/core/package.json

@@ -1,11 +1,18 @@
 {
   "name": "@jpyc/sdk-core",
+  "version": "1.4.1",
+  "license": "MIT",
   "description": "Core SDK for JPYC protocol",
+  "keywords": [
+    "jpyc",
+    "jpy",
+    "stablecoin",
+    "ethereum"
+  ],
   "repository": "https://github.com/jcam1/sdks.git",
-  "license": "MIT",
-  "version": "1.4.0",
-  "publishConfig": {
-    "access": "public"
+  "homepage": "https://github.com/jcam1/sdks.git#readme",
+  "bugs": {
+    "url": "https://github.com/jcam1/sdks/issues/new/choose"
   },
   "engines": {
     "node": "^20.12.0",
@@ -14,8 +21,13 @@
   "main": "dist/src",
   "types": "dist/types/src",
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "!**/*.tsbuildinfo"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "docs": "typedoc",
     "compile": "tsc",
@@ -25,25 +37,25 @@
     "format:dry-run": "prettier --check .",
     "test": "jest"
   },
+  "dependencies": {
+    "dotenv": "16.4.5",
+    "viem": "2.20.0"
+  },
   "devDependencies": {
     "@types/jest": "29.5.12",
     "@types/node": "20.14.9",
     "@typescript-eslint/eslint-plugin": "7.15.0",
     "@typescript-eslint/parser": "7.15.0",
-    "dotenv": "16.4.5",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.1.3",
     "jest": "29.7.0",
-    "npm-run-all": "4.1.5",
     "prettier": "3.3.2",
     "ts-jest": "29.2.4",
     "ts-node": "10.9.2",
-    "tsconfig-paths": "4.2.0",
     "typedoc": "0.26.6",
     "typedoc-plugin-markdown": "4.2.6",
-    "typescript": "5.5.3",
-    "viem": "2.19.4"
+    "typescript": "5.5.3"
   },
   "jest": {
     "verbose": true,

packages/core/tsconfig.json

@@ -42,8 +42,5 @@
     "esModuleInterop": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true
-  },
-  "ts-node": {
-    "require": ["tsconfig-paths/register"]
   }
 }

packages/v1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 JPYC株式会社
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/v1/README.md

@@ -1,5 +1,6 @@
 # JPYC V1 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)
 [![npm version](https://badge.fury.io/js/@jpyc%2Fsdk-v1.svg)](https://badge.fury.io/js/@jpyc%2Fsdk-v1)
 
@@ -36,7 +37,7 @@ Some data, such as configuration variables (e.g., chain name) or sensitive data
 
 #### 3. Instantiate SDK
 
-Initialize an SDK instance that implements an abstracted interface to JPYCv2 contracts.
+Initialize an SDK instance that implements an abstracted interface to the JPYCv2 contracts.
 
 ```ts
 import { ChainName, Endpoint, NetworkName } from '@jpyc/sdk-core';

packages/v1/examples/README.md

@@ -31,7 +31,7 @@ $ yarn run deploy
 
 ### 4. Set Environment Variables
 
-Run the following commands and edit the generated `.env` file accordingly. Set `LOCAL_PROXY_ADDRESS` to the value of `JPYCV2Module#FiatTokenV1` at [here](../ignition/deployments/chain-31337/deployed_addresses.json). See [here](../README.md/) for more details.
+Run the following commands and edit the generated `.env` file accordingly. Set `LOCAL_PROXY_ADDRESS` to the value of `JPYCV2Module#FiatTokenV1` at [here](../ignition/deployments/chain-31337/deployed_addresses.json). See [here](../README.md) for more details.
 
 ```sh
 $ yarn run env