Skip to content

Commit

Permalink
Updated Kaia changes (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
praveen-kaia authored Aug 12, 2024
1 parent a65a460 commit f2cb2a7
Show file tree
Hide file tree
Showing 18 changed files with 46 additions and 53 deletions.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ 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-tests/blob/master/CONTRIBUTING.md) doc
- [ ] I have signed the [CLA](https://cla-assistant.io/klaytn/klaytn-tests)
- [ ] I have read the [CONTRIBUTING GUIDELINES](https://github.com/kaiachain/kaia-core-tests/blob/main/CONTRIBUTING.md) doc
- [ ] I have read the [CLA](https://gist.github.com/kaiachain-dev/bbf65cc330275c057463c4c94ce787a6) and signed by comment ```I have read the CLA Document and I hereby sign the CLA``` in first time contribute
- [ ] Lint and unit tests pass locally with my changes (`$ make test`)
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing Guidelines

Thank you for your interest in contributing to klaytn-tests. As an open source project, klaytn-tests is always open to the developer community and we welcome your contribution. Please read the guideline below and follow it in all interactions with the project.
Thank you for your interest in contributing to kaia-core-tests. As an open source project, kaia-core-tests is always open to the developer community and we welcome your contribution. Please read the guideline below and follow it in all interactions with the project.

## How to Contribute

Expand All @@ -21,22 +21,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-tests, please [submit an issue](https://github.com/klaytn/klaytn-tests/issues). Before submitting an issue, please invest some extra time to figure out that:
If you find a bug or other issues in kaia-core-tests, please [submit an issue](https://github.com/kaiachain/kaia-core-tests/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-tests.
Please do not use the issue tracker for personal support requests. Use developer@klaytn.com for the personal support requests.
- The issue has not been fixed in the latest release of kaia-core-tests.
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-tests/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-core-tests/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-tests/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 Klaytn community can fully understand and discuss the idea. Please use [labels](#usage-of-labels) for your feature request as well.
You can also use the [issue tracker](https://github.com/kaiachain/kaia-core-tests/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 Kaia 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 Expand Up @@ -67,6 +67,6 @@ Status of closed issues:

## Contributor License Agreement (CLA)

Keep in mind when you submit your pull request, you'll need to sign the CLA via [CLA-Assistant](https://cla-assistant.io/klaytn/klaytn-tests) for legal purposes. You will have to sign the CLA just one time, either as an individual or corporation.
Keep in mind when you submit your pull request, you'll need to read the [CLA](https://gist.github.com/kaiachain-dev/bbf65cc330275c057463c4c94ce787a6) and signed by comment ```I have read the CLA Document and I hereby sign the CLA``` in first time contribution for legal purposes. You will have to sign the CLA just one time, either as an individual or corporation.

You will be prompted to sign the agreement by CLA Assistant (bot) when you open a Pull Request for the first time.
You will be prompted to sign the agreement by CLA Assistant (bot) when you open a Pull Request for the first time.
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Modifications copyright 2019 The klaytn-tests Authors
Copyright 2024 Kaia DLT Foundation
Copyright 2019-2024 The klaytn-tests Authors
Copyright 2014 Ethereum Foundation

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:
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
KLAYTN_TEST_PATH=$(CURDIR)
export KLAYTN_TEST_PATH
KAIA_TEST_PATH=$(CURDIR)
export KAIA_TEST_PATH

# TODO: stop stripping out stEWASMTests from gs_tests
tx_tests:=$(wildcard TransactionTests/*)
Expand Down
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
[![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](https://kaia.io/).

---

Klaytn tests
Kaia tests
============

Common tests for Klaytn clients.
Common tests for Kaia clients.


Documentation
Expand Down Expand Up @@ -39,16 +31,16 @@ Test files in the folders below are currently used for testing:
NOTE: Originally BlockchainTests, GeneralStateTests, TransactionTests, and VMTests
were created by the testFillers which could be found at
https://github.com/ethereum/cpp-ethereum/tree/develop/test/tools/jsontests at
src folder. However, Klaytn tests currently cannot use the testFillers. We
src folder. However, Kaia tests currently cannot use the testFillers. We
will make our own filler specification and testFillers.


How to use test set
-------------------

To use this test set, you need to clone this repository or make a symbolic link
inside `tests` of https://github.com/klaytn/klaytn/ as `testdata`.
For details, see https://github.com/klaytn/klaytn/blob/master/tests/README.md.
inside `tests` of https://github.com/kaiachain/kaia/ as `testdata`.
For details, see https://github.com/kaiachain/kaia/blob/main/tests/README.md.


Test set sanitation
Expand Down
6 changes: 3 additions & 3 deletions TERMS-OF-USE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## 1. Your Use of Open Source Software

We may make (but are not obligated to make) the source code of Klaytn Blockchain Network Platform ("Platform"), the software on the Platform, etc. for download as open source software. If you use this open source software, you agree to be bound by and comply with any license that applies to this open source software. You will not indicate that you are associated with us in connection with your use, modifications or distributions of this open source software.
We may make (but are not obligated to make) the source code of Kaia Blockchain Network Platform ("Platform"), the software on the Platform, etc. for download as open source software. If you use this open source software, you agree to be bound by and comply with any license that applies to this open source software. You will not indicate that you are associated with us in connection with your use, modifications or distributions of this open source software.

## 2. Services Provided on the Platform

The Platform is a combination of peer-to-peer subnetworks of nodes transmitting transactions and blocks to execute value transfers and run smart contracts. The Core Cell Network ("CCN"), which is one of the subnetworks that constitute the Platform, verifies and executes transactions that occur on the Platform. The CCN is operated by Klaytn Governance Council, which is a collective group of Core Cell Operators, and Klaytn is not directly involved in any services that are provided in or individual transactions that occur on the Platform.
The Platform is a combination of peer-to-peer subnetworks of nodes transmitting transactions and blocks to execute value transfers and run smart contracts. The Core Cell Network ("CCN"), which is one of the subnetworks that constitute the Platform, verifies and executes transactions that occur on the Platform. The CCN is operated by Kaia Governance Council, which is a collective group of Core Cell Operators, and Kaia is not directly involved in any services that are provided in or individual transactions that occur on the Platform.

## 3. Your Installation of BApp on the Platform

Your use of open source software is free of charge. However, you may be required to pay a certain number of KLAY as a transaction fee in order to execute a transaction on the Platform, including the installation of the BApp on the Platform.
Your use of open source software is free of charge. However, you may be required to pay a certain number of KAIA as a transaction fee in order to execute a transaction on the Platform, including the installation of the BApp on the Platform.

Once transaction is executed successfully and respective block generation is verified successfully by the Platform’s mechanism, the block is irreversibly stored in the blockchain. As such, your installation of the BApp and any other transactions on the Platform, as well as the submission of transaction fee is final and irrevocable.

Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = KlaytnTests
SPHINXPROJ = KaiaTests
SOURCEDIR = .
BUILDDIR = _build

Expand Down
20 changes: 10 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Klaytn Tests documentation build configuration file, created by
# Kaia Tests documentation build configuration file, created by
# sphinx-quickstart on Mon Aug 28 19:37:19 2017.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -46,9 +46,9 @@
master_doc = 'index'

# General information about the project.
project = 'Klaytn Tests'
copyright = '2018, Klaytn Community'
author = 'Klaytn Community'
project = 'Kaia Tests'
copyright = '2024, Kaia DLT Foundation'
author = 'Kaia Community'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -115,7 +115,7 @@
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'KlaytnTestsdoc'
htmlhelp_basename = 'KaiaTestsdoc'


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -142,8 +142,8 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'KlaytnTests.tex', 'Klaytn Tests Documentation',
'Klaytn Community', 'manual'),
(master_doc, 'KaiaTests.tex', 'Kaia Tests Documentation',
'Kaia Community', 'manual'),
]


Expand All @@ -152,7 +152,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'klaytntests', 'Klaytn Tests Documentation',
(master_doc, 'kaiatests', 'Kaia Tests Documentation',
[author], 1)
]

Expand All @@ -163,8 +163,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'KlaytnTests', 'Klaytn Tests Documentation',
author, 'KlaytnTests', 'One line description of project.',
(master_doc, 'KaiaTests', 'Kaia Tests Documentation',
author, 'KaiaTests', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
2 changes: 1 addition & 1 deletion docs/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Contribute to Docs
This documentation has been build using the Python `Sphinx <http://www.sphinx-doc.org/>`_
documentation tool.

Since the `Klaytn tests <https://github.com/klaytn/klaytn-tests>`_ repository is very
Since the `Kaia tests <https://github.com/kaiachain/kaia-core-tests>`_ repository is very
large to clone locally, a convenient way to contribute to the documentation is to
make a fork of the test repo, add the changes online with the GitHub
`reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_ editor
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _klaytn_tests:
.. _kaia_tests:

############
Klaytn Tests
Kaia Tests
############
| Common tests for all clients to test against. The `git repo <https://github.com/klaytn/klaytn-tests>`_ updated regulary with new tests.
| Common tests for all clients to test against. The `git repo <https://github.com/kaiachain/kaia-core-tests>`_ updated regulary with new tests.
| This section describes basic test concepts and templates.
.. note::
Expand Down
2 changes: 1 addition & 1 deletion docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=KlaytnTests
set SPHINXPROJ=KaiaTests

if "%1" == "" goto help

Expand Down
4 changes: 2 additions & 2 deletions docs/test_types/blockchain_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Blockchain Tests
The blockchain tests aim is to test the basic verification of a blockchain.

=================== ==============================================================
Location `/BlockchainTests <https://github.com/klaytn/klaytn-tests/tree/master/BlockchainTests>`_
Location `/BlockchainTests <https://github.com/kaiachain/kaia-core-tests/tree/main/BlockchainTests>`_
Supported Hardforks ``Byzantium``
Status Disabled due to the changes in Klaytn's block header
Status Disabled due to the changes in Kaia's block header
=================== ==============================================================

A blockchain test is based around the notion of executing a list of single blocks,
Expand Down
2 changes: 1 addition & 1 deletion docs/test_types/rlp_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Describes an **RLP** (https://github.com/ethereum/wiki/wiki/RLP) encoding using
the .json file.

=================== ==============================================================
Location `/RLPTests <https://github.com/klaytn/klaytn-tests/tree/master/RLPTests>`_
Location `/RLPTests <https://github.com/kaiachain/kaia-core-tests/tree/main/RLPTests>`_
Supported Hardforks Hardfork-independent
Status Actively supported
=================== ==============================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/test_types/state_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ General State Tests
The state tests aim is to test the basic workings of the state in isolation.

=================== ==============================================================
Location `/GeneralStateTests <https://github.com/klaytn/klaytn-tests/tree/master/GeneralStateTests>`_
Location `/GeneralStateTests <https://github.com/kaiachain/kaia-core-tests/tree/main/GeneralStateTests>`_
Supported Hardforks ``Byzantium``
Status Actively supported
=================== ==============================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/test_types/transaction_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Transaction Tests
Describes a complete transaction and its `RLP <https://github.com/ethereum/wiki/wiki/RLP>`_ representation using the .json file.

=================== ==============================================================
Location `/TransactionTests <https://github.com/klaytn/klaytn-tests/tree/master/TransactionTests>`_
Location `/TransactionTests <https://github.com/kaiachain/kaia-core-tests/tree/main/TransactionTests>`_
Supported Hardforks ``Byzantium``
Status Actively supported
=================== ==============================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/test_types/vm_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The VM tests aim is to test the basic workings of the VM in
isolation.

=================== ==============================================================
Location `/VMTests <https://github.com/klaytn/klaytn-tests/tree/master/VMTests>`_
Location `/VMTests <https://github.com/kaiachain/kaia-core-tests/tree/main/VMTests>`_
Supported Hardforks ``Byzantium``
Status Actively supported
=================== ==============================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/using-testeth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Test Creation
=============

NOTE: This page will be updated to describe how to create tests for Klaytn.
NOTE: This page will be updated to describe how to create tests for Kaia.

Instructions on how to create tests and how to use the cpp-client ``testeth`` tool
can be found in the `test generation chapter <https://ethereum-tests.readthedocs.io/en/latest/generating-tests.html>`_.
2 changes: 1 addition & 1 deletion update_state.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Description
# This script updates values of "hash" and "logs" in *.json files if `make test` fails.
# This is useful when you change default behaviors of Klaytn.
# This is useful when you change default behaviors of Kaia.
#
# How to use
# $ ./update_state.sh
Expand Down

0 comments on commit f2cb2a7

Please sign in to comment.