Skip to content

Commit

Permalink
Merge pull request #2 from praveen-klaytn/main
Browse files Browse the repository at this point in the history
Updated Kaia changes
  • Loading branch information
praveen-kaia authored Jun 21, 2024
2 parents 8ace395 + d235e62 commit e1a71c2
Show file tree
Hide file tree
Showing 63 changed files with 288 additions and 316 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
#* @global-owner1 @global-owner2
* @toniya-klaytn @praveen-klaytn @naveed-klaytn
* @praveen-klaytn @naveed-klaytn

# Order is important; the last matching pattern takes the most
# precedence. When someone opens a pull request that only
Expand Down
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 Service SDK or other issues not related to bug nor feature request
about: Questions regarding Kaia 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-service-sdk/blob/main/CONTRIBUTING.md) doc
- [ ] I have read the [CONTRIBUTING GUIDELINES](https://github.com/kaiachain/kaia-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
26 changes: 0 additions & 26 deletions .github/workflows/CLA.yml

This file was deleted.

16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contributing Guidelines

Thank you for your interest in contributing to Klaytn. As an open source project, Klaytn is always open to the developer community and we welcome your contribution to help more developer onboarding resources for the Klaytn developer community. Please read the guideline below and follow it in all interactions with the project.
Thank you for your interest in contributing to Kaia. As an open source project, Kaia is always open to the developer community and we welcome your contribution to help more developer onboarding resources for the Kaia developer community. Please read the guideline below and follow it in all interactions with the project.

## How to Contribute on Klaytn
## How to Contribute on Kaia

1. Read this [contributing document](./CONTRIBUTING.md).
2. Sign [Contributor Licensing Agreement (CLA)](#contributor-license-agreement-cla).
Expand All @@ -22,24 +22,24 @@ 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-service-sdk/issues). Before submitting an issue, please invest some extra time to figure out that:
If you find a bug or other issues in Kaia, please [submit an issue](https://github.com/kaiachain/kaia-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-service-sdk.
Please do not use the issue tracker for personal support requests. Use developer@klaytn.foundation for the personal support requests.
- The issue has not been fixed in the latest release of kaia-service-sdk.
Please do not use the issue tracker for personal support requests. Use developer@kaia.io 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-service-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/kaiachain/kaia-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-service-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/kaiachain/kaia-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.
Please submit an issue explaining your proposal first so that the Kaia developer community can fully understand and discuss the idea. Please use [labels](#usage-of-labels) for your feature request as well.

#### Usage of Labels

Expand Down
30 changes: 30 additions & 0 deletions KaiaLogo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed KlaytnLogo.png
Binary file not shown.
42 changes: 17 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)

# NO LONGER MAINTAINED

Since the launch of Kaia Blockchain this repository has been parked in favour of the new open-source projects in [Kaia's Github](https://github.com/kaiachain). Contributors have now moved there continuing with massive open-source contributions to our blockchain ecosystem. A big thank you to everyone who has contributed to this repository. For more information about Klaytn's chain merge with Finschia blockchain please refer to the launching of Kaia blockchain - [kaia.io](http://kaia.io/).

---

![Logo](./KlaytnLogo.png)
- [Klaytn Service SDK](#klaytn-service-sdk)
![Logo](./KaiaLogo.svg)
- [Kaia Service SDK](#kaia-service-sdk)
- [Oracles Module](#oracles-module)
- [Witnet](#witnet)
- [Bridges Module](#bridges-module)
Expand All @@ -21,18 +13,18 @@ Since the launch of Kaia Blockchain this repository has been parked in favour of
- [Requirement](#requirement)
- [Steps to setup locally](#steps-to-setup-locally)
- [Usage](#usage)
- [Want to Contribute to Klaytn Service SDK? ](#want-to-contribute-to-klaytn-service-sdk-)
- [Want to Contribute to Kaia Service SDK? ](#want-to-contribute-to-kaia-service-sdk-)

<br/>

# Klaytn Service SDK
Klaytn Service SDK is a monorepo of all the services in the Klaytn ecosystem. Check out [Quick Usage](#quick-usage) to integrate the services in the dapp
# Kaia Service SDK
Kaia Service SDK is a monorepo of all the services in the Kaia ecosystem. Check out [Quick Usage](#quick-usage) to integrate the services in the dapp

## Oracles Module
### 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)
- [Witnet Data Feeds on Kaia](/packages/oracles-starter-kit/README.md#witnet-price-feeds)
- [Witnet Randomness on Kaia](/packages/oracles-starter-kit/README.md#witnet-randomness)


## Bridges Module
Expand Down Expand Up @@ -62,13 +54,13 @@ Integration of the following 5 DEX contracts:

## Quick Usage

To use klaytn-service-sdk, you can import the below npm packages in an existing nodejs project. Instructions for importing the package and utilizing its features can be found in the readme provided in the links below.
To use kaia-service-sdk, you can import the below npm packages in an existing nodejs project. Instructions for importing the package and utilizing its features can be found in the readme provided in the links below.

- [@klaytn/kss-bridges-wormhole](https://www.npmjs.com/package/@klaytn/kss-bridges-wormhole) - Contains Wormhole integration
- [@klaytn/kss-bridges-celer](https://www.npmjs.com/package/@klaytn/kss-bridges-celer) - Contains Celer integration
- [@klaytn/kss-dexs](https://www.npmjs.com/package/@klaytn/kss-dexs) - Contains Dexs integration
- [@klaytn/kss-oracles](https://www.npmjs.com/package/@klaytn/kss-oracles) - Contains Oracles integration
- [@klaytn/kss-cli](https://www.npmjs.com/package/@klaytn/kss-cli) - Contains CLI features
- [@kaiachain/kss-bridges-wormhole](https://www.npmjs.com/package/@kaiachain/kss-bridges-wormhole) - Contains Wormhole integration
- [@kaiachain/kss-bridges-celer](https://www.npmjs.com/package/@kaiachain/kss-bridges-celer) - Contains Celer integration
- [@kaiachain/kss-dexs](https://www.npmjs.com/package/@kaiachain/kss-dexs) - Contains Dexs integration
- [@kaiachain/kss-oracles](https://www.npmjs.com/package/@kaiachain/kss-oracles) - Contains Oracles integration
- [@kaiachain/kss-cli](https://www.npmjs.com/package/@kaiachain/kss-cli) - Contains CLI features

## Setup Locally

Expand All @@ -91,8 +83,8 @@ If you would like to explore current repository, please follow below instruction

After installing all the requirements, run the following to setup locally:
```bash
git clone https://github.com/klaytn/klaytn-service-sdk
cd klaytn-service-sdk
git clone https://github.com/kaiachain/kaia-service-sdk
cd kaia-service-sdk
```
then
```bash
Expand All @@ -109,9 +101,9 @@ npm i
# Usage
You can run the scripts from respective packages by `cd` into the packages.

## Want to Contribute to Klaytn Service SDK? <a id="want-to-contribute"></a>
## Want to Contribute to Kaia 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:
In line with our commitment to decentralization, all Kaia codebase and its documentations are completely open source. Kaia 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)
Expand Down
2 changes: 1 addition & 1 deletion code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ representative at an online or offline event.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the project maintainers responsible for enforcement at developer@klaytn.foundation.
reported to the project maintainers responsible for enforcement at developer@kaia.io.
All complaints will be reviewed and investigated promptly and fairly.

All project maintainers are obligated to respect the privacy and security of the
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "@kaiachain/kss",
"version": "1.0.0",
"author": "Klaytn Community <developer@kaiachain.foundation>",
"author": "Kaia Community <developer@kaia.io>",
"license": "GPL-3.0",
"repository": {
"type": "git",
"url": "https://github.com/klaytn/klaytn-service-sdk.git"
"url": "https://github.com/kaiachain/kaia-service-sdk.git"
},
"private": true,
"scripts": {
Expand Down
13 changes: 6 additions & 7 deletions packages/bridges-starter-kit/celer/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Klaytn cBridge starter kit
- [Klaytn cBridge starter kit](#klaytn-cbridge-starter-kit)
# Kaia cBridge starter kit
- [Kaia cBridge starter kit](#kaia-cbridge-starter-kit)
- [About](#about)
- [Folder Structure](#folder-structure)
- [Setup](#setup)
Expand All @@ -8,8 +8,7 @@

## About
cBridge provides a simple liquidity provider experience and high liquidity efficiency for users when they manage their funds in different
chains with lower costs. Learn more about flow and terminology from this doc:
[cBridge requirements](https://docs.google.com/document/d/15gVJfiAjzfR9dyz_ad7jQOx5PSPI6p_RanLA6XRLCYU/edit?usp=sharing)
chains with lower costs.

## Folder Structure

Expand All @@ -28,9 +27,9 @@ 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-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)
- ### [Overview](https://github.com/kaiachain/kaia-service-sdk/blob/main/packages/bridges-starter-kit/celer/docs/Overview.md)
- ### [ParamsExplanation](https://github.com/kaiachain/kaia-service-sdk/blob/main/packages/bridges-starter-kit/celer/docs/ParamsExplanation.md)
- ### [Prerequisites.md](https://github.com/kaiachain/kaia-service-sdk/blob/main/packages/bridges-starter-kit/celer/docs/Prerequisites.md)

## Reference Docs:

Expand Down
Loading

0 comments on commit e1a71c2

Please sign in to comment.