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

Commit daf9b57

Browse files
authored
Merge pull request #38 from klaytn/bug/remove-chainlink
Removed chainlink and Modified service sdk package name
2 parents 5669e1c + 1faec02 commit daf9b57

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+263
-1967
lines changed

.github/ISSUE_TEMPLATE/--questions-and-others.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: "❓ Questions and Others"
3-
about: Questions regarding Klaytn Developer SDK or other issues not related to bug nor feature request
3+
about: Questions regarding Klaytn Service SDK or other issues not related to bug nor feature request
44
title: ''
55
labels: ''
66
assignees: ''

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Please put an x in the boxes related to your change.
1515

1616
*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.*
1717

18-
- [ ] I have read the [CONTRIBUTING GUIDELINES](https://github.com/klaytn/klaytn-developer-sdk/blob/main/CONTRIBUTING.md) doc
18+
- [ ] I have read the [CONTRIBUTING GUIDELINES](https://github.com/klaytn/klaytn-service-sdk/blob/main/CONTRIBUTING.md) doc
1919
- [ ] I have signed the CLA by posting "I have read the CLA Document and I hereby sign the CLA" in the comment
2020
- [ ] Lint and unit tests pass locally with my changes
2121
- [ ] I have added tests that prove my fix is effective or that my feature works

.github/workflows/publish.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ jobs:
2626
- name: testing
2727
run: npm run test
2828
- name: Publish package on NPM 📦
29-
run: npx pnpm --filter "@klaytn/kds-*" --filter !"@klaytn/kds-cli" -r publish --no-git-check --access public
29+
run: npx pnpm --filter "@klaytn/kss-*" --filter !"@klaytn/kss-cli" -r publish --no-git-check --access public
3030
env:
3131
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
32-
- name: Install kds-cli dependencies
33-
run: cd packages/kds-cli && npm install --force
34-
- name: Publish kds-cli package on NPM 📦
35-
run: npx pnpm --filter "@klaytn/kds-cli" -r publish --no-git-check --access public
32+
- name: Install kss-cli dependencies
33+
run: cd packages/kss-cli && npm install --force
34+
- name: Publish kss-cli package on NPM 📦
35+
run: npx pnpm --filter "@klaytn/kss-cli" -r publish --no-git-check --access public
3636
env:
3737
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,4 @@ lint/tmp/
101101
gas-report.txt
102102

103103
contracts/test/fuzzing/crytic-export!
104+
deployedContracts.json

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,22 @@ There are various ways to contribute and participate. Please read the guidelines
2222

2323
### Issues and Bugs
2424

25-
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:
25+
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:
2626

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

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

36-
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.
36+
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.
3737

3838
### Feature Requests
3939

40-
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.
40+
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.
4141

4242
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.
4343

README.md

+11-18
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11

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

1817
<br/>
1918

20-
# Klaytn Developer SDK
21-
<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>
19+
# Klaytn Service SDK
20+
<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>
2221

2322
## Oracles Module
24-
### Chainlink
25-
Implementation of the following 4 Chainlink features using the [Hardhat](https://hardhat.org/) development environment:
26-
- [Chainlink Data Feeds on Klaytn](/packages/oracles-starter-kit/README.md#chainlink-price-feeds)
27-
- [Chainlink VRF on Klaytn](/packages/oracles-starter-kit/README.md#chainlink-vrf-get-a-random-number)
28-
- [Chainlink Keepers on Klaytn](/packages/oracles-starter-kit/README.md#chainlink-keepers)
29-
- [Request & Receive data on Klaytn](/packages/oracles-starter-kit/README.md#chainlink-request--receive-data)
30-
3123
### Witnet
24+
Implementation of the following features using the [Hardhat](https://hardhat.org/) development environment:
3225
- [Witnet Data Feeds on Klaytn](/packages/oracles-starter-kit/README.md#witnet-price-feeds)
3326
- [Witnet Randomness on Klaytn](/packages/oracles-starter-kit/README.md#witnet-randomness)
3427

@@ -72,10 +65,10 @@ Integration of the following 5 DEX contracts:
7265
7366
### Quickstart
7467

75-
After installing all the requirements, run the following:
68+
After installing all the requirements, run the following to setup locally:
7669
```bash
77-
git clone https://github.com/klaytn/klaytn-developer-sdk
78-
cd klaytn-developer-sdk
70+
git clone https://github.com/klaytn/klaytn-service-sdk
71+
cd klaytn-service-sdk
7972
```
8073
then
8174
```bash
@@ -90,12 +83,12 @@ npm i
9083
<br/>
9184

9285
# Usage
93-
You can run the scripts in root or in respective packages by `cd` into the packages.
86+
You can run the scripts from respective packages by `cd` into the packages.
9487

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

9790
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:
9891

9992
- [Contribution Guide](./CONTRIBUTING.md)
10093
- [License](./LICENSE)
101-
- [Code of Conducts](./code-of-conduct.md)
94+
- [Code of Conducts](./code-of-conduct.md)

package.json

+13-25
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,21 @@
11
{
2-
"name": "@klaytn/kds",
3-
"version": "0.0.5",
2+
"name": "@klaytn/kss",
3+
"version": "0.0.6",
44
"author": "Klaytn Community <[email protected]>",
55
"license": "GPL-3.0",
66
"repository": {
77
"type": "git",
8-
"url": "https://github.com/klaytn/klaytn-developer-sdk.git"
8+
"url": "https://github.com/klaytn/klaytn-service-sdk.git"
99
},
1010
"private": true,
1111
"scripts": {
1212
"build": "wsrun -m build",
1313
"lint": "wsrun -m lint",
14-
"test": "wsrun -m test",
15-
"oracle:help": "yarn workspace oracles-starter-kit help",
16-
"oracle:compile": "yarn workspace oracles-starter-kit compile",
17-
"oracle:deploy": "yarn workspace oracles-starter-kit deploy",
18-
"oracle:test": "yarn workspace oracles-starter-kit test",
19-
"celer:test-transfer": "yarn workspace cbridge-starter-kit test-transfer",
20-
"celer:test-transfer-refund": "yarn workspace cbridge-starter-kit test-transfer-refund",
21-
"celer:test-mint": "yarn workspace cbridge-starter-kit test-mint",
22-
"celer:test-mint-refund": "yarn workspace cbridge-starter-kit test-mint-refund",
23-
"celer:test-burn": "yarn workspace cbridge-starter-kit test-burn",
24-
"celer:test-burn-refund": "yarn workspace cbridge-starter-kit test-burn-refund",
25-
"wormhole:test-attest": "yarn workspace wormhole-starter-kit test-attest",
26-
"wormhole:test-transfer-basic": "yarn workspace wormhole-starter-kit test-transfer-basic"
14+
"test": "wsrun -m test"
2715
},
2816
"workspaces": {
2917
"packages": [
30-
"packages/!(kds-cli)/**"
18+
"packages/!(kss-cli)/**"
3119
],
3220
"nohoist": [
3321
"**/witnet-solidity-bridge"
@@ -39,12 +27,12 @@
3927
},
4028
"keywords": [
4129
"klaytn",
42-
"klaytn-developer-sdk",
43-
"kds",
44-
"@klaytn/kds-cli",
45-
"@klayt/kds-bridges-celer",
46-
"@klaytn/kds-bridges-wormhole",
47-
"@klaytn/kds-dexs",
48-
"@klaytn/kds-oracles"
30+
"klaytn-service-sdk",
31+
"kss",
32+
"@klaytn/kss-cli",
33+
"@klayt/kss-bridges-celer",
34+
"@klaytn/kss-bridges-wormhole",
35+
"@klaytn/kss-dexs",
36+
"@klaytn/kss-oracles"
4937
]
50-
}
38+
}

packages/bridges-starter-kit/celer/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ npm install
2828

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

3535
## Reference Docs:
3636

3737
- https://cbridge-docs.celer.network/developer/cbridge-sdk
3838
- https://github.com/celer-network/cBridge-typescript-client
3939
- https://test-cbridge-v2.celer.network/ (Testnet Website URL)
40-
- https://cbridge.celer.network (Mainnet Website URL)
40+
- https://cbridge.celer.network (Mainnet Website URL)

packages/bridges-starter-kit/celer/docs/Overview.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ method. It's a liquidity based transfer in which your assets are locked at sourc
1919
destination_chain (receiving chain) from a pool of liquidity available on the destination chain.
2020
Thanos snap 🫰 for this is:
2121
```
22-
import { poolTransfer } from "@klaytn/kds-bridges-celer"
22+
import { poolTransfer } from "@klaytn/kss-bridges-celer"
2323
2424
poolTransfer(transferObj)
2525
```
@@ -43,7 +43,7 @@ Promise `transferId` - `string` Transfer ID for tracking the transaction. To tra
4343

4444
#### Example
4545
```typescript
46-
const BridgeSDK = require('@klaytn/kds-bridges-celer')
46+
const BridgeSDK = require('@klaytn/kss-bridges-celer')
4747

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

110110
```
111-
import{ poolTransferRefund } from "@klaytn/kds-bridges-celer"
111+
import{ poolTransferRefund } from "@klaytn/kss-bridges-celer"
112112
113113
poolTransferRefund(transferObj)
114114
```
@@ -132,7 +132,7 @@ Promise `transactionReceipt` - `object` blockchain transaction receipt
132132

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

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

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

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

254254
```
255-
import{ mintCanonicalTokenRefund } from "@klaytn/kds-bridges-celer"
255+
import{ mintCanonicalTokenRefund } from "@klaytn/kss-bridges-celer"
256256
257257
mintCanonicalTokenRefund(transferObj)
258258
```
@@ -278,7 +278,7 @@ Promise `transactionReceipt` - `object` blockchain transaction receipt
278278

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

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

318318
```
319-
import { burnCanonicalToken } from "@klaytn/kds-bridges-celer"
319+
import { burnCanonicalToken } from "@klaytn/kss-bridges-celer"
320320
321321
burnCanonicalToken(transferObj)
322322
```
@@ -344,7 +344,7 @@ Promise `burnId` - `string` burn id to track the status or refund transaction if
344344

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

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

408408
```
409-
import{ burnCanonicalTokenRefund } from "@klaytn/kds-bridges-celer"
409+
import{ burnCanonicalTokenRefund } from "@klaytn/kss-bridges-celer"
410410
411411
burnCanonicalTokenRefund(transferObj)
412412
```
@@ -431,7 +431,7 @@ Promise `transactionReceipt` - `object` blockchain transaction receipt
431431

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

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

packages/bridges-starter-kit/celer/package.json

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
2-
"name": "@klaytn/kds-bridges-celer",
3-
"version": "0.0.5",
2+
"name": "@klaytn/kss-bridges-celer",
3+
"version": "0.0.6",
44
"description": "TypeScript client and use-cases for cBridge",
55
"exports": {
66
".": "./dist/use-cases/index.js",
77
"./core": "./dist/core/index.js"
88
},
99
"repository": {
1010
"type": "git",
11-
"url": "https://github.com/klaytn/klaytn-developer-sdk.git"
11+
"url": "https://github.com/klaytn/klaytn-service-sdk.git"
1212
},
1313
"scripts": {
1414
"test-transfer": "mocha -r ts-node/register test/poolTransfer-test.ts -t 2400000",
@@ -27,14 +27,15 @@
2727
"celer",
2828
"bridge",
2929
"pooltransfer",
30-
"mintcanonicaltoken"
30+
"mintcanonicaltoken",
31+
"kss-bridges-celer"
3132
],
3233
"author": "Klaytn Community <[email protected]>",
3334
"license": "GPL-3.0",
3435
"bugs": {
35-
"url": "https://github.com/klaytn/klaytn-developer-sdk/issues"
36+
"url": "https://github.com/klaytn/klaytn-service-sdk/issues"
3637
},
37-
"homepage": "https://github.com/klaytn/klaytn-developer-sdk/blob/main/packages/bridges-starter-kit/celer/README.md",
38+
"homepage": "https://github.com/klaytn/klaytn-service-sdk/blob/main/packages/bridges-starter-kit/celer/README.md",
3839
"dependencies": {
3940
"axios": "^0.26.1",
4041
"celer-web-utils": "^1.0.9",
@@ -54,4 +55,4 @@
5455
"ts-node": "^10.7.0",
5556
"typescript": "^4.9.4"
5657
}
57-
}
58+
}

packages/bridges-starter-kit/celer/tsconfig.json

+4-3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"exclude": ["node_modules/**/*"],
2828
"include": [
2929
"use-cases/**/*",
30-
"test/*.ts"
31-
, "test/staging/burnCanonicalToken-test.ts" ]
32-
}
30+
"test/*.ts",
31+
"test/staging/burnCanonicalToken-test.ts"
32+
]
33+
}

0 commit comments

Comments
 (0)