caver.wallet.keyring is a package that provides functionality related to Keyring which includes address and private key(s).
Class
Keyring is a structure that contains the address of the account and the private key(s). This is a class in caver-js that allows users to sign on using their own Klaytn's account.
Keyring can be classified into three types depending on the type of key being stored: SingleKeyring to store one address and one private key, MultipleKeyring to store one address and multiple private keys, and RoleBasedKeyring to store one address and one or more private keys for each role.
SingleKeyring is a class that stores the address of the account and a private key. To create a SingleKeyring instance with a private key string, please refer to caver.wallet.keyring.create.
SingleKeyring uses a private key with which no roles assigned.
MultipleKeyring is a class that stores the address of the account and the multiple private keys. To create a MultipleKeyring instance with private key strings, please refer to caver.wallet.keyring.create.
MultipleKeyring uses private keys with which no roles assigned.
properties
Name
Type
Description
address
string
The address of the account.
keys
Array
An array of PrivateKey instances containing one private key inside.
RoleBasedKeyring is a class that stores the address of the account and the private keys to be used for each role in the form of an array.
RoleBasedKeyring defines keys which is implemented as a two-dimensional array (empty keys looks like [ [], [], [] ]) that can include multiple keys for each role. The first array element defines the private key(s) for roleTransactionKey, the second defines private key(s) for roleAccountUpdateKey, and the third defines the private key(s) for roleFeePayerKey.
properties
Name
Type
Description
address
string
The address of the account.
keys
Array
A two-dimensional array that defines the keys used for each role. Each role includes PrivateKey instance(s). The first element in this is roleTransactionKey. The second element is roleAccountUpdateKey. The last element is roleFeePayerKey.
Below is a getter defined in keyring to intuitively use the key defined for each role. The key used for each role can be accessed more easily through the getter below.
Name
Type
Description
roleTransactionKey
Array
The roleTransactionKey used to sign transactions (except for transactions for the account update). keyring.roleTransactionkey will return the first element of keys property.
roleAccountUpdateKey
Array
The roleAccountUpdateKey used to sign account update transactions. keyring.roleAccountUpdateKey will return the second element of keys property.
roleFeePayerKey
Array
The roleFeePayerKey used to sign transactions as a fee payer. keyring.roleFeePayerKey will return the thrid element of keys property.
PrivateKey is a class that contains a private key string. The private key to be used for each role in Keyring is defined as this PrivateKey instance.
properties
Name
Type
Description
privateKey
string
The private key string.
SignatureData
SignatureData is a class that contains signature data inside. The signature which is the result of sign or signMessage will be returned as a signatureData. You can see how signatureData contains signature(s) inside like below.
If key is a private key string, a SingleKeyring instance that uses a single private key is created. If key is an array containing private key strings, a MultipleKeyring instance that use multiple private keys is created. If key is a 2D array of which each element contains the private key(s) to be used for each role, a RoleBasedKeyring instance is created.
Parameters
Name
Type
Description
address
string
An address of keyring.
key
string | Array
The private key string, an array of private keys, or a 2D array of which each element contains key(s) to be used for each role.
Returns the public key string(s). If keyring is an instance of SingleKeyring, getPublicKey returns a public key string. If keyring is an instance of MultipleKeyring, getPublicKey returns an array of public key strings. If keyring is an instance of RoleBasedKeyring, getPublicKey returns a two-dimensional array in which the public key(s) used for each role is defined as an array.
Parameters
Name
Type
Description
compressed
boolean
(optional) Whether in compressed format or not (default: false).
Return Value
Type
Description
string | Array
The public key of the keyring.
Example
// Get public key with singleKeyring>keyring.getPublicKey()'0x49b2a...'// Get public key with multipleKeyring>keyring.getPublicKey()[ '0x65b51...','0x8d85c...' ]// Get public key with roleBasedKeyring>keyring.getPublicKey()[ [ '0x2d939...','0x6beb4...','0xd8f2f...' ], [ '0xf09cd...','0x96a63...','0x02000...' ], [ '0xc2d33...','0x3088f...','0xab193...' ]]
// When keyring is an instance of SingleKeyring>keyring.copy()SingleKeyring { _address:'0x30fcfa9679c7141a234c1324c7e0a8b715bdfc90', _key: PrivateKey { _privateKey:'0x{private key}' }}// When keyring is an instance of MultipleKeyring>keyring.copy()MultipleKeyring { _address:'0x30fcfa9679c7141a234c1324c7e0a8b715bdfc90', _keys: [ PrivateKey { _privateKey:'0x{private key1}' }, PrivateKey { _privateKey:'0x{private key2}' } ]}// When keyring is an instance of RoleBasedKeyring>keyring.copy()RoleBasedKeyring { _address:'0x30fcfa9679c7141a234c1324c7e0a8b715bdfc90', _keys: [ [ PrivateKey { _privateKey:'0x{private key1}' }, PrivateKey { _privateKey:'0x{private key2}' } ], [ PrivateKey { _privateKey:'0x{private key3}' }, PrivateKey { _privateKey:'0x{private key4}' } ], [ PrivateKey { _privateKey:'0x{private key5}' }, PrivateKey { _privateKey:'0x{private key6}' } ] ]}
keyring.sign
keyring.sign(transactionHash, chainId, role [, index])
Signs with transactionHash with the private key(s) and returns signature(s). If the user has not defined an index parameter, keyring.sign signs transaction using all the private keys used by the role. If index is defined, the keyring.sign signs transaction using only one private key at the index. The role used in caver-js can be checked through caver.wallet.keyring.role.
A number indicating the role of the key. You can use caver.wallet.keyring.role.
index
number
(optional) The index of the private key you want to use. The index must be less than the length of the array of the private keys defined for each role. If an index is not defined, this method will use all the private keys.
// Using roleBasedKeyring which has two private key in roleTransactionKey> keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550', '0x2810', caver.wallet.keyring.role.roleTransactionKey)
[ SignatureData { _v:'0x5044', _r:'0x7a8b6...', _s:'0x17139...' }, SignatureData { _v:'0x5043', _r:'0x7f978...', _s:'0x1a532...' }]// Using roleBasedKeyring which has two private key in roleTransactionKey with index> keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550', '0x2810', caver.wallet.keyring.role.roleTransactionKey, 1)
[ SignatureData { _v:'0x5043', _r:'0x7f978...', _s:'0x1a532...' }]// Using roleBasedKeyring which has two private key in roleAccountUpdateKey> keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550', '0x2810', caver.wallet.keyring.role.roleAccountUpdateKey)
[ SignatureData { _v:'0x5044', _r:'0xdbce8...', _s:'0x039a6...' }, SignatureData { _v:'0x5044', _r:'0xf69b7...', _s:'0x71dc9...' }]// Using roleBasedKeyring which has two private key in roleAccountUpdateKey with index> keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550', '0x2810', caver.wallet.keyring.role.roleAccountUpdateKey, 1)
[ SignatureData { _v:'0x5044', _r:'0xf69b7...', _s:'0x71dc9...' }]// Using roleBasedKeyring which has two private key in roleFeePayerKey> keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550', '0x2810', caver.wallet.keyring.role.roleFeePayerKey)
[ SignatureData { _v:'0x5043', _r:'0xe48bf...', _s:'0x1cf36...' }, SignatureData { _v:'0x5043', _r:'0x82976...', _s:'0x3c5e0...' }]// Using roleBasedKeyring which has two private key in roleFeePayerKey with index> keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550', '0x2810', caver.wallet.keyring.role.roleFeePayerKey, 1)
[ SignatureData { _v:'0x5043', _r:'0x82976...', _s:'0x3c5e0...' }]
keyring.ecsign
keyring.ecsign(hash, role [, index])
Signs with hashed data using the private key and returns a signature where V is 0 or 1 (parity of the y-value of a the secp256k1 curve).
This function is only used for certain transaction types. Therefore, it is recommended to use caver.wallet.sign or transaction.sign when signing a transaction.
Parameters
Name
Type
Description
hash
string
The hash string to sign.
role
number
A number indicating the role of the key. You can use caver.wallet.keyring.role.
index
number
(optional) The index of the private key you want to use. The index must be less than the length of the array of the private keys defined for each role. If an index is not defined, this method will use all the private keys.
Signs message with Klaytn-specific prefix. This calculates a Klaytn-specific signature with:
sign(keccak256("\x19Klaytn Signed Message:\n" + len(message) + message)))
If the user has not defined the index parameter, keyring.signMessage signs message with all the private keys used by the role. If the index parameter is given, keyring.signMessage signs message using only one private key at the given index. The role used in caver-js can be found through caver.wallet.keyring.role.
Parameters
Name
Type
Description
message
string
The message to sign.
role
number
A number indicating the role of the key. You can use caver.wallet.keyring.role.
index
number
(optional) The index of the private key you want to use. The index must be less than the length of the array of the private keys defined for each role. If an index is not defined, this method will use all the private keys.
>keyring.getKlaytnWalletKey()'0x{private key}0x{type}0x{address in hex}'
keyring.toAccount
keyring.toAccount([options])
Returns the Account instance for updating the AccountKey of the Klaytn accounts. The Account instance has an AccountKey instance that can contain public key(s) inside, which will be sent to Klaytn Network and used for validating transactions. For more details about Account, see Account Update.
Note that if you update the AccountKey of the Account stored in the Klaytn, the old private key(s) cannot be used anymore. See Getting started on how to use the returned Account instance to update information in your Klaytn account on Klaytn.
Depending on the type of the private key(s) in the keyring, the returned Account instances can be classified as follows.
When the keyring contains a private key string: Return an Account instance that includes the address in the keyring and an instance of AccountKeyPublic
When the keyring contains private key strings: Return an Account instance that includes the address in the keyring and an instance of AccountKeyWeigthedMultiSig
When the keyring contains the different private key strings by role: Return an Account instance that includes the address in the keyring and an instance of AccountKeyRoleBased
(optional) WeightedMultiSigOptions instance containing information that should be defined when updating your existing account to the one with a number of private keys. If keyring uses different private keys for each role, a WeightedMultiSigOptions instance must be defined for each role in an array. If keyring uses more than one private key and options parameter is not defined, the default WeightedMultiSigOptions with the threshold of 1 and the weight of 1 for each key will be used.
An Account instance to be used when a user updates AccountKey for their account in the Klaytn. Note that if you want to replace the existing keyring (or the existing private key(s)) with a new keyring (or a new private key(s)) for your account, you must update your AccountKey by sending an Account Update transaction to Klaytn beforehand.
