KAS Console
This page introduces KAS Console.
Dashboard
Dashboard, KAS Console's main page, is used for checking your KAS API usage.
Security
KAS Console - Security has Credential and Permission menus.
Credential
Under the Credential menu, you can create or delete authentication keys, which are used to identify API users as KAS members, for API calls. KAS utilizes the basic authetication method for authenticating APIs, and an authentication key consists of Authentication ID (AccessKey ID) and Authentication Password (Secret AccessKey).
An API authentication key can be created on KAS Console - Security - Credential menu, and the authentication password (Secret AccessKey) and Authorization can only be checked once upon their creation. Therefore, it is necessary to copy or download Secret AccessKey and Authorization to a safe location for proper and safe management after its creation. Authorization (e.g., Basic S0FTS1A2WkRaSjh...), which can be checked after creating an authentication key, refers to a value encoded using the AccessKey ID and Secret AccessKey through the basic authentication method and used for the call header when calling APIs.
A KAS API Authentication Key (API Auth Key) provides access to all KAS services and all the rights to a Klaytn account which was created by calling Wallet API via this API Auth Key. The rights here include accessing and transferring all the assets (KLAY, etc.) of or sending a transaction from a Klaytn account. If you shared your API Auth Key with any unauthorized personnel, your Klaytn account could be compromised and might cause unwanted transaction execution.
DO NOT share your API Auth Key (Secret AccessKey or Authorization) with any unauthorized personnel. DO PUT efforts necessary to keep your API Auth Key safe for the security of your KAS/Klaytn account.
Authentication keys can be created through the KAS Console > Security > Credential menu. Up to two authentication keys can be created. For replacing an authentication key, delete the existing key first before creating a new one.
For inquires about this document or KAS, please visit Developer Forum.
Permission
You can check and modify user privileges under the Permission menu.
With KAS, all users currently have privileges to use all APIs by default. A user- or API-specific permission setting function will be added later.
KAS permission is an object that has API call permission as the key:value type setting value. KAS evaluates a request using this permission when a user calls the API. The request may be accepted or denied depending on the permission object's setting value. Privileges are stored as JSON documents and include the following elements:
Statement - A permission can have several comments. Comments, such as Action, Resource, and Effect, are applied in OR relation when requests are evaluated.
Action - Action refers to the list of allowed KAS APIs. Currently, all APIs (
*) are permitted.Resource - Resource pertains to the list of allowed resources. KRN is used for this.
Effect - Effect determines whether to accept or deny access to the APIs/resources set above (
allowordeny).sid - The term "sid" is an annotation of permission settings.
For instance, privileges for using all APIs are granted to a user's accounts if the following permission form is applied.
For a sample case of using the Permission menu, refer to Getting Started.
For inquires about this document or KAS, please visit Developer Forum.
Service
KAS Console - Service menu includes the Klaytn Node, Token History, Wallet, and Anchor menus.
Klaytn Node
Klaytn Node menu shows how to use the Klaytn Node API. Without building and operating the Klaytn Endpoint Node (EN), with Klaytn Node API, you can now call the JSON-RPC functions to Klaytn or retrieve diverse information about Klaytn blockchain.
Checking which JSON-RPC APIs are supported by Klaytn Node API and understanding the steps for calling an API can also be done through this menu. For more details on JSON-RPC API, refer to JSON-RPC API Reference.
For inquires about this document or KAS, please visit Developer Forum.
Token History
The Token History menu is used to create presets and search labeled tokens.
Preset
The Preset menu is where you register, delete, update, or check presets, which are the information required for KAS to get transaction records for one or more tokens. Creating presets means that you register a Klaytn account address (EOA), FT address, NFT address to KAS. By using registered preset and Token History API, you can look for necessary information from vast token transaction histories.
Labeled Tokens
Labeling is the task that registers your token information into KAS and by that KAS can track the history of token transactions. KAS automatically tracks the information of tokens that follow KIP-7, KIP-17 standard. This means that KAS automatically labels KIP-7 and KIP-17 tokens.
However, KAS does not track the ERC-20 and ERC-721 token information changes automatically. For KAS to track these changes and their transmission history, you must register (label) the ERC-20 and ERC-721 tokens directly to KAS.
To register your token, visit KAS Console - My Page - My ERC Tokens menu.
For more details on how to label ERC-20 and ERC-721 tokens, refer to here.
For inquires about this document or KAS, please visit Developer Forum.
Wallet
On the Wallet menu, account pool can be created for storing and managing Klaytn accounts that will be used to call the KAS Wallet API. Both regular and fee delegation account pools are available, and a fee-payer account can be directly created in the latter without calling an API.
Account Pool
For developing a blockchain application, the application will send the transactions to the blockchain. However, for a blockchain application developed using KAS, the user's application will send the transactions to Klaytn with one or more Klaytn accounts. KAS provides account pool so that one KAS account can easily manage several Klaytn accounts. In simpler terms, the account pool comprises specific Klaytn accounts designed for use by groups according to the accounts' uses/roles when a user's application sends several transaction types.
Account Pools
You can create or delete account pool for storing and managing Klaytn accounts under the Account Pools menu. A created account pool is represented with a KRN value and can be used by entering the KRN value to the API call header, x-krn.
KAS also provides a default account pool when a user calls the API even if the user does not have personal account pool. However, if you want to use a specific Klaytn account in your own account pool to call APIs, you have to first create your account pool instead of using the default account pool.
Fee-payer Pools
Under Fee-payer Pools menu, a transaction fee payment account can be created for a Klaytn account that sends transactions to the KAS API. In this menu, you may also create or delete fee delegation account pool.
On the KAS Console by creating a fee-payer account in the designated fee delegation account pool on the details screen, which will pop up when the account pool is selected.
For inquires about this document or KAS, please visit Developer Forum.
Anchor
Under Anchor menu, you can create or delete an operator, the term used for a Klaytn account that anchors the service chain data to the Klaytn main chain. In the Anchor - Operators menu, the user can create or delete the operator account.
For inquires about this document or KAS, please visit Developer Forum.
My Page
KAS Console - My Page also shows several other menus, such as My Info, Change Password, and My ERC Tokens.
My Info
Under My Info menu, you can check your account information and update or delete your account.
Change Password
Change Password menu allows you to change your account password.
My ERC Tokens
ERC-20 and ERC-721 tokens can be labeled under the My ERC Tokens menu. Labeling means registering the token information to KAS so that the Token History API can track the ERC-20 and ERC-721 token information and their transaction history.
This menu also provides various functions, such as token registration and application, registration-applied tokens list searching, and token deletion.
KAS tracks KIP-7 and KIP-17 token information automatically, so these do not have to be labeled.
To request for registration, you must enter your token contract address (SCA) and signature value to prove that you are the contract deployment host and submit options and contract source codes for deploying.
Signature value - A value obtained by executing
caver.klay.accounts.sign({contract_address}, {private_key})Option - Token type (ERC-20, ERC-721), Solidity compiler version, and optimization
Contract code - Source code of token contract written in Solidity (.sol file)
To get the signature described above, the followings are required:
The address of the token contract deployed (
{contract_address})The private key used to send transaction that deployed your token contract (
{private_key})
For details about how to obtain the signature, please visit KAS Console - My Page - My ERC Tokens menu.
KAS checks, using the signature value, if the host deploying the token contract to Klaytn is the same as the applicant registering the token contract to KAS Console, and also confirms that the submitted contract code follows the standard interface. Token registration starts when all conditions are met.
It takes a few minutes to register the token, and the registration result can be checked through the list-stated value on the screen. The reapplication page is also provided if the token type, compiler version, or optimization is incorrectly entered upon registration, or the wrong contract code is submitted.
For inquires about this document or KAS, please visit Developer Forum.
Last updated
