[Account] klay_getAccountKey

Returns the account key of the Externally Owned Account (EOA) of a given address. If the account has AccountKeyLegacy or the account of the given address is a Smart Contract Account, it will return an empty key value.

NOTE: In versions earlier than Kaia v1.7.0, only integer block number, the string "earliest" and "latest" are available

JSONRPC: klay_getAccountKey

Request

application/json

Body

params

undefined[]

required

Array [

Address 20-byte DATA

Address

BlockNumberOrHashOrTag

object

oneOf

IntegerBlockNumber

the block number with type integer

number

HexadecimalBlockNumber

the block number with type hexadecimal

string

BlockTag

the block tag [latest, pending, earliest]

string

BlockHash

the block hash

string

]

Responses

200

Returns the account key or an empty key value.

application/json

Schema

Schema

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

code	message	description
-32700	Parse error	invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.
-32602	Invalid params	Invalid method parameter(s).

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result

object

oneOf

AccountKeyLegacy

AccountKeyLegacy is used for the account having an address derived from the corresponding key pair

key objectrequired

keyType integerrequired

The type of AccountKeyLegacy. This must be 0x01.

AccountKeyNil

string

AccountKeyPublic

AccountKeyPublic is used for accounts having one public key.

key

object

required

Key should be a compressed public key on S256 curve.

x 32-byte DATArequired

The x coordinate of the public key.

y 32-byte DATArequired

The y coordinate of the public key.

keyType integerrequired

The type of AccountKeyPublic. This must be 0x02.

AccountKeyFail

If an account has the key AccountKeyFail, the transaction validation process always fails. It can be used for smart contract accounts so that a transaction sent from the smart contract account always fails.

key objectrequired

keyType integerrequired

The type of AccountKeyFail. This must be 0x03.

AccountKeyWeightedMultiSig

AccountKeyWeightedMultiSig is an account key type containing a threshold and WeightedPublicKeys which contains a list consisting of a public key and its weight.

keyType integerrequired

The type of AccountKeyWeightedMultiSig. This must be 0x04.

Threshold integerrequired

Validation threshold. To be a valid transaction, the weight sum of signatures should be larger than or equal to the threshold.

WeightedPublicKeys

object[]

required

A list of weighted public keys. A weighted public key contains a compressed public key and its weight.

Array [

PublicKey

object

required

x 32-byte DATArequired

The x coordinate of the public key.

y 32-byte DATArequired

The y coordinate of the public key.

Weight integerrequired

]

AccountKeyRoleBased

AccountKeyRoleBased represents a role-based key

key

object[]

required

A list of keys. A key can be any of AccountKeyNil, AccountKeyLegacy, AccountKeyPublic, AccountKeyFail, and AccountKeyWeightedMultiSig

Array [

anyOf

AccountKeyNil

string

AccountKeyLegacy

AccountKeyLegacy is used for the account having an address derived from the corresponding key pair

key objectrequired

keyType integerrequired

The type of AccountKeyLegacy. This must be 0x01.

AccountKeyPublic

AccountKeyPublic is used for accounts having one public key.

key

object

required

Key should be a compressed public key on S256 curve.

x 32-byte DATArequired

The x coordinate of the public key.

y 32-byte DATArequired

The y coordinate of the public key.

keyType integerrequired

The type of AccountKeyPublic. This must be 0x02.

AccountKeyFail

If an account has the key AccountKeyFail, the transaction validation process always fails. It can be used for smart contract accounts so that a transaction sent from the smart contract account always fails.

key objectrequired

keyType integerrequired

The type of AccountKeyFail. This must be 0x03.

AccountKeyWeightedMultiSig

AccountKeyWeightedMultiSig is an account key type containing a threshold and WeightedPublicKeys which contains a list consisting of a public key and its weight.

keyType integerrequired

The type of AccountKeyWeightedMultiSig. This must be 0x04.

Threshold integerrequired

Validation threshold. To be a valid transaction, the weight sum of signatures should be larger than or equal to the threshold.

WeightedPublicKeys

object[]

required

A list of weighted public keys. A weighted public key contains a compressed public key and its weight.

Array [

PublicKey

object

required

x 32-byte DATArequired

The x coordinate of the public key.

y 32-byte DATArequired

The y coordinate of the public key.

Weight integerrequired

]

]

keyType integerrequired

The type of AccountKeyRoleBased. This must be 0x05.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": {
    "key": {},
    "keyType": 0
  }
}

Loading...