personal_unlockAccount
Decrypts the key with the given address from the key store.
Both passphrase and unlock duration are optional when using the JavaScript console. If the passphrase is not supplied as an argument, the console will prompt for the passphrase interactively.
The unencrypted key will be held in memory until the unlock duration expires. If the unlock duration defaults to 300 seconds. An explicit duration of zero seconds unlocks the key until the Kaia local node exits.
The account can be used with klay_sign and klay_sendTransaction while it is unlocked.
JSONRPC: personal_unlockAccount
Request
- application/json
Body
Array [
]
params
undefined[]
required
The account address to unlock.
the passphrase used for the encryption.
Default value: 300
(optional) the unlock duration (default to 300 seconds).
Responses
- 200
Return true if unlocked, false otherwise
- application/json
- Schema
- Example (from schema)
Schema
error
object
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). |
A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.
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.).
true if unlocked, false otherwise
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": -32700,
"message": "Parse error",
"data": "string"
},
"result": true
}