-
Notifications
You must be signed in to change notification settings - Fork 3
KeyChain Protocol
KeyChain is a standalone app for signing transactions and generating key pairs. It stores private keys in an isolated environment with three-layer security protection making it extremely difficult for loggers, debuggers or spyware to intercept them. KeyChain supports transactions from/to various blockchains, including Ethereum and Ethereum classic, Litecoin, Bitcoin, Bitcoin Cash, and Bitshares.
You can integrate KeyChain into your project as a service through pipe or websocket. For quick step-by-step guides see Pipe integration guide and WebSocket integration guide which can be found in the corresponding API.
Here you can find installation guides for macOS, Windows, and Linux.
Test the KeyChain commands on the demo page here.
You can find error descriptions in the Troubleshooting section.
{
"command": "create",
"params":
{
"keyname": "my key",
"encrypted": true,
"curve": "secp256k1",
"cipher": "aes256"
}
}create
| Parameter | Type | Description | Value example |
|---|---|---|---|
| encrypted | string |
Requests encryption of the key | true |
| curve | string |
Keychain uses elliptic curve algorithm | secp256k1 |
| keyname | string |
Create a name for your key. This will be a mnemonic label of the key - not the actual key | my key |
| cipher | string |
Specifies encryption type (we use aes) and the size of the key in bits |
aes256 |
When you pass a short key name in the create command, you get an exended name which consists of the prefix and first 8 bytes of the hash. After that, you will need to pass it as a value for the keyname parameter.
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | string |
extended key name | my key@f9a1554e3f5e30c8 |
{"result":"my key@f9a1554e3f5e30c8"}NB: You can sign transactions in hex or hash format.
For example, for Ethereum transaction, you do not need to pass chain-id as a parameter because it is incorporated in the hex.
NB: Please remember that you need to insert your own key name in the parameters when copying the requests!
{
"command": "sign_hex",
"params":
{
"chainid": "de5f4d8974715e20f47c8bb609547c9e66b0b9e31d521199b3d8d6af6da74cb1",
"transaction": "871689d060721b5cec5a010080841e00000000000011130065cd1d0000000000000000",
"blockchain_type": "array",
"keyname": "my key@f9a1554e3f5e30c8",
"unlock_time": 45
}
}sign_hex
| Parameter Type | Description |
|---|---|
chainid string
|
Optional parameter for Array and Bitshares-like blockchains. Chainid is the hash of a genesis file used to identify the chain. |
transaction string
|
Hex representation of the transaction. |
blockchain_type string
|
Inserts the name of blockchain you’re using. Possible options: Array, Bitcoin, Ethereum, Bitshares. |
keyname string
|
Inserts the mnemonic label of your key |
unlock_time integer
|
This parameter is experimental and optional! If this parameter is defined and if it is greater than zero, it unlocks the key for a set number of seconds. While the key is unlocked, the transactions will be signed without the user's approval. |
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | hex string |
65-byte singature in hex-string format | 6cc47faa3778d15efeb470cd4154fdceb80633beaed15f0816d93951ffd7629a5fae3fe83c030f5f8a0cea82c1907f85418b93e820ea3b043c116053afae20a300 |
{"result":"6cc47faa3778d15efeb470cd4154fdceb80633beaed15f0816d93951ffd7629a5fae3fe83c030f5f8a0cea82c1907f85418b93e820ea3b043c116053afae20a300"}This request is suited best for advanced users who are eager to work on a low level. You should have knowledge of how to calculate hash of transaction, given the type of blockchain, and know the type of signature and its packaging.
NB: Please remember that you need to insert your own key name in the parameters when copying the requests!
{
"command": "sign_hash",
"params":
{
"sign_type": "VRS_canonical",
"hash": "fe5e4a8974715e20f47c8bb609547c9e66b0b9e31d521199b3d8d6af6da74cb1",
"keyname": "my key@f9a1554e3f5e30c8"
}
}sign_hash
| Parameter | Type | Description | Value example |
|---|---|---|---|
| sign-type | string |
Customizes the way secp256 library is used by choosing one of its arguments through sign-type parameter. It has two possible value options: RSV_noncanonical and VRS_canonical. Default value is RSV_noncanonical. Prefix RSV/VRS means signature struct: [R, S, v] or [v, R, S]. | VRS_canonical |
| hash | string |
Hash calculated from the transaction. It can be the result of the first calculation or the second - depending on the type of the blockchain. For example, Bitcoin uses two calculations: to sign a bitcoin transaction you need to transmit the final (second) hash. Ethereum and Array make only one calculation to get the hash. |
fe5e4a8974715e20f47c8bb609547c9e66b0b9e31d521199b3d8d6af6da74cb1keyname |
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | hex string |
65-byte signature in hex format | 62826b9c7b6bbfcd89456c1e8068e141d6a46b2c1c0166ed25ba8ad6ede320f4454ff116d13f4e679e8224fcca49f49d50c279ed88513a1db7185946e26811ab01 |
{"result":"62826b9c7b6bbfcd89456c1e8068e141d6a46b2c1c0166ed25ba8ad6ede320f4454ff116d13f4e679e8224fcca49f49d50c279ed88513a1db7185946e26811ab01"}All full key names of the private keys that are kept on your computer.
{
"command": "list"
}list
No
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | JSON array of strings |
list of key names | "my key@47f926e22f376478","my key@e67871253c263de0","my key@e755d5b98b6ed747","my key@f9a1554e3f5e30c8" |
{"result":"my key@47f926e22f376478","my key@e67871253c263de0","my key@e755d5b98b6ed747","my key@f9a1554e3f5e30c8"}NB: Please remember that you need to insert your own key name in the parameters when copying the requests!
{
"command": "public_key",
"params":
{
"keyname": "my key@f9a1554e3f5e30c8"
}
}public_key
| Parameter | Type | Description | Value example |
|---|---|---|---|
| keyname | string |
Inserts the name of the key from which you want to calculate | my key@f9a1554e3f5e30c8 |
64-byte public key. The length of the public key depends on the type of the blockchain. For example, in Ethereum, the length of a public key is 64 bytes.
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | hex string |
64-byte public key | a7aea4bd112706655cb7014282d2a54658924e69c68f5a54f2cd5f35c6fcba9b610d6ae8549f960ae96e23ffc017f305c1d8664978c8ba8a1cc656fd9d068ef5 |
{"result":"a7aea4bd112706655cb7014282d2a54658924e69c68f5a54f2cd5f35c6fcba9b610d6ae8549f960ae96e23ffc017f305c1d8664978c8ba8a1cc656fd9d068ef5"}This command protects you from any hostile intervention into the KeyChain while you have left your computer without supervision.
{
"command": "lock"
}lock
No
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | bool |
bool result | true |
{"result":"true"}Unlock your key when you are ready to use it.
NB: This parameter is experimental! Allowing the user to sign transactions without extra authorization is not secure and can be harmful. If unlock_time is greater than zero, you will see an insecure action warning. We do not recommend to use it. Although it might be needed if you want to speed up signing transactions.
NB: Sign_hex and sign_hash commands assume implicit unlocking of your keys.
NB: Please remember that you need to insert your own key name in the parameters when copying the requests!
{
"command": "unlock"
"params":
{
"keyname": "my key@be5f6e75878b84ba",
"unlock_time": 45
}
}unlock
| Parameter | Type | Description | Value example |
|---|---|---|---|
| keyname | string |
Inserts the name of the key you want to unlock | my key@f9a1554e3f5e30c8 |
| unlock_time | integer |
When this parameter is specified, it unlocks the key for a set number of seconds. While the key is unlocked, the pass entry window will not appear and the transactions will be signed without the user's approval. | >0 |
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | bool |
bool result | true |
{"result":"true"}You can request the details of the current KeyChain version you are using.
{"command":"about"}about
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | json object |
version details as a json object with the following parameters | (see below) |
| version | string |
number of the current version | 0.9.114 |
| git_revision_sha | string |
hash of the commit | 59861769dca634d08d5442cb0074d40d8f544e66 |
| git_revision_age | string |
age of the commit | 9 minutes ago |
| compile_date | string |
time of compilation | compiled on Dec 12 2018 at 08:11:44 |
| boost_version | string |
required version of the boost library | 1.66 |
| openssl_version | string |
required openssl version | OpenSSL 1.1.1 11 Sep 2018 |
| build | string |
required operating system | linux 64-bit |
{"result":{"version":"0.9.114","git_revision_sha":"59861769dca634d08d5442cb0074d40d8f544e66","git_revision_age":"9 minutes ago","compile_date":"compiled on Dec 12 2018 at 08:11:44","boost_version":"1.66","openssl_version":"OpenSSL 1.1.1 11 Sep 2018","build":"linux 64-bit"}}You can request the number of the current version you are using.
{"command":"version"}version
No
| Field name | Type | Description | Value example |
|---|---|---|---|
| result | string |
current version number which has the form of "[major].[minor].[build number]" | 0.9.114 |
{"result":"0.9.114"}