caver.rpc.klay
caver.rpc.klay
는 klay
네임 스페이스를 가진 JSON-RPC API를 호출합니다.
caver.rpc.klay.accountCreated
입력된 주소의 계정이 Klaytn 블록체인 플랫폼(Klaytn)에 존재하는 경우 true
를 반환합니다. It returns false
otherwise.
Parameters
Name | Type | Description |
---|---|---|
address | string | 네트워크에 존재하는지 확인하고 싶은 계정 주소입니다. |
blockNumber | number \ | string |
callback | function | (선택 사항) 선택적 콜백(callback)은 오류 객체를 첫 번째 매개 변수로, 결과를 두 번째 매개 변수로 반환합니다. |
Return Value
Promise
는 boolean
을 반환합니다.
Type | Description |
---|---|
boolean | 입력으로 받은 주소가 Klaytn에 존재하는지 여부를 반환합니다. |
Example
caver.rpc.klay.getAccount
입력으로 받은 Klaytn 계정 주소의 계정 정보를 반환합니다. Klaytn 계정 타입에 관한 자세한 내용은 Klaytn Account Types를 확인하십시오.
참고 caver.rpc.klay.getAccount
는 계정이 Klaytn에 있는 경우에만 계정을 반환하므로 주소와 일치하는 계정이 Klaytn 상에 존재하지 않으면 null
이 반환됩니다.
Parameters
Name | Type | Description |
---|---|---|
address | string | 계정 정보를 알고 싶은 계정 주소입니다. |
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
Type | Description |
---|---|
object | 계정 정보를 담고 있는 객체입니다. Each account type has different attributes. |
Example
caver.rpc.klay.getAccountKey
주어진 주소의 AccountKey를 반환합니다. 입력으로 받은 주소 계정이 AccountKeyLegacy를 AccountKey로 갖고 있거나 계정이 스마트 컨트랙트 계정이면 빈 키 값을 반환합니다. 더 자세한 내용은 Account Key를 확인하십시오.
참고 caver.rpc.klay.getAccountKey
는 각 AccountKey 타입에 따라 다른 객체를 반환합니다. 주어진 주소를 가진 계정이 Klaytn에 존재하지 않는다면 null
을 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
address | string | Klaytn 계정 주소입니다. 이 메서드를 실행하면 이 계정 주소의 AccountKey 정보가 담긴 객체를 얻습니다. |
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
Type | Description |
---|---|
object | AccountKey 정보를 담고 있는 객체입니다. AccountKey 유형에 따라 다른 속성을 반환합니다. |
Example
caver.rpc.klay.encodeAccountKey
AccountKey 정보를 담고 있는 객체를 RLP(Recursive Length Prefix)로 인코딩합니다. account.getRLPEncodingAccountKey를 사용해도 RLP 인코딩된 AccountKey를 얻습니다.
Parameters
Name | Type | Description |
---|---|---|
accountKey | object | An object defines |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns string
Type | Description |
---|---|
string | RLP로 인코딩된 AccountKey. |
Example
caver.rpc.klay.decodeAccountKey
RLP 인코딩된 AccountKey를 디코딩 합니다. caver.account.accountKey.decode를 사용해도 RLP 인코딩된 AccountKey를 디코딩합니다.
Parameters
Name | Type | Description |
---|---|---|
encodedKey | string | A RLP-encoded AccountKey. |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
Type | Description |
---|---|
object | 내부에 |
Example
caver.rpc.klay.getBalance
입력으로 받은 Klaytn 계정 주소의 잔액을 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
address | string | 잔액을 확인할 계정 주소입니다. |
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns string
Type | Description |
---|---|
string | 주어진 주소의 peb 단위 현재 잔액입니다. |
Example
caver.rpc.klay.getCode
Returns code at a given address.
Parameters
Name | Type | Description |
---|---|---|
address | string | 코드를 알고 싶은 주소입니다. |
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns string
Type | Description |
---|---|
string | The code from the given address. |
Example
caver.rpc.klay.getTransactionCount
어떤 주소의 계정에서 발신된 트랜잭션의 총 개수를 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
address | string | 발신한 트랜잭션 개수를 확인할 주소입니다. |
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns string
Type | Description |
---|---|
string | 주어진 주소에서 발신된 트랜잭션의 개수입니다. 이 값은 16진수입니다. |
Example
caver.rpc.klay.isContractAccount
Returns true
if an input account has a non-empty codeHash at the time of a specific block number. It returns false
if the account is an EOA or a smart contract account which doesn't have codeHash. 더 자세한 내용은 Smart Contract Account를 확인하십시오.
Parameters
Name | Type | Description |
---|---|---|
address | string | isContractAccount로 확인할 주소입니다. |
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns boolean
Type | Description |
---|---|
boolean | true면 파라미터가 스마트 컨트랙트 계정의 주소입니다. |
Example
caver.rpc.klay.sign
Klaytn에서 사용하는 서명된 데이터를 생성합니다. Refer to Klaytn Platform API - klay_sign to know how the signature is generated.
NOTE: This API provides the function to sign a message using an imported account in your Klaytn node. The imported account in your node must be unlocked to sign the message. To sign a transaction with imported account in your Klaytn node, use caver.rpc.klay.signTransaction.
Parameters
Name | Type | Description |
---|---|---|
address | String | 메시지에 서명할 불러온 계정 주소입니다. |
message | String | 서명하려는 메시지입니다. |
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns string
Type | Description |
---|---|
string | 노드에 불러온 계정이 만든 서명입니다. |
Example
caver.rpc.klay.getAccounts
Klaytn 노드가 가진 주소 목록을 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns Array
Type | Description |
---|---|
Array | Klaytn 노드가 가진 주소 목록입니다. |
Example
caver.rpc.klay.getBlockNumber
Returns the number of the most recent block.
Parameters
Name | Type | Description |
---|---|---|
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns string
Type | Description |
---|---|
string | 가장 최근의 블록 번호입니다. 이 값은 16진수 값입니다. |
Example
caver.rpc.klay.getHeader
Returns a block header by block hash or block number. If the user passes the block hash as a parameter, caver.rpc.klay.getHeaderByHash is called, and if the block number is called as a parameter, caver.rpc.klay.getHeaderByNumber is called.
Parameters
Name | Type | Description |
---|---|---|
blockNumberOrHash | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
Type | Description |
---|---|
object | A block header object. For a detailed description of the return value, please refer to caver.rpc.klay.getHeaderByHash. |
Example
caver.rpc.klay.getHeaderByNumber
Returns a block header by block number.
Parameters
Name | Type | Description |
---|---|---|
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
Type | Description |
---|---|
object | A block header object. For a detailed description of the return value, please refer to caver.rpc.klay.getHeaderByHash. |
Example
caver.rpc.klay.getHeaderByHash
blockHash
를 사용해 가장 최근의 블록 번호를 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
blockHash | string | 블록 해시입니다. |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
- An object includes the block header:
Name | Type | Description |
---|---|---|
baseFeePerGas | string | The base fee per gas. This value is returned only when EthTxTypeCompatibleBlock is activated for that block number. |
blockScore | string | 블록체인 네트워크의 채굴 난이도입니다. |
extraData | string | The "extra data" field of this block. |
gasUsed | string | 이 블록에 있는 모든 트랜잭션에서 사용된 가스양의 총합입니다. |
governanceData | string | RLP encoded governance configuration |
hash | string | Hash of the block. |
logsBloom | string | The bloom filter for the logs of the block. |
number | string | The block number. |
parentHash | string | Hash of the parent block. |
receiptsRoot | string | The root of the receipts trie of the block. |
reward | string | The address of the beneficiary to whom the block rewards were given. |
stateRoot | string | The root of the final state trie of the block. |
timestamp | string | 블록이 생성되었을 때의 Unix 타임스탬프입니다. |
timestampFoS | string | The fraction of a second of the timestamp for when the block was collated. |
transactionsRoot | string | The root of the transaction trie of the block. |
Example
caver.rpc.klay.getBlock
Returns information about a block by block hash or block number. If the user passes the block hash as a parameter, caver.rpc.klay.getBlockByHash is called, and if the block number is called as a parameter, caver.rpc.klay.getBlockByNumber is called.
Parameters
Name | Type | Description |
---|---|---|
blockNumberOrHash | number \ | string |
returnTransactionObjects | boolean | (선택 사항, 기본값은 |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
Type | Description |
---|---|
object | 블록 객체입니다. For a detailed description of the return value, please refer to caver.rpc.klay.getBlockByHash. |
Example
caver.rpc.klay.getBlockByNumber
Returns information about a block by block number.
Parameters
Name | Type | Description |
---|---|---|
blockNumber | number \ | string |
returnTransactionObjects | boolean | (optional, default |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
Type | Description |
---|---|
object | A block object. For detailed description of return value, please refer to caver.rpc.klay.getBlockByHash. |
Example
caver.rpc.klay.getBlockByHash
Returns the block number of the most recent block by using blockHash
.
Parameters
Name | Type | Description |
---|---|---|
blockHash | string | The block hash. |
returnTransactionObjects | boolean | (optional, default |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
는 object
를 반환 - 블록을 포함하는 객체입니다.
Name | Type | Description |
---|---|---|
baseFeePerGas | string | The base fee per gas. This value is returned only when EthTxTypeCompatibleBlock is activated for that block number. |
blockScore | string | The difficulty of mining in the blockchain network. The use of |
extraData | string | The "extra data" field of this block. |
gasUsed | string | The gas in total that was used by all transactions in this block. |
governanceData | string | RLP encoded governance configuration |
hash | string | Hash of the block. |
logsBloom | string | The bloom filter for the logs of the block. |
number | string | The block number. |
parentHash | string | Hash of the parent block. |
receiptsRoot | string | The root of the receipts trie of the block. |
reward | string | The address of the beneficiary to whom the block rewards were given. |
size | string | Integer the size of this block in bytes. |
stateRoot | string | The root of the final state trie of the block. |
timestamp | string | The unix timestamp for when the block was collated. |
timestampFoS | string | The fraction of a second of the timestamp for when the block was collated. |
totalBlockScore | string | Integer of the total blockScore of the chain until this block. |
transactions | Array | 트랜잭션 객체의 배열이거나 또는 |
transactionsRoot | string | The root of the transaction trie of the block. |
voteData | string | 제안자의 RLP 인코딩된 거버넌스 투표입니다. |
Example
caver.rpc.klay.getBlockReceipts
블록 해시로 조회한 블록에 포함된 영수증을 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
blockHash | string | The block hash. |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns Array
Type | Description |
---|---|
Array | 조회한 블록에 포함된 트랜잭션 영수증들입니다. 조회하고자 하는 블록이 트랜잭션을 담고 있지 않으면 빈 배열 |
Example
caver.rpc.klay.getBlockTransactionCountByNumber
Returns the number of transactions in a block matching the given block number.
Parameters
Name | Type | Description |
---|---|---|
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns string
Type | Description |
---|---|
string | 주어진 블록에 기록된 트랜잭션의 개수입니다. 이 값은 16진수 값입니다. |
Example
caver.rpc.klay.getBlockTransactionCountByHash
블록 해시로 조회한 블록에 담긴 트랜잭션의 개수를 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
blockHash | string | The block hash. |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns string
Type | Description |
---|---|
string | The number of transactions in the given block in hex. |
Example
caver.rpc.klay.getBlockWithConsensusInfoByNumber
블록 번호로 조회한 블록을 합의에 대한 정보와 함께 반환합니다.
Parameters
Name | Type | Description |
---|---|---|
blockNumber | number \ | string |
callback | function | (optional) Optional callback, returns an error object as the first parameter and the result as the second. |
Return Value
Promise
returns object
Type | Description |
---|---|
string | 합의 정보를 포함해 블록 정보를 담고 있는 객체입니다. For detailed description of return value, please refer to caver.rpc.klay.getBlockWithConsensusInfoByHash. |
Example