caver.klay.accounts
계정 관리와 관련된 caver-js API.
caver.klay.accounts는 Klaytn 계정과 서명 트랜잭션과 데이터를 생성하는 함수를 포함합니다.

create

caver.klay.accounts.create([entropy])
개인키와 공개키를 사용하여 계정 개체를 생성합니다.
Parameters
이름
타입
설명
entropy
String
(선택 사항) 엔트로피를 증가시키는 임의의 문자열입니다. If none is given, a random string will be generated using randomHex.
리턴값
Object - 다음 구조의 계정 객체:
이름
타입
설명
주소
String
계정 주소.
privateKey
String
계정 개인키. 로컬 스토리지에 암호화되지 않은 상태로 공유하거나 저장해서는 안 됩니다! 또한 사용 후에는 메모리를 null로 설정하세요.
signTransaction(tx [, callback])
Function
트랜잭션에 서명하는 함수. caver.klay.accounts.signTransaction를 참조하세요.
sign(data)
Function
트랜잭션에 서명하는 함수. See caver.klay.accounts.sign.
encrypt
Function
주어진 비밀번호로 개인키를 암호화하는 함수입니다.
예시
> caver.klay.accounts.create();
{
address: '0x79FF91738661760AC67b3E951c0B4f1F70F80478',
privateKey: '0x{private key}',
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}
> caver.klay.accounts.create('entropy');
{
address: '0x205fffB1025F4af604fEB1d3a22b46C0D2326585',
privateKey: '0x{private key}',
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}
> caver.klay.accounts.create(caver.utils.randomHex(32));
{
address: '0x62Ca8964610A9D447E1a64753a09fC8b3D40b405',
privateKey: '0x{private key}',
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}

createWithAccountKey

caver.klay.accounts.createWithAccountKey(address, accountKey)
주어진 AccountKey로 Account 인스턴스를 생성합니다. Account는 계정 주소와 AccountKey를 관리하기 위한 클래스입니다.
참고 이는 caver-js에서 사용되는 데이터 구조체일 뿐입니다. 이 메서드는 Klaytn 네트워크에 계정을 생성하거나 네트워크에 있는 계정을 업데이트하지 않습니다. 참고 caver.klay.accounts.createWithAccountKey는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
주소
String
계정 주소.
accountKey
String | Array | Object
AccountKey 인스턴스(AccountKeyPublic, AccountKeyMultiSig, AccountKeyRoleBased) 또는 키 정보(개인키 문자열, 개인키 문자열의 배열 또는 각 역할에 해당하는 키를 정의한 객체)를 포함하는 데이터 구조체.
리턴값
Object - 다음 속성을 가진 Account 인스턴스가 반환됩니다.
이름
타입
설명
주소
String
계정 주소.
privateKey
String
계정에 있는 accountKey의 기본 키 문자열. 이 속성은 이전 버전과의 호환성을 위해 남겨졌습니다. privateKey는 accountKey의 기본 키만 나타내므로, privateKey를 사용하여 서명하거나 트랜잭션을 보내지 않는 편이 좋습니다. transactionKey, updateKey 또는 feePayerKey를 사용하는 것이 좋습니다.
accountKeyType
String
계정이 가진 accountKey의 유형. AccountKeyPublic, AccountKeyMultiSig, 또는 AccountKeyRoleBased일 수 있습니다.
accountKey
Object
계정의 키. AccountKeyPublic, AccountKeyMultiSig 또는 AccountKeyRoleBased입니다.
keys
String | Array | Object
계정이 가진 accountKey의 모든 키. AccountKeyPublic의 경우 단일 개인키 문자열입니다. AccountKeyMultiSig의 경우 모든 개인키 문자열이 포함된 배열을 반환합니다. AccountKeyRoleBased의 경우 각 역할에 연계된 키를 가지는 객체가 반환됩니다.
transactionKey
String | Array
RoleTransaction에 사용되는 키. AccountKeyPublic 또는 AccountKeyMultiSig는 어떤 역할에도 묶이지 않으므로, transactionKey는 키와 동일한 값을 가집니다.
updateKey
String | Array
Key used for the RoleAccountUpdate. AccountKeyPublic 또는 AccountKeyMultiSig는 어떤 역할에도 묶이지 않으므로, updateKey는 키와 동일한 값을 가집니다.
feePayerKey
String | Array
Key used for RoleFeePayer. AccountKeyPublic 또는 AccountKeyMultiSig는 어떤 역할에도 묶이지 않으므로, feePayerKey는 키와 동일한 값을 가집니다.
signTransaction(tx [, callback])
Function
트랜잭션에 서명하는 함수. caver.klay.accounts.signTransaction를 참조하세요.
sign(data)
Function
트랜잭션에 서명하는 함수. See caver.klay.accounts.sign.
encrypt
Function
Account를 주어진 비밀번호로 암호화하는 함수.
getKlaytnWalletKey
Function
The function to get Klaytn Wallet Key.
예시
// Create an Account with AccountKeyPublic
> caver.klay.accounts.createWithAccountKey('0x62ca8964610a9d447e1a64753a09fc8b3d40b405', '0x{private key}')
Account {
address: [Getter/Setter],
accountKey: [Getter/Setter],
privateKey: [Getter/Setter],
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}
// Create an Account with AccountKeyMultiSig
> caver.klay.accounts.createWithAccountKey('0x62ca8964610a9d447e1a64753a09fc8b3d40b405', ['0x{private key}', '0x{private key}'])
Account {
address: [Getter/Setter],
accountKey: [Getter/Setter],
privateKey: [Getter/Setter],
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}
// Create an Account with AccountKeyRoleBased
> caver.klay.accounts.createWithAccountKey('0x62ca8964610a9d447e1a64753a09fc8b3d40b405', {
transactionKey: ['0x{private key}', '0x{private key}'], '0x{private key}',
updateKey: ['0x{private key}', '0x{private key}', '0x{private key}'],
feePayerKey: ['0x{private key}', '0x{private key}', '0x{private key}']
})
Account {
address: [Getter/Setter],
accountKey: [Getter/Setter],
privateKey: [Getter/Setter],
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}

createWithAccountKeyPublic

caver.klay.accounts.createWithAccountKeyPublic(address, accountKey)
AccountKeyPublic을 가지는 Account 인스턴스를 생성합니다.
참고 caver.klay.accounts.createWithAccountKeyPublic는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
주소
String
계정 주소.
accountKey
String | Object
An AccountKeyPublic instance or a private key string.
리턴값
Object - An Account instance, see caver.klay.accounts.createWithAccountKey.
예시
> caver.klay.accounts.createWithAccountKeyPublic('0x62ca8964610a9d447e1a64753a09fc8b3d40b405', '0x{private key}')
Account {
address: [Getter/Setter],
accountKey: [Getter/Setter],
privateKey: [Getter/Setter],
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}

createWithAccountKeyMultiSig

caver.klay.accounts.createWithAccountKeyMultiSig(address, accountKey)
AccountKeyMultiSig를 가지는 Account 인스턴스를 생성합니다.
참고 caver.klay.accounts.createWithAccountKeyMultiSig는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
주소
String
계정 주소.
accountKey
String | Object
An AccountKeyMultiSig instance or an array of private key strings.
리턴값
Object - An Account instance, see caver.klay.accounts.createWithAccountKey.
예시
> caver.klay.accounts.createWithAccountKeyMultiSig('0x62ca8964610a9d447e1a64753a09fc8b3d40b405', ['0x{private key}', '0x{private key}'])
Account {
address: [Getter/Setter],
accountKey: [Getter/Setter],
privateKey: [Getter/Setter],
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}

createWithAccountKeyRoleBased

caver.klay.accounts.createWithAccountKeyRoleBased(address, accountKey)
AccountKeyRoleBased를 가지는 Account 인스턴스를 생성합니다.
참고 caver.klay.accounts.createWithAccountKeyRoleBased는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
주소
String
계정 주소.
accountKey
String | Object
An AccountKeyRoleBased instance or an object that defines the key for each role.
리턴값
Object - An Account instance, see caver.klay.accounts.createWithAccountKey.
예시
> caver.klay.accounts.createWithAccountKeyRoleBased('0x62ca8964610a9d447e1a64753a09fc8b3d40b405', {
transactionKey: ['0x{private key}', '0x{private key}', '0x{private key}'],
updateKey: ['0x{private key}', '0x{private key}', '0x{private key}'],
feePayerKey: ['0x{private key}', '0x{private key}', '0x{private key}']
})
Account {
address: [Getter/Setter],
accountKey: [Getter/Setter],
privateKey: [Getter/Setter],
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}

createAccountKey

caver.klay.accounts.createAccountKey(key)
매개 변수 유형에 따라 AccountKeyPublic, AccountKeyMultiSig 또는 AccountKeyRoleBased 인스턴스를 생성합니다.
AccountKey는 caver-js에서 키를 관리하기 위한 데이터 구조체입니다. 하나의 개인키를 사용하려면 AccountKeyPublic을 사용하고 여러 개인키를 사용하려면 AccountKeyMultiSig, 각 역할(Role)별로 다른 키를 사용하려면 AccountKeyRoleBased를 사용하세요.
참고 caver.klay.accounts.createAccountKey는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
key
String | Array | Object
AccountKey를 생성하기 위한 키입니다. key가 단일 개인키 문자열인 경우, AccountKeyPublic 인스턴스가 생성됩니다. key가 개인키 문자열의 배열인 경우, AccountKeyMultiSig 인스턴스가 생성됩니다. key가 역할별 키를 정의한 객체인 경우, AccountKeyRoleBased 인스턴스가 생성됩니다. 각 역할별 키는 단일 개인키 문자열 또는 개인키 문자열의 배열이 될 수 있습니다. AccountKeyRoleBased 인스턴스는 각 역할을 위해 AccountKeyPublic 또는 AccountKeyMultiSig를 가질 수 있습니다.
리턴값
Object - 다음 속성을 가지는 AccountKeyPublic, AccountKeyMultiSig 또는 AccountKeyRoleBased 객체가 반환됩니다.
이름
타입
설명
형식
String
AccountKey 인스턴스의 타입.
defaultKey
String
AccountKey의 기본 개인키. defaultKey는 AccountKeyPublic에 정의된 개인키 문자열, 또는 AccountKeyMultiSig인 경우에는 배열의 0번째 인덱스에 있는 개인키 문자열을 지칭합니다. AccountKeyRoleBased의 경우 첫 번째로 찾아지는 AccountKey의 defaultKey를 지칭하는데, AccountKey를 찾는 순서는 transactionkey, updateKey, feePayerKey 입니다.
keys
String | Array | Object
AccountKey 인스턴스 내에 정의된 모든 개인키. AccountKeyPublic의 경우 단일 개인키 문자열입니다. AccountKeyMultiSig의 경우 모든 개인키 문자열이 포함된 배열을 반환합니다. AccountKeyRoleBased의 경우 각 역할에 연계된 키를 가지는 객체가 반환됩니다.
transactionKey
String | Array
RoleTransaction에 사용되는 키. AccountKeyPublic 또는 AccountKeyMultiSig는 어떤 역할에도 묶이지 않으므로, transactionKey는 키와 동일한 값을 가집니다.
updateKey
String | Array
Key used for the RoleAccountUpdate. AccountKeyPublic 또는 AccountKeyMultiSig는 어떤 역할에도 묶이지 않으므로, updateKey는 키와 동일한 값을 가집니다.
feePayerKey
String | Array
Key used for RoleFeePayer. AccountKeyPublic 또는 AccountKeyMultiSig는 어떤 역할에도 묶이지 않으므로, feePayerKey는 키와 동일한 값을 가집니다.
예시
// AccountKeyPublic 생성
> caver.klay.accounts.createAccountKey('0x{private key}')
AccountKeyPublic {
_key: '0x{private key}'
}
// AccountKeyMultiSig 생성
> caver.klay.accounts.createAccountKey(['0x{private key}', '0x{private key}'])
AccountKeyMultiSig {
_keys: [
'0x{private key}',
'0x{private key}'
]
}
// AccountKeyRoleBased 생성
> caver.klay.accounts.createAccountKey({
transactionKey: '0x{private key}',
updateKey: ['0x{private key}', '0x{private key}'],
feePayerKey: '0x{private key}'
})
AccountKeyRoleBased {
_transactionKey:
AccountKeyPublic {
_key: '0x{private key}'
},
_updateKey:
AccountKeyMultiSig {
_keys: [
'0x{private key}',
'0x{private key}'
]
},
_feePayerKey:
AccountKeyPublic {
_key: '0x{private key}'
}
}

createAccountKeyPublic

caver.klay.accounts.createAccountKeyPublic(key)
주어진 개인키 문자열을 사용하여 AccountKeyPublic의 인스턴스를 생성합니다.
참고 caver.klay.accounts.createAccountKeyPublic는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
key
String
AccountKeyPublic을 생성하기 위한 개인키 문자열입니다.
리턴값
Object - AccountKeyPublic 인스턴스, caver.klay.accounts.createAccountKey를 참고하세요.
예시
> caver.klay.accounts.createAccountKeyPublic('0x{private key}')
AccountKeyPublic {
_key: '0x{private key}'
}

createAccountKeyMultiSig

caver.klay.accounts.createAccountKeyMultiSig(keys
주어진 여러 개의 개인키를 사용하여 AccountKeyMultiSig 인스턴스를 생성합니다.
참고 caver.klay.accounts.createAccountKeyMultiSig는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
keys
Array
AccountKeyMultiSig를 생성하기위한 개인키 문자열의 배열입니다.
리턴값
Object - AccountKeyMultiSig 인스턴스, caver.klay.accounts.createAccountKey를 참조하세요.
예시
> caver.klay.accounts.createAccountKeyMultiSig(['0x{private key}', '0x{private key}'])
AccountKeyMultiSig {
_keys: [
'0x{private key}',
'0x{private key}'
]
}

createAccountKeyRoleBased

caver.klay.accounts.createAccountKeyRoleBased(keyObject)
주어진 역할별 키를 사용하여 AccountKeyRoleBased 인스턴스를 생성합니다.
참고 caver.klay.accounts.createAccountKeyRoleBased는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
keyObject
Object
역할-키 쌍을 가지고 있는 객체. 각 역할에 해당하는 키는 개인키 문자열 또는 개인키 문자열의 배열일 수 있습니다.
리턴값
Object - AccountKeyRoleBased 인스턴스, caver.klay.accounts.createAccountKey를 참조하세요.
예시
> caver.klay.accounts.createAccountKeyRoleBased({
transactionKey: '0x{private key}',
updateKey: ['0x{private key}', '0x{private key}'],
feePayerKey: '0x{private key}'
})
AccountKeyRoleBased {
_transactionKey:
AccountKeyPublic {
_key: '0x{private key}'
},
_updateKey:
AccountKeyMultiSig {
_keys: [
'0x{private key}',
'0x{private key}'
]
},
_feePayerKey:
AccountKeyPublic {
_key: '0x{private key}'
}
}

accountKeyToPublicKey

caver.klay.accounts.accountKeyToPublicKey(accountKey)
이 함수는 AccountKey의 개인키를 공개키로 변환합니다.
참고 caver.klay.accounts.accountKeyToPublicKey는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
accountKey
String | Array | Object
AccountKey 인스턴스(AccountKeyPublic, AccountKeyMultiSig, AccountKeyRoleBased) 또는 키 정보(개인키 문자열, 개인키 문자열의 배열 또는 각 역할에 해당하는 키를 정의한 객체)를 포함하는 데이터 구조체.
리턴값
타입
설명
String | Array | Object
만일 매개 변수가 AccountKeyPublic 인스턴스 또는 개인키 문자열인 경우 공개키 문자열이 반환됩니다. 만일 매개 변수가 AccountKeyMultiSig 인스턴스 또는 개인키 문자열의 배열인 경우 공개키 문자열의 배열이 반환됩니다. 만일 매개 변수가 AccountKeyRoleBased 인스턴스 또는 역할별 키(단일 개인키 문자열 또는 개인키 문자열의 배열)를 정의한 객체인 경우, 역할과 공개키(단일 공개키 문자열 또는 공개키 문자열의 배열) 쌍을 가진 객체를 반환합니다.
예시
// 개인키 문자열 변환
> caver.klay.accounts.accountKeyToPublicKey('0x{private key}')
'0x67f20d1198abcdc036a4d8f3ea0cf837527716c90f71d0b0410dfe3e1b405eded9ea818eedd5e8ad79658b2cdf4862ab0956a6f7fd0a4886afe6110b2e9803a4'
// 개인키 문자열 배열 변환
> caver.klay.accounts.accountKeyToPublicKey(['0x{private key}', '0x{private key}'])
[
'0x67f20d1198abcdc036a4d8f3ea0cf837527716c90f71d0b0410dfe3e1b405eded9ea818eedd5e8ad79658b2cdf4862ab0956a6f7fd0a4886afe6110b2e9803a4',
'0x7c5415f99628618b3fe78e14606c83a22488769b3361e3758c7c98a204a23b615cf07af65490895d70a7b7e7e885fc2f597d65ea69ed586c7ae7cb0241656036'
]
// Convert a role-based key
> caver.klay.accounts.accountKeyToPublicKey({transactionKey: ['0x{private key}', '0x{private key}'], updateKey: '0x{private key}', feePayerKey: ['0x{private key}', '0x{private key}']})
{
transactionKey: [
'0x67f20d1198abcdc036a4d8f3ea0cf837527716c90f71d0b0410dfe3e1b405eded9ea818eedd5e8ad79658b2cdf4862ab0956a6f7fd0a4886afe6110b2e9803a4',
'0x7c5415f99628618b3fe78e14606c83a22488769b3361e3758c7c98a204a23b615cf07af65490895d70a7b7e7e885fc2f597d65ea69ed586c7ae7cb0241656036'
],
updateKey: '0x21aa42e0232e6c7607a0028bcbd690400b92574c44b17af8b036f3f4f01b0586f90578976a040debf6aecef4a5d00b5315b8c82e999ed8e5fbacd5fcbee82080',
feePayerKey: [
'0xb82bb74e902b1fa3594c7cc8bd33a727eb1c85a9bfc991327a0215fc413eafe0b3723cc7f3c6e79981b409e82b8bf7033fed2d2878c26502bea64f84d592b167',
'0x39acd887f32ccecd1b13c890854d2dfd0016f0be477155d81a848e971ff59412b0e4c0b5bfc1fd548b971f98cd9ef19367309d0475033fda3c8028ba9df27734'
]
}

privateKeyToAccount

caver.klay.accounts.privateKeyToAccount(privateKey)
개인키에서 계정 객체를 생성합니다.
Parameters
이름
타입
설명
privateKey
string
변환할 개인키.
리턴값
Object - 계정 객체
예시
> caver.klay.accounts.privateKeyToAccount('0x{private key}');
{
address: '0x62ca8964610a9d447e1a64753a09fc8b3d40b405',
privateKey: '0x{private key}',
signTransaction: [Function: signTransaction],
sign: [Function: sign],
encrypt: [Function: encrypt],
getKlaytnWalletKey: [Function: getKlaytnWalletKey]
}

privateKeyToPublicKey

caver.klay.accounts.privateKeyToPublicKey(privateKey)
주어진 개인키에서 공개키를 도출합니다.
Parameters
이름
타입
설명
privateKey
string
변환할 개인키.
리턴값
String - 공개키 (64바이트)
예시
> caver.klay.accounts.privateKeyToPublicKey('0x{private key}')
'0xbb1846722a4c27e71196e1a44611ee7174276a6c51c4830fb810cac64b0725f217cb8783625a809d1303adeeec2cf036ab74098a77a6b7f1003486e173b29aa7'

createAccountForUpdate

caver.klay.accounts.createAccountForUpdate(address, accountKey, options)
AccountForUpdate 인스턴스를 생성합니다. AccountForUpdate는 계정의 주소와 업데이트 할 새로운 공개키를 가지고 있습니다.
AccountForUpdate는 계정 업데이트 트랜잭션 객체(ACCOUNT_UPDATE, FEE_DELEGATED_ACCOUNT_UPDATE, FEE_DELEGATED_ACCOUNT_UPDATE_WITH_RATIO)의 key로 사용될 수 있습니다. AccountForUpdate를 트랜잭션에서 사용하는 방법은 Account update with AccountForUpdate를 참조하세요.
caver.klay.accounts.createAccountForUpdate의 accountKey 매개 변수는 개인키이어야합니다.
공개키로 AccountForUpdate 인스턴스를 생성하고 싶으면 caver.klay.accounts.createAccountForUpdateWithPublicKey를 사용하세요.
또한 caver.klay.accounts.createAccountForUpdateWithLegacyKey를 사용해 AccountForUpdate 인스턴스를 만들어 AccountKeyLegacy로 업데이트 할 수 있습니다. 그리고 caver.klay.accounts.createAccountForUpdateWithFailKey를 사용해 AccountForUpdate 인스턴스를 만들어 AccountKeyFail로 업데이트할 수 있습니다.
참고 caver.klay.accounts.createAccountForUpdate는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
주소
String
계정 주소.
accountKey
String | Array | Object
AccountKey 인스턴스(AccountKeyPublic, AccountKeyMultiSig, AccountKeyRoleBased) 또는 상응하는 키 정보(개인키 문자열, 개인키 문자열의 배열 또는 각 역할에 해당하는 키를 정의한 객체). accountKey가 AccountKey 인스턴스가 아닌 경우 이 메서드는 내부적으로 caver.klay.accounts.createAccountKey를 호출하여 주어진 키 정보로 AccountKey 인스턴스를 만듭니다.
options
Object
임계값과 가중치를 포함하는 객체로 선택적 매개변수. 이 값은 AccountKeyMultiSig를 사용할 때 필요합니다. 사용법은 아래 예에 나와 있습니다.
리턴값
Object - 다음 속성을 가진 AccountForUpdate 인스턴스가 반환됩니다.
이름
타입
설명
주소
String
업데이트 할 계정의 주소.
keyForUpdate
Object
주어진 accountKey에서 도출한, 새로운 공개키를 포함하는 객체.
예시
// Create AccountForUpdate for AccountKeyPublic
> caver.klay.accounts.createAccountForUpdate('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef', '0x{private key}')
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: {
publicKey: '0x24c32ee4f908ceed89e7501de2980fcb1d2add69080d3921f86c49de863eb2d507e24d9aaf91328b7f7cef2a94b538cb33b3f8cdd64925855ce0a4bf6e11f3db'
}
}
// Create AccountForUpdate for AccountKeyMultiSig with an options object
> caver.klay.accounts.createAccountForUpdate('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef', ['0x{private key}', '0x{private key}'], { threshold: 2, weight: [1,1] })
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: {
multisig: {
threshold: 2,
keys: [
{
weight: 1,
publicKey: '0xc89f551ce9c569cf978f4f64833e447f177a83eda4f1883d770360ab35002dbdeb2d502cd33217238add013ea1c4ff5055ceda46473569824e336d0d64e9eeb2'
},
{
weight: 1,
publicKey: '0xab0837fa3d61cf33dc4f3af4aca692d8c939566e1abbca0036fa3b29cd55b38a387f73baf59510d96680062bd129dd2bb8dcbb5ea5ed16c881f83a3251f73600'
}
]
}
}
}
// Create AccountForUpdate for AccountKeyRoleBased with an options object
> caver.klay.accounts.createAccountForUpdate('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef', { transactionKey: '0x{private key}', updateKey: ['0x{private key}', '0x{private key}'], feePayerKey: '0x{private key}' }, { updateKey: { threshold: 2, weight: [1,1] } })
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: {
roleTransactionKey: {
publicKey: '0x2b4a1d4ca1ee828f17e8c4c0ac0c0c46cf08f4b27fafc01e4b3481a4fe0891cacf315ed10b1df85bfd6797ea6c5ebafac437a7564eff355b11ad1e3d6e6c43a7'
},
roleAccountUpdateKey: {
multisig: {
threshold: 2,
keys: [
{
weight: 1,
publicKey: '0x26156615c8e503d96cd332a2fba6aab88b6156b983c89f586bcfc0443c0a7f2372d892d73c66d30f726f8269c75920a082eb2e57f6662d855389bb922ee263f3'
},
{
weight: 1,
publicKey: '0xafc139d2bcace02fa3d4b12926f976cf672f35a6ea2bc0f7e2e6d2ada0dd28f672acb8dcaedc694d6134a2f6c4aae472c9d67d30f760e16e742e01758c4daf83'
}
]
}
},
roleFeePayerKey: {
publicKey: '0xe55d39e147a0d5542d4bb965aeaa01e918c81a332ce47e0d3173179fe5b68c8c9264bec516d50bea0a7da7c3d8f98e124761a9b27434221d138ff8e22d932a0a'
}
}
}
// Create AccountForUpdate for AccountKeyRoleBased with legacy key or fail key
// When updating the key used for a specific role in AccountKeyRoleBased to AccountKeyLegacy or AccountKeyFailKey, define the role to update as follows.
> caver.klay.accounts.createAccountForUpdate('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef', { transactionKey: 'legacyKey', updateKey: 'failKey' })
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: {
roleTransactionKey: { legacyKey: true },
roleAccountUpdateKey: { failKey: true }
}
}

createAccountForUpdateWithPublicKey

caver.klay.accounts.createAccountForUpdateWithPublicKey(address, keyForUpdate, options)
업데이트 할 새 키의 공개키를 사용하여 AccountForUpdate 인스턴스를 생성합니다.
AccountForUpdate는 계정 업데이트 트랜잭션 객체(ACCOUNT_UPDATE, FEE_DELEGATED_ACCOUNT_UPDATE, FEE_DELEGATED_ACCOUNT_UPDATE_WITH_RATIO)의 key로 사용될 수 있습니다. AccountForUpdate를 트랜잭션에서 사용하는 방법은 Account update with AccountForUpdate를 참조하세요.
참고 caver.klay.accounts.createAccountForUpdateWithPublicKey는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
주소
String
계정 주소.
keyForUpdate
String | Array | Object
The public-key of the new key to update. 이 값은 키가 AccountKeyPublic인 경우에는 단일 공개키 문자열, AccountKeyMultiSig인 경우 공개키 문자열의 배열, 키가 AccountKeyRoleBased인 경우는 객체입니다.
options
Object
임계값과 가중치를 포함하는 객체로 선택적 매개변수. 이 값은 AccountKeyMultiSig를 사용할 때 필요합니다. AccountKeyRoleBased의 키 중 하나로 AccountKeyMultiSig를 사용하는 경우 임계값과 가중치에 역할을 지정하세요. 사용법은 아래 예에 나와 있습니다.
리턴값
Object - An AccountForUpdate instance, see caver.klay.accounts.createAccountForUpdate.
예시
// Create AccountForUpdate for AccountKeyPublic
> caver.klay.accounts.createAccountForUpdateWithPublicKey('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef', '0x24c32ee4f908ceed89e7501de2980fcb1d2add69080d3921f86c49de863eb2d507e24d9aaf91328b7f7cef2a94b538cb33b3f8cdd64925855ce0a4bf6e11f3db')
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: {
publicKey: '0x24c32ee4f908ceed89e7501de2980fcb1d2add69080d3921f86c49de863eb2d507e24d9aaf91328b7f7cef2a94b538cb33b3f8cdd64925855ce0a4bf6e11f3db'
}
}
// Create AccountForUpdate for AccountKeyMultiSig with an options object
> caver.klay.accounts.createAccountForUpdateWithPublicKey('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef', ['0xc89f551ce9c569cf978f4f64833e447f177a83eda4f1883d770360ab35002dbdeb2d502cd33217238add013ea1c4ff5055ceda46473569824e336d0d64e9eeb2', '0xab0837fa3d61cf33dc4f3af4aca692d8c939566e1abbca0036fa3b29cd55b38a387f73baf59510d96680062bd129dd2bb8dcbb5ea5ed16c881f83a3251f73600'], { threshold: 2, weight: [1,1] })
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: {
multisig: {
threshold: 2,
keys: [
{
weight: 1,
publicKey: '0xc89f551ce9c569cf978f4f64833e447f177a83eda4f1883d770360ab35002dbdeb2d502cd33217238add013ea1c4ff5055ceda46473569824e336d0d64e9eeb2'
},
{
weight: 1,
publicKey: '0xab0837fa3d61cf33dc4f3af4aca692d8c939566e1abbca0036fa3b29cd55b38a387f73baf59510d96680062bd129dd2bb8dcbb5ea5ed16c881f83a3251f73600'
}
]
}
}
}
// Create AccountForUpdate for AccountKeyRoleBased with an options object
> caver.klay.accounts.createAccountForUpdateWithPublicKey('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef', { transactionKey: '0x2b4a1d4ca1ee828f17e8c4c0ac0c0c46cf08f4b27fafc01e4b3481a4fe0891cacf315ed10b1df85bfd6797ea6c5ebafac437a7564eff355b11ad1e3d6e6c43a7', updateKey: ['0x26156615c8e503d96cd332a2fba6aab88b6156b983c89f586bcfc0443c0a7f2372d892d73c66d30f726f8269c75920a082eb2e57f6662d855389bb922ee263f3', '0xafc139d2bcace02fa3d4b12926f976cf672f35a6ea2bc0f7e2e6d2ada0dd28f672acb8dcaedc694d6134a2f6c4aae472c9d67d30f760e16e742e01758c4daf83'], feePayerKey: '0xe55d39e147a0d5542d4bb965aeaa01e918c81a332ce47e0d3173179fe5b68c8c9264bec516d50bea0a7da7c3d8f98e124761a9b27434221d138ff8e22d932a0a' }, { updateKey: { threshold: 2, weight: [1,1] } })
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: {
roleTransactionKey: {
publicKey: '0x2b4a1d4ca1ee828f17e8c4c0ac0c0c46cf08f4b27fafc01e4b3481a4fe0891cacf315ed10b1df85bfd6797ea6c5ebafac437a7564eff355b11ad1e3d6e6c43a7'
},
roleAccountUpdateKey: {
multisig: {
threshold: 2,
keys: [
{
weight: 1,
publicKey: '0x26156615c8e503d96cd332a2fba6aab88b6156b983c89f586bcfc0443c0a7f2372d892d73c66d30f726f8269c75920a082eb2e57f6662d855389bb922ee263f3'
},
{
weight: 1,
publicKey: '0xafc139d2bcace02fa3d4b12926f976cf672f35a6ea2bc0f7e2e6d2ada0dd28f672acb8dcaedc694d6134a2f6c4aae472c9d67d30f760e16e742e01758c4daf83'
}
]
}
},
roleFeePayerKey: {
publicKey: '0xe55d39e147a0d5542d4bb965aeaa01e918c81a332ce47e0d3173179fe5b68c8c9264bec516d50bea0a7da7c3d8f98e124761a9b27434221d138ff8e22d932a0a'
}
}
}

createAccountForUpdateWithLegacyKey

caver.klay.accounts.createAccountForUpdateWithLegacyKey(address)
계정의 키를 AccountKeyLegacy로 업데이트 하기 위한 AccountForUpdate 인스턴스를 생성합니다. AccountKeyLegacy로 업데이트하기 전에 계정 주소와 일치하는 개인키를 가지고 있는지 확인하세요.
AccountForUpdate는 계정 업데이트 트랜잭션 객체(ACCOUNT_UPDATE, FEE_DELEGATED_ACCOUNT_UPDATE, FEE_DELEGATED_ACCOUNT_UPDATE_WITH_RATIO)의 key로 사용될 수 있습니다. AccountForUpdate를 트랜잭션에서 사용하는 방법은 Account update with AccountForUpdate를 참조하세요.
참고 caver.klay.accounts.createAccountForUpdateWithLegacyKey는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
주소
String
계정 주소.
리턴값
Object - An AccountForUpdate instance, see caver.klay.accounts.createAccountForUpdate.
예시
// Create AccountForUpdate for AccountKeyLegacy
> caver.klay.accounts.createAccountForUpdateWithLegacyKey('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef')
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: { legacyKey: true }
}

createAccountForUpdateWithFailKey

caver.klay.accounts.createAccountForUpdateWithFailKey(address)
계정의 키를 AccountKeyFail로 업데이트 하기 위한 AccountForUpdate 인스턴스를 생성합니다. AccountKeyFail을 가진 계정에서 보낸 트랜잭션은 항상 유효성 검사 과정에서 실패합니다.
AccountForUpdate는 계정 업데이트 트랜잭션 객체(ACCOUNT_UPDATE, FEE_DELEGATED_ACCOUNT_UPDATE, FEE_DELEGATED_ACCOUNT_UPDATE_WITH_RATIO)의 key로 사용될 수 있습니다. AccountForUpdate를 트랜잭션에서 사용하는 방법은 Account update with AccountForUpdate를 참조하세요.
참고 caver.klay.accounts.createAccountForUpdateWithFailKey는 caver-js v1.2.0부터 지원됩니다.
Parameters
이름
타입
설명
주소
String
계정 주소.
리턴값
Object - An AccountForUpdate instance, see caver.klay.accounts.createAccountForUpdate.
예시
// Create AccountForUpdate for AccountKeyFail
> caver.klay.accounts.createAccountForUpdateWithFailKey('0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef')
AccountForUpdate {
address: '0x5B4EF8e2417DdE1b9B80BcfC35d1bfeF3D7234ef',
keyForUpdate: { failKey: true }
}

signTransaction

caver.klay.accounts.signTransaction(tx [, privateKey] [, callback])
주어진 개인키로 Klaytn 트랜잭션에 서명합니다.
caver-js v1.2.0부터, 이 메서드는 입력 매개 변수로 일반 트랜잭션 객체뿐만 아니라 RLP 인코딩된 트랜잭션도 받습니다. See caver.klay.sendTransaction for the various types of transaction object. 이 메서드는 기본적으로 발신자로 서명합니다. If you want to sign as a fee-payer, we recommend to use caver.klay.accounts.feePayerSignTransaction. 그러나 객체 {senderRawTransaction: rawTransaction, feePayer: feePayerAddress}tx로 전달하면 수수료 납부자도 여전히 이 메서드를 사용하여 서명할 수 있습니다. senderRawTransaction은 FEE_DELEGATED_ 유형의 트랜잭션이어야 합니다.
Also since caver-js v1.2.0, signTransaction keeps the existing signatures/feePayerSignatures in the input transaction and appends the signature(s) of the signer to it.
여러 사용자의 서명을 하나의 rawTransaction으로 결합하는 방법은 Sending a Transaction with multiple signer를 참조하세요.
Parameters
이름
타입
설명
tx
String | Object
Transaction object or RLP-encoded transaction string (rawTransaction). 트랜잭션 객체의 속성은 트랜잭션 유형에 따라 다릅니다. For the description of each transaction type, see caver.klay.sendTransaction.
privateKey
String | Array
(optional) The private key to sign with.
callback
Function
(선택 사항) 선택적 콜백(callback)은 오류 객체를 첫 번째 매개 변수로, 결과를 두 번째 매개 변수로 반환합니다.
참고 privateKey 매개변수는 caver-js v1.2.0-rc.3 이후 선택적 매개변수로 변경되었습니다. 또한 privateKey 매개변수는 caver-js v1.2.0-rc.3 이후 개인키 문자열의 array를 지원합니다. privateKey를 전달하지 않으면, 트랜잭션을 서명하기 위해 from 또는 feePayer 계정이 caver.klay.accounts.wallet에 반드시 존재해야 합니다. privateKey 배열이 제공되면, 배열 내부의 모든 키로 트랜잭션이 서명됩니다.
참고 caver-js v1.2.0부터 tx 매개변수는 RLP 인코딩된 트랜잭션을 받아들입니다.
리턴값
PromiseObject를 반환: RLP 인코딩된 서명된 트랜잭션. 객체 속성은 다음과 같습니다:
이름
타입
설명
messageHash
String
주어진 메시지의 해시.
r
String
ECDSA 서명 r.
s
String
ECDSA 서명 s.
v
String
ECDSA 리커버리 id.
rawTransaction
String
caver.klay.sendSignedTransaction을 사용하여 전송할 준비가 된 RLP 인코딩된 트랜잭션.
txHash
32-byte String
트랜잭션의 해시입니다.
senderTxHash
32-byte String
트랜잭션 발신자만 서명한 트랜잭션의 해시입니다. See SenderTxHash
서명
Array
(optional) An array of the sender's signature(s).
트랜잭션 수수료 납부자 서명
Array
(optional) An array of the fee payer's signature(s).
참고 signatures 및 feePayerSignatures 속성은 caver-js v1.2.0-rc.3 이후 추가되었습니다. 발신자가 트랜잭션에 서명하면, 서명 배열이 signatures로 반환됩니다. 수수료 지불자가 서명하면, 서명 배열이 feePayerSignatures로 반환됩니다.
참고 반환되는 객체에 있는 txHashsenderTxHash는 최종 값이 아닐 수 있습니다. 다른 발신자 서명이 추가되면 txHash 및 senderTxHash가 변경됩니다. 수수료 납부자 서명이 추가되면 txHash가 변경됩니다.
예시
// sign legacy transaction with private key string
> caver.klay.accounts.signTransaction({
from: '0x72519cf34d9aa14629e7ad0cad5d55a3bb398364',
to: '0xa9d2cc2bb853163b6eadfb6f962d72f7e00bc2e6',
value: caver.utils.toPeb(1, 'KLAY'),
gas: 900000,
}, '0x{private key}').then(console.log)
{
messageHash: '0xc4f3d98b901489c2c6e7bb9a5ddb4bc807b0251c6eac671356f01b66b749141f',
v: '0x4e44',
r: '0x2ef0d0c59ad302bcd73823879f6e1550e4bc6e6c38be69724c71ad6e09edde82',
s: '0x602b1064ff5a6ba4718a493e50cf9e58ca9a9addf6ed4bbbc89fbc040a3c107e',
rawTransaction: '0xf86f808505d21dba00830dbba094a9d2cc2bb853163b6eadfb6f962d72f7e00bc2e6880de0b6b3a764000080824e44a02ef0d0c59ad302bcd73823879f6e1550e4bc6e6c38be69724c71ad6e09edde82a0602b1064ff5a6ba4718a493e50cf9e58ca9a9addf6ed4bbbc89fbc040a3c107e',
txHash: '0x87e84bd1d9c512cfabe5ebce10597dd40bc6fe828a10e460b7c01075c76b71a5',
senderTxHash: '0x87e84bd1d9c512cfabe5ebce10597dd40bc6fe828a10e460b7c01075c76b71a5',
signatures: [
'0x4e44',
'0x2ef0d0c59ad302bcd73823879f6e1550e4bc6e6c38be69724c71ad6e09edde82',
'0x602b1064ff5a6ba4718a493e50cf9e58ca9a9addf6ed4bbbc89fbc040a3c107e'
]
}
// signTransaction with private key string
> caver.klay.accounts.signTransaction({
type: 'VALUE_TRANSFER',
from: '0x72519cf34d9aa14629e7ad0cad5d55a3bb398364',
to: '0xa9d2cc2bb853163b6eadfb6f962d72f7e00bc2e6',
value: caver.utils.toPeb(1, 'KLAY'),
gas: 900000,
}, '0x{private key}').then(console.log)
{
messageHash: '0xf003c68467424eed29b55d3d107167b207adb6bba66f8b9b73b7df824beb144c',
v: '0x4e43',
r: '0xea3bba902857eb58bed048fd1b94c5d99881e4356221d6e1e6e873401abf3a5c',
s: '0x5e5d250db3c31a193dbe5289935755461ad78e41c1f60d3ca80ae0a97d2a9924',
rawTransaction: '0x08f887808505d21dba00830dbba094a9d2cc2bb853163b6eadfb6f962d72f7e00bc2e6880de0b6b3a76400009472519cf34d9aa14629e7ad0cad5d55a3bb398364f847f845824e43a0ea3bba902857eb58bed048fd1b94c5d99881e4356221d6e1e6e873401abf3a5ca05e5d250db3c31a193dbe5289935755461ad78e41c1f60d3ca80ae0a97d2a9924',
txHash: '0x1b5759e8060ac01ba94437bd115ecf471ba05e144f4874dd5b82a8379aa98a63',
senderTxHash: '0x1b5759e8060ac01ba94437bd115ecf471ba05e144f4874dd5b82a8379aa98a63',
signatures: [
[
'0x4e43',
'0xea3bba902857eb58bed048fd1b94c5d99881e4356221d6e1e6e873401abf3a5c',
'0x5e5d250db3c31a193dbe5289935755461ad78e41c1f60d3ca80ae0a97d2a9924'
]
]
}
// signTransaction without privateKey parameter
> caver.klay.accounts.signTransaction({
type: 'VALUE_TRANSFER',
from:<