caver.account
Last updated
Last updated
caver.account is a package that provides functionality related to Account that is used when updating an account.
Account is a class that contains information needed to update the of the account in the Klaytn blockchain platform (Klaytn). This is the default class for the caver.account package. To create an Account instance with public key string(s), please refer to .
properties
address
string
The address of account to be updated.
accountKey
object
AccountKeyLegacy is used to update the AccountKey of an account in the Klaytn with . To create an Account instance with AccountKeyLegacy, please refer to .
AccountKeyPublic is used to update the AccountKey of an account in the Klaytn with . By updating AccountKey to AccountKeyPublic, you can change your existing AccountKey into the new public key, which will be used to validate a transaction in Klaytn. This change is necessary when you decouple your private key from the address of your account. See and for details.
To create an Account instance with AccountKeyPublic, please refer to or .
properties
publicKey
string
The public key string.
properties
threshold
number
The validation threshold.
weightedPublicKeys
Array
properties
accountKeyArray
Array
properties
weight
number
publicKey
string
The public key string.
WeightedMultiSigOptions contains a threshold and weights. WeightedMultiSigOptions is a class for defining the options of AccountKeyWeightedMultiSig.
properties
threshold
number
The validation threshold.
weights
Array
An array of weights of keys.
Generates an Account instance with an address and an accountKey.
Parameters
address
string
The address of account to be updated.
accountKey
string | Array
A public key string, an array of public keys, or a 2D array of which each element contains an array of key(s) to be used for each role.
options
(optional) Options for AccountKeyWeigthedMultiSig.
Return Value
The account instance is returned.
Example
Creates an Account instance from RLP-encoded AccountKey.
Parameters
address
string
The address of an account to be updated.
rlpEncodedKey
string
The RLP-encoded string of AccountKey.
Return Value
The account instance is returned.
Example
Creates an Account instance which has AccountKeyLegacy as an accountKey.
Parameters
address
string
The address of an account to be updated.
Return Value
The account instance is returned.
Example
Creates an Account instance which has AccountKeyPublic as an accountKey.
Parameters
address
string
The address of an account to be updated.
publicKey
string
The public key string.
Return Value
The account instance is returned.
Example
Creates an Account instance which has AccountKeyFail as an accountKey.
Parameters
address
string
The address of an account to be updated.
Return Value
The account instance is returned.
Example
Creates an Account instance which has AccountKeyWeightedMultiSig as an accountKey.
Parameters
address
string
The address of an account to be updated.
publicKeyArray
Array
The array that includes multiple public key strings.
options
Return Value
The account instance is returned.
Example
Creates an Account instance which has AccountKeyRoleBased as an accountKey.
Parameters
address
string
The address of an account to be updated.
roledBasedPublicKeyArray
Array
A two-dimensional array containing arrays of public key strings for each role.
options
Array
Return Value
The account instance is returned.
Example
Parameters
rlpEncodedAccountKey
string
An RLP-encoded string of AccountKey.
Return Value
The AccountKey instance is returned.
Example
Return RLP-encoded string of AccountKey.
Return Value
string
A RLP-encoded string of AccountKey .
Example
The new accountKey to be used in account. This can be an instance of , , , or . When the transaction is executed, the accountKey of the account stored in the Klaytn is changed to this.
AccountKeyFail is used to update AccountKey of an account in the Klaytn with . To create an Account instance with AccountKeyFail, please refer to .
AccountKeyWeightedMultiSig is used to update AccountKey of an account in the Klaytn with . By updating your AccountKey to AccountKeyWeightedMultiSig, you can change your existing AccountKey into the new public key, which will be used to validate a transaction in Klaytn. This change is necessary when you decouple your private key from the address of your account. See and for details.
To create an Account instance with AccountKeyWeightedMultiSig, please refer to or .
The array of .
AccountKeyRoleBased is used to update AccountKey of an account in the Klaytn with . By updating your AccountKey to AccountKeyRoleBased, you can change the AccountKey(s) assigned for each role, all of which are used to validate a transaction in Klaytn. See and for more details.
To create an Account instance with AccountKeyRoleBased, please refer to or .
The array defining accountKey to be used for each . Each role can be defined with , , , or .
WeightedPublicKey contains a public key and its weight. WeightedPublicKey is a class that contains the public key and the weight of the key, and it is used in .
The weight of public key. The weight is used to check whether the weighted sum of public keys is larger than the threshold of the object.
If accountKey is a public key string, an Account instance with as accountKey is created. If accountKey is an array containing public key strings, an Account instance with as accountKey is created. If options are not defined as the last parameter, it is created using a default option with a threshold of 1 and a weight of 1 for each key. If accountKey is an array containing accountKeys that are used for each role, an Account instance with is created. Options must be defined for each role with . If options are not defined, the default option is used for roles that use multiple public keys. Please refer to the example below for how to use it.
| Array
(optional) The instance that defines threshold and weight array.
(optional) An array that contains instances for each role.
Decodes an RLP-encoded string of AccountKey and returns an , , , or instance.
| | | |