Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

Commit

Permalink
Merge pull request #38 from klaytn/bug/remove-chainlink
Browse files Browse the repository at this point in the history
Removed chainlink and Modified service sdk package name
  • Loading branch information
0xxlegolas authored Mar 15, 2023
2 parents 5669e1c + 1faec02 commit daf9b57
Show file tree
Hide file tree
Showing 72 changed files with 263 additions and 1,967 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/--questions-and-others.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: "❓ Questions and Others"
about: Questions regarding Klaytn Developer SDK or other issues not related to bug nor feature request
about: Questions regarding Klaytn Service SDK or other issues not related to bug nor feature request
title: ''
labels: ''
assignees: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Please put an x in the boxes related to your change.

*Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.*

- [ ] I have read the [CONTRIBUTING GUIDELINES](https://github.com/klaytn/klaytn-developer-sdk/blob/main/CONTRIBUTING.md) doc
- [ ] I have read the [CONTRIBUTING GUIDELINES](https://github.com/klaytn/klaytn-service-sdk/blob/main/CONTRIBUTING.md) doc
- [ ] I have signed the CLA by posting "I have read the CLA Document and I hereby sign the CLA" in the comment
- [ ] Lint and unit tests pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ jobs:
- name: testing
run: npm run test
- name: Publish package on NPM 📦
run: npx pnpm --filter "@klaytn/kds-*" --filter !"@klaytn/kds-cli" -r publish --no-git-check --access public
run: npx pnpm --filter "@klaytn/kss-*" --filter !"@klaytn/kss-cli" -r publish --no-git-check --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Install kds-cli dependencies
run: cd packages/kds-cli && npm install --force
- name: Publish kds-cli package on NPM 📦
run: npx pnpm --filter "@klaytn/kds-cli" -r publish --no-git-check --access public
- name: Install kss-cli dependencies
run: cd packages/kss-cli && npm install --force
- name: Publish kss-cli package on NPM 📦
run: npx pnpm --filter "@klaytn/kss-cli" -r publish --no-git-check --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,4 @@ lint/tmp/
gas-report.txt

contracts/test/fuzzing/crytic-export!
deployedContracts.json
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ There are various ways to contribute and participate. Please read the guidelines

### Issues and Bugs

If you find a bug or other issues in Klaytn, please [submit an issue](https://github.com/klaytn/klaytn-developer-sdk/issues). Before submitting an issue, please invest some extra time to figure out that:
If you find a bug or other issues in Klaytn, please [submit an issue](https://github.com/klaytn/klaytn-service-sdk/issues). Before submitting an issue, please invest some extra time to figure out that:

- The issue is not a duplicate issue.
- The issue has not been fixed in the latest release of klaytn-developer-sdk.
- The issue has not been fixed in the latest release of klaytn-service-sdk.
Please do not use the issue tracker for personal support requests. Use [email protected] for the personal support requests.

When you report a bug, please make sure that your report has the following information.
- Steps to reproduce the issue.
- A clear and complete description of the issue.
- Code and/or screen captures are highly recommended.

After confirming your report meets the above criteria, [submit the issue](https://github.com/klaytn/klaytn-developer-sdk/issues). Please use [labels](#usage-of-labels) to categorize your issue.
After confirming your report meets the above criteria, [submit the issue](https://github.com/klaytn/klaytn-service-sdk/issues). Please use [labels](#usage-of-labels) to categorize your issue.

### Feature Requests

You can also use the [issue tracker](https://github.com/klaytn/klaytn-developer-sdk/issues) to request a new feature or enhancement. Note that any code contribution without an issue link will not be accepted.
You can also use the [issue tracker](https://github.com/klaytn/klaytn-service-sdk/issues) to request a new feature or enhancement. Note that any code contribution without an issue link will not be accepted.

Please submit an issue explaining your proposal first so that the Klaytn developer community can fully understand and discuss the idea. Please use [labels](#usage-of-labels) for your feature request as well.

Expand Down
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

![Logo](./KlaytnLogo.png)
- [Klaytn Developer SDK](#klaytn-developer-sdk)
- [Klaytn Service SDK](#klaytn-service-sdk)
- [Oracles Module](#oracles-module)
- [Chainlink](#chainlink)
- [Witnet](#witnet)
- [Bridges Module](#bridges-module)
- [Celer Bridge](#celer-bridge)
Expand All @@ -13,22 +12,16 @@
- [Requirement](#requirement)
- [Quickstart](#quickstart)
- [Usage](#usage)
- [Want to Contribute to Klaytn Developer SDK? ](#want-to-contribute-to-klaytn-developer-sdk-)
- [Want to Contribute to Klaytn Service SDK? ](#want-to-contribute-to-klaytn-service-sdk-)

<br/>

# Klaytn Developer SDK
<p style="font-size:x-large">Klaytn Developer SDK is a monorepo of all the ecosystem tools. It has all the packages necessary to build on Klaytn ecosystem</p>
# Klaytn Service SDK
<p style="font-size:x-large">Klaytn Service SDK is a monorepo of all the ecosystem tools. It has all the packages necessary to build on Klaytn ecosystem</p>

## Oracles Module
### Chainlink
Implementation of the following 4 Chainlink features using the [Hardhat](https://hardhat.org/) development environment:
- [Chainlink Data Feeds on Klaytn](/packages/oracles-starter-kit/README.md#chainlink-price-feeds)
- [Chainlink VRF on Klaytn](/packages/oracles-starter-kit/README.md#chainlink-vrf-get-a-random-number)
- [Chainlink Keepers on Klaytn](/packages/oracles-starter-kit/README.md#chainlink-keepers)
- [Request & Receive data on Klaytn](/packages/oracles-starter-kit/README.md#chainlink-request--receive-data)

### Witnet
Implementation of the following features using the [Hardhat](https://hardhat.org/) development environment:
- [Witnet Data Feeds on Klaytn](/packages/oracles-starter-kit/README.md#witnet-price-feeds)
- [Witnet Randomness on Klaytn](/packages/oracles-starter-kit/README.md#witnet-randomness)

Expand Down Expand Up @@ -72,10 +65,10 @@ Integration of the following 5 DEX contracts:
### Quickstart

After installing all the requirements, run the following:
After installing all the requirements, run the following to setup locally:
```bash
git clone https://github.com/klaytn/klaytn-developer-sdk
cd klaytn-developer-sdk
git clone https://github.com/klaytn/klaytn-service-sdk
cd klaytn-service-sdk
```
then
```bash
Expand All @@ -90,12 +83,12 @@ npm i
<br/>

# Usage
You can run the scripts in root or in respective packages by `cd` into the packages.
You can run the scripts from respective packages by `cd` into the packages.

## Want to Contribute to Klaytn Developer SDK? <a id="want-to-contribute"></a>
## Want to Contribute to Klaytn Service SDK? <a id="want-to-contribute"></a>

In line with our commitment to decentralization, all Klaytn codebase and its documentations are completely open source. Klaytn always welcomes your contribution. Anyone can view, edit, fix its contents and make suggestions. You can either create a pull request on GitHub or create a enhancement request. Make sure to check our [Contributor License Agreement (CLA)](https://gist.github.com/e78f99e1c527225637e269cff1bc7e49) first and there are also a few guidelines our contributors would check out before contributing:

- [Contribution Guide](./CONTRIBUTING.md)
- [License](./LICENSE)
- [Code of Conducts](./code-of-conduct.md)
- [Code of Conducts](./code-of-conduct.md)
38 changes: 13 additions & 25 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,33 +1,21 @@
{
"name": "@klaytn/kds",
"version": "0.0.5",
"name": "@klaytn/kss",
"version": "0.0.6",
"author": "Klaytn Community <[email protected]>",
"license": "GPL-3.0",
"repository": {
"type": "git",
"url": "https://github.com/klaytn/klaytn-developer-sdk.git"
"url": "https://github.com/klaytn/klaytn-service-sdk.git"
},
"private": true,
"scripts": {
"build": "wsrun -m build",
"lint": "wsrun -m lint",
"test": "wsrun -m test",
"oracle:help": "yarn workspace oracles-starter-kit help",
"oracle:compile": "yarn workspace oracles-starter-kit compile",
"oracle:deploy": "yarn workspace oracles-starter-kit deploy",
"oracle:test": "yarn workspace oracles-starter-kit test",
"celer:test-transfer": "yarn workspace cbridge-starter-kit test-transfer",
"celer:test-transfer-refund": "yarn workspace cbridge-starter-kit test-transfer-refund",
"celer:test-mint": "yarn workspace cbridge-starter-kit test-mint",
"celer:test-mint-refund": "yarn workspace cbridge-starter-kit test-mint-refund",
"celer:test-burn": "yarn workspace cbridge-starter-kit test-burn",
"celer:test-burn-refund": "yarn workspace cbridge-starter-kit test-burn-refund",
"wormhole:test-attest": "yarn workspace wormhole-starter-kit test-attest",
"wormhole:test-transfer-basic": "yarn workspace wormhole-starter-kit test-transfer-basic"
"test": "wsrun -m test"
},
"workspaces": {
"packages": [
"packages/!(kds-cli)/**"
"packages/!(kss-cli)/**"
],
"nohoist": [
"**/witnet-solidity-bridge"
Expand All @@ -39,12 +27,12 @@
},
"keywords": [
"klaytn",
"klaytn-developer-sdk",
"kds",
"@klaytn/kds-cli",
"@klayt/kds-bridges-celer",
"@klaytn/kds-bridges-wormhole",
"@klaytn/kds-dexs",
"@klaytn/kds-oracles"
"klaytn-service-sdk",
"kss",
"@klaytn/kss-cli",
"@klayt/kss-bridges-celer",
"@klaytn/kss-bridges-wormhole",
"@klaytn/kss-dexs",
"@klaytn/kss-oracles"
]
}
}
8 changes: 4 additions & 4 deletions packages/bridges-starter-kit/celer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ npm install

## Overview
For details information & documentation of each module of this package please refer to the docs linked below.
- ### [Overview](https://github.com/klaytn/klaytn-developer-sdk/blob/main/packages/bridges-starter-kit/celer/docs/Overview.md)
- ### [ParamsExplanation](https://github.com/klaytn/klaytn-developer-sdk/blob/main/packages/bridges-starter-kit/celer/docs/ParamsExplanation.md)
- ### [Prerequisites.md](https://github.com/klaytn/klaytn-developer-sdk/blob/main/packages/bridges-starter-kit/celer/docs/Prerequisites.md)
- ### [Overview](https://github.com/klaytn/klaytn-service-sdk/blob/main/packages/bridges-starter-kit/celer/docs/Overview.md)
- ### [ParamsExplanation](https://github.com/klaytn/klaytn-service-sdk/blob/main/packages/bridges-starter-kit/celer/docs/ParamsExplanation.md)
- ### [Prerequisites.md](https://github.com/klaytn/klaytn-service-sdk/blob/main/packages/bridges-starter-kit/celer/docs/Prerequisites.md)

## Reference Docs:

- https://cbridge-docs.celer.network/developer/cbridge-sdk
- https://github.com/celer-network/cBridge-typescript-client
- https://test-cbridge-v2.celer.network/ (Testnet Website URL)
- https://cbridge.celer.network (Mainnet Website URL)
- https://cbridge.celer.network (Mainnet Website URL)
25 changes: 12 additions & 13 deletions packages/bridges-starter-kit/celer/docs/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ method. It's a liquidity based transfer in which your assets are locked at sourc
destination_chain (receiving chain) from a pool of liquidity available on the destination chain.
Thanos snap 🫰 for this is:
```
import { poolTransfer } from "@klaytn/kds-bridges-celer"
import { poolTransfer } from "@klaytn/kss-bridges-celer"
poolTransfer(transferObj)
```
Expand All @@ -43,7 +43,7 @@ Promise `transferId` - `string` Transfer ID for tracking the transaction. To tra

#### Example
```typescript
const BridgeSDK = require('@klaytn/kds-bridges-celer')
const BridgeSDK = require('@klaytn/kss-bridges-celer')

let CBRIDGE_GATEWAY_URL = "https://cbridge-v2-test.celer.network"
let WALLET_ADDRESS = "0x5Bc0635a264B94A8662e0F2887d76F8E5925F837"
Expand Down Expand Up @@ -108,7 +108,7 @@ source_chain by submitting refund request.
🫰 of it:

```
import{ poolTransferRefund } from "@klaytn/kds-bridges-celer"
import{ poolTransferRefund } from "@klaytn/kss-bridges-celer"
poolTransferRefund(transferObj)
```
Expand All @@ -132,7 +132,7 @@ Promise `transactionReceipt` - `object` blockchain transaction receipt

#### Example
```typescript
let BridgeSDK = require("@klaytn/kds-bridges-celer");
let BridgeSDK = require("@klaytn/kss-bridges-celer");

let CBRIDGE_GATEWAY_URL = "https://cbridge-v2-test.celer.network"
let WALLET_ADDRESS = "0x5Bc0635a264B94A8662e0F2887d76F8E5925F837"
Expand Down Expand Up @@ -167,7 +167,7 @@ method. It's a traditional method in which your assets are locked at source_chai
destination_chain (receiving chain).
Thanos snap 🫰 for this is:
```
import { mintCanonicalToken } from "@klaytn/kds-bridges-celer"
import { mintCanonicalToken } from "@klaytn/kss-bridges-celer"
mintCanonicalToken(transferObj)
```
Expand All @@ -189,7 +189,7 @@ Promise `depositId` - `string` deposit id

#### Example
```typescript
let BridgeSDK = require("@klaytn/kds-bridges-celer");
let BridgeSDK = require("@klaytn/kss-bridges-celer");

let CBRIDGE_GATEWAY_URL = "https://cbridge-v2-test.celer.network"
let WALLET_ADDRESS = "0x5Bc0635a264B94A8662e0F2887d76F8E5925F837"
Expand Down Expand Up @@ -252,7 +252,7 @@ source_chain by submitting refund request.
🫰 of it:

```
import{ mintCanonicalTokenRefund } from "@klaytn/kds-bridges-celer"
import{ mintCanonicalTokenRefund } from "@klaytn/kss-bridges-celer"
mintCanonicalTokenRefund(transferObj)
```
Expand All @@ -278,7 +278,7 @@ Promise `transactionReceipt` - `object` blockchain transaction receipt

#### Example
```typescript
let BridgeSDK = require("@klaytn/kds-bridges-celer");
let BridgeSDK = require("@klaytn/kss-bridges-celer");

let CBRIDGE_GATEWAY_URL = "https://cbridge-v2-test.celer.network"
let WALLET_ADDRESS = "0x5Bc0635a264B94A8662e0F2887d76F8E5925F837"
Expand Down Expand Up @@ -316,7 +316,7 @@ destination_chain (the chain on which you want to receive you withdrawn assets).
Thanos snap 🫰 for this is:

```
import { burnCanonicalToken } from "@klaytn/kds-bridges-celer"
import { burnCanonicalToken } from "@klaytn/kss-bridges-celer"
burnCanonicalToken(transferObj)
```
Expand Down Expand Up @@ -344,7 +344,7 @@ Promise `burnId` - `string` burn id to track the status or refund transaction if

#### Example
```typescript
let BridgeSDK = require("@klaytn/kds-bridges-celer");
let BridgeSDK = require("@klaytn/kss-bridges-celer");

let CBRIDGE_GATEWAY_URL = "https://cbridge-v2-test.celer.network"
let SRC_CHAIN_RPC= "https://godwoken-testnet-v1.ckbapp.dev"
Expand Down Expand Up @@ -406,7 +406,7 @@ source_chain by submitting refund request.
🫰 of it:

```
import{ burnCanonicalTokenRefund } from "@klaytn/kds-bridges-celer"
import{ burnCanonicalTokenRefund } from "@klaytn/kss-bridges-celer"
burnCanonicalTokenRefund(transferObj)
```
Expand All @@ -431,7 +431,7 @@ Promise `transactionReceipt` - `object` blockchain transaction receipt

#### Example
```typescript
let BridgeSDK = require("@klaytn/kds-bridges-celer");
let BridgeSDK = require("@klaytn/kss-bridges-celer");

let CBRIDGE_GATEWAY_URL = "https://cbridge-v2-test.celer.network"
let WALLET_ADDRESS = "0x5Bc0635a264B94A8662e0F2887d76F8E5925F837"
Expand Down Expand Up @@ -461,4 +461,3 @@ BridgeSDK.burnCanonicalTokenRefund(
console.log("Transaction Hash: "+contractReceipt.transactionHash)
});
```

15 changes: 8 additions & 7 deletions packages/bridges-starter-kit/celer/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@klaytn/kds-bridges-celer",
"version": "0.0.5",
"name": "@klaytn/kss-bridges-celer",
"version": "0.0.6",
"description": "TypeScript client and use-cases for cBridge",
"exports": {
".": "./dist/use-cases/index.js",
"./core": "./dist/core/index.js"
},
"repository": {
"type": "git",
"url": "https://github.com/klaytn/klaytn-developer-sdk.git"
"url": "https://github.com/klaytn/klaytn-service-sdk.git"
},
"scripts": {
"test-transfer": "mocha -r ts-node/register test/poolTransfer-test.ts -t 2400000",
Expand All @@ -27,14 +27,15 @@
"celer",
"bridge",
"pooltransfer",
"mintcanonicaltoken"
"mintcanonicaltoken",
"kss-bridges-celer"
],
"author": "Klaytn Community <[email protected]>",
"license": "GPL-3.0",
"bugs": {
"url": "https://github.com/klaytn/klaytn-developer-sdk/issues"
"url": "https://github.com/klaytn/klaytn-service-sdk/issues"
},
"homepage": "https://github.com/klaytn/klaytn-developer-sdk/blob/main/packages/bridges-starter-kit/celer/README.md",
"homepage": "https://github.com/klaytn/klaytn-service-sdk/blob/main/packages/bridges-starter-kit/celer/README.md",
"dependencies": {
"axios": "^0.26.1",
"celer-web-utils": "^1.0.9",
Expand All @@ -54,4 +55,4 @@
"ts-node": "^10.7.0",
"typescript": "^4.9.4"
}
}
}
7 changes: 4 additions & 3 deletions packages/bridges-starter-kit/celer/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"exclude": ["node_modules/**/*"],
"include": [
"use-cases/**/*",
"test/*.ts"
, "test/staging/burnCanonicalToken-test.ts" ]
}
"test/*.ts",
"test/staging/burnCanonicalToken-test.ts"
]
}
Loading

0 comments on commit daf9b57

Please sign in to comment.