Read this in Korean: Korean
caver-js-examples provide code samples to help you use the Klaytn SDK(caver-js) easier and faster. Here you can find and test code samples conceived for different scenarios.
In order to follow this tutorial, you have to first install the software as listed on Docs. The link explains which software you need for creating this project.
You can use the Klaytn SDK(caver-js) by connecting to one of the nodes that comprise the Klaytn network. But for the caver-js-examples project, we are using the Node API of KAS, which means that you don't have to run an Endpoint Node (EN) yourself to test the code samples.
To use KAS, first sign up on KAS, and obtain the AccessKey ID and Secret AccessKey.
You can find detailed instructions on how to use the AccessKey ID and Secret AccessKey in 2. How to Use.
In order to execute the code samples, you need a test account with a sufficient balance of testnet KLAY. Because the code samples also involves sending a transaction to Klaytn, you need at least one test account. If you have updated your account key, and your old test account is rendered unusable, you can create a new account. Create a test account following the instructions below and obtain your 5 testnet KLAY. Depending on the scenarios, you may need multiple test accounts. In that case, just repeat the process to create multiple test accounts.
- Create a test account at Klaytn Wallet Testnet.
- Have the address and private key of the new account written down, because you will need them for testing the code samples.
- Make sure to also save the keystore file, because some scenarios require it.
- Obtain 5 testnet KLAY on Baobab Klaytn Wallet Faucet.
- Clone this project and then execute
$ git clone https://github.com/klaytn/caver-js-examples.gitin Terminal. - To run the samples, you need to set the Credential (AccessKey ID and Secret AccessKey) which can be obtained on KAS Console as well as a Klaytn account obtained on Klaytn Wallet Testnet. We recommend using the test account just for testing.
- Option 1 (recommended): Define the Credential information and your Klaytn account in the caver-js-examples/.env file. The variables defined in this file apply for all scenarios. You can find the code for retrieving the variables defined in the .env file in the
loadEnvfunction within index.js of each scenario. - Option 2: Open the index.js file for the scenario and fill in the variables declared with the keyword
let.
- Option 1 (recommended): Define the Credential information and your Klaytn account in the caver-js-examples/.env file. The variables defined in this file apply for all scenarios. You can find the code for retrieving the variables defined in the .env file in the
- In Terminal, execute the code sample using
node <Common Architecture Layer>/<Scenario>/index.js.- Example 1:
$ node account/update_account_with_account_key_public/index.js - Example 2:
$ node contract/fee_delegation/index.js
- Example 1:
If you want to jump right into using caver regardless of the scenarios, try printing hello_world using one of the commands below:
$ cd hello_world && node ./index.js$ node hello_world/index.js
Explore and test code using caver with the run function in the caver-js-examples/hello_world/index.js file.
Below is an explanation of the caver-js-examples project structure.
On the first level of the directory tree, you will find Layers that Comprise the Common Architecture. This will be refered to as CA-Layers from now on.
.
├── abi
├── account
├── ...
└── wallet
Under the CA-Layers level, you will find Sample Scenarios. For example, the sample scenarios within the directory of the account layer look like this:
account
├── update_account_with_account_key_public
├── update_account_with_account_key_role_based
└── update_account_with_account_key_weighted_multisig
- Each scenario includes a index.js file, and if the scenario requires a specific file, it employs a
resourcesdirectory. - This allows the users to execute the samples right away.
The caver-js-example project consists of multiple CA-Layer/Scenario, and lets you run the code samples with node CA-Layer/Scenario/index.js in the project root directory or node ./index.js in the scenario's directory.
caver-js-examples is released under the MIT license.
MIT License
Copyright (c) 2021 caver-js-examples Authors
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.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent