caver.wallet.keyring là một gói cung cấp hàm liên quan đến Keyring bao gồm địa chỉ và (các) khóa riêng tư.
Lớp
Keyring là một cấu trúc chứa địa chỉ của một tài khoản và (các) khóa riêng tư. Đây là một lớp trong caver-js cho phép người dùng đăng nhập bằng [tài khoản Klaytn](../../../../../klaytn/design/tài khoảns.md#klaytn-tài khoảns) của chính họ.
Keyring có thể được phân thành ba loại, tùy thuộc vào loại khóa được lưu trữ: SingleKeyring để lưu trữ một địa chỉ và một khóa riêng tư, MultipleKeyring để lưu trữ một địa chỉ và nhiều khóa riêng tư và RoleBasedKeyring để lưu trữ một địa chỉ và một hoặc nhiều khóa riêng tư cho mỗi vai trò.
SingleKeyring là lớp lưu trữ address của tài khoản và private key. Để tạo đối tượng SingleKeyring bằng chuỗi khóa riêng tư, vui lòng tham khảo caver.wallet.keyring.create.
SingleKeyring sử dụng khóa riêng tư không được chỉ định vai trò.
MultipleKeyring là lớp lưu trữ address của tài khoản và nhiều private key. Để tạo một đối tượng MultipleKeyring với các chuỗi khóa riêng tư, vui lòng tham khảo caver.wallet.keyring.create.
MultipleKeyring sử dụng các khóa riêng tư không được chỉ định vai trò.
thuộc tính
Tên
Loại
Mô tả
address
chuỗi
Địa chỉ của tài khoản.
keys
Mảng
Một mảng các đối tượng PrivateKey chứa một khóa riêng tư bên trong.
RoleBasedKeyring là lớp lưu trữ address của tài khoản và private key được sử dụng cho mỗi vai trò ở dạng một mảng.
RoleBasedKeyring xác định keys được triển khai dưới dạng mảng hai chiều (keys trống giống như [ [], [], [] ]) có thể bao gồm nhiều khóa cho mỗi [vai trò](../../../../../klaytn/design/tài khoảns.md#roles). Phần tử mảng đầu tiên xác định (các) khóa riêng tư cho roleTransactionKey, phần tử thứ hai xác định (các) khóa riêng tư cho roleAccountUpdateKey và phần tử thứ ba xác định (các) khóa riêng tư cho roleFeePayerKey.
thuộc tính
Tên
type
Mô tả
address
chuỗi
Địa chỉ của tài khoản.
keys
Mảng
Mảng hai chiều xác định các khóa được sử dụng cho mỗi [vai trò](../../../../../klaytn/design/tài khoảns.md#roles). Mỗi [vai trò](../../../../../klaytn/design/tài khoảns.md#roles) bao gồm (các) đối tượng PrivateKey. Phần tử đầu tiên trong phần này là roleTransactionKey. Phần tử thứ hai là roleAccountUpdateKey. Phần tử cuối cùng là roleFeePayerKey.
Dưới đây là một getter được xác định trong keyring để sử dụng trực quan khóa được xác định cho từng vai trò. Khóa được sử dụng cho từng vai trò có thể được truy cập dễ dàng hơn thông qua getter bên dưới.
Tên
Loại
Mô tả
roleTransactionKey
Mảng
roleTransactionKey dùng để ký các giao dịch (ngoại trừ các giao dịch để cập nhật tài khoản). keyring.roleTransactionkey sẽ trả về phần tử đầu tiên của thuộc tính keys.
roleAccountUpdateKey
Mảng
roleAccountUpdateKey dùng để ký các giao dịch cập nhật tài khoản. keyring.roleAccountUpdateKey sẽ trả về phần tử thứ hai của thuộc tính keys.
roleFeePayerKey
Mảng
roleFeePayerKey dùng để ký các giao dịch với tư cách là người trả phí. keyring.roleFeePayerKey sẽ trả về phần tử thứ ba của thuộc tính keys.
PrivateKey là lớp chứa chuỗi khóa riêng. Khóa riêng tư được sử dụng cho từng vai trò trong Keyring được xác định là đối tượng PrivateKey này.
thuộc tính
Tên
Loại
Mô tả
privateKey
chuỗi
Chuỗi khóa riêng tư.
SignatureData
SignatureData là lớp chứa dữ liệu chữ ký bên trong. Chữ ký là kết quả của sign hoặc signMessage sẽ được trả về dưới dạng signatureData. Bạn có thể xem cách signatureData chứa (các) chữ ký bên trong như bên dưới.
Nếu key là một chuỗi khóa riêng tư thì đối tượng SingleKeyring sử dụng một khóa riêng tư sẽ được tạo. Nếu key là một mảng chứa các chuỗi khóa riêng tư thì một đối tượng MultipleKeyring sử dụng nhiều khóa riêng tư sẽ được tạo. Nếu key là một mảng 2D trong đó mỗi phần tử chứa (các) khóa riêng được sử dụng cho mỗi vai trò thì một đối tượng RoleBasedKeyring sẽ được tạo.
Tạo một đối tượng RoleBasedKeyring từ một địa chỉ và một mảng 2D trong đó mỗi phần tử mảng chứa các khóa được xác định cho mỗi [vai trò](../../../../../klaytn/design/tài khoảns.md#roles).
Tham số
Tên
type
Mô tả
address
chuỗi
Một địa chỉ của keyring.
roledBasedKeyArray
Mảng
Mảng hai chiều chứa các mảng chuỗi khóa riêng tư cho từng vai trò.
Trả về (các) chuỗi khóa công khai. Nếu keyring là đối tượng SingleKeyring thì getPublicKey sẽ trả về một chuỗi khóa công khai. Nếu keyring là đối tượng MultipleKeyring thì getPublicKey sẽ trả về một mảng các chuỗi khóa công khai. Nếu keyring là đối tượng RoleBasedKeyring thì getPublicKey sẽ trả về một mảng hai chiều trong đó (các) khóa công khai được sử dụng cho mỗi vai trò được xác định dưới dạng một mảng.
Tham số
Tên
Loại
Mô tả
compressed
boolean
(tùy chọn) Có ở định dạng nén hay không (mặc định: false).
Giá trị trả về
Loại
Mô tả
chuỗi \
Mảng
Ví dụ
// Nhận khóa công khai với singleKeyring>keyring.getPublicKey()'0x49b2a...'// Nhận khóa công khai bằng multipleKeyring>keyring.getPublicKey()[ '0x65b51...','0x8d85c...' ]// Nhận khóa công khai với roleBasedKeyring>keyring.getPublicKey()[ [ '0x2d939...','0x6beb4...','0xd8f2f...' ], [ '0xf09cd...','0x96a63...','0x02000...' ], [ '0xc2d33...','0x3088f...','0xab193...' ]]
// Khi keyring là một đối tượng SingleKeyring>keyring.copy()SingleKeyring { _address:'0x30fcfa9679c7141a234c1324c7e0a8b715bdfc90', _key: PrivateKey { _privateKey:'0x{private key}' }}// Khi keyring là một đối tượng MultipleKeyring>keyring.copy()MultipleKeyring { _address:'0x30fcfa9679c7141a234c1324c7e0a8b715bdfc90', _keys: [ PrivateKey { _privateKey:'0x{private key1}' }, PrivateKey { _privateKey:'0x{private key2}' } ]}// Khi keyring là một đối tượng 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])
Ký với transactionHash bằng (các) khóa riêng tư và trả về (các) chữ ký. Nếu người dùng chưa xác định tham số chỉ mục, keyring.sign sẽ ký giao dịch bằng tất cả các khóa riêng tư mà vai trò này sử dụng. Nếu index được xác định thì keyring.sign ký giao dịch chỉ sử dụng một khóa riêng tư tại chỉ mục. Bạn có thể kiểm tra vai trò được sử dụng trong caver-js thông qua caver.wallet.keyring.role.
Một con số biểu thị vai trò của khóa. Bạn có thể sử dụng caver.wallet.keyring.role.
chỉ số
số
(tùy chọn) Chỉ mục khóa riêng tư bạn muốn sử dụng. Chỉ mục phải nhỏ hơn độ dài của mảng các khóa riêng tư được định rõ cho mỗi vai trò. Nếu không định rõ chỉ mục, phương pháp này sẽ sử dụng tất cả các khóa riêng tư.
// Sử dụng roleBasedKeyring có hai khóa riêng tư trong roleTransactionKey>keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550','0x2810',caver.wallet.keyring.role.roleTransactionKey)[ SignatureData { _v:'0x5044', _r:'0x7a8b6...', _s:'0x17139...' }, SignatureData { _v:'0x5043', _r:'0x7f978...', _s:'0x1a532...' }]// Sử dụng roleBasedKeyring có hai khóa riêng tư trong roleTransactionKey với chỉ mục>keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550','0x2810',caver.wallet.keyring.role.roleTransactionKey,1)[ SignatureData { _v:'0x5043', _r:'0x7f978...', _s:'0x1a532...' }]// Sử dụng roleBasedKeyring có hai khóa riêng tư trong roleAccountUpdateKey>keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550','0x2810',caver.wallet.keyring.role.roleAccountUpdateKey)[ SignatureData { _v:'0x5044', _r:'0xdbce8...', _s:'0x039a6...' }, SignatureData { _v:'0x5044', _r:'0xf69b7...', _s:'0x71dc9...' }]// Sử dụng roleBasedKeyring có hai khóa riêng tư trong roleAccountUpdateKey có chỉ mục>keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550','0x2810',caver.wallet.keyring.role.roleAccountUpdateKey,1)[ SignatureData { _v:'0x5044', _r:'0xf69b7...', _s:'0x71dc9...' }]// Sử dụng roleBasedKeyring có hai khóa riêng tư trong roleFeePayerKey>keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550','0x2810',caver.wallet.keyring.role.roleFeePayerKey)[ SignatureData { _v:'0x5043', _r:'0xe48bf...', _s:'0x1cf36...' }, SignatureData { _v:'0x5043', _r:'0x82976...', _s:'0x3c5e0...' }]// Sử dụng roleBasedKeyring có hai khóa riêng tư trong roleFeePayerKey có chỉ mục>keyring.sign('0xe9a11d9ef95fb437f75d07ce768d43e74f158dd54b106e7d3746ce29d545b550','0x2810',caver.wallet.keyring.role.roleFeePayerKey,1)[ SignatureData { _v:'0x5043', _r:'0x82976...', _s:'0x3c5e0...' }]
keyring.ecsign
keyring.ecsign(hash, role [, index])
Ký với dữ liệu ở dạng băm bằng khóa riêng tư và trả về chữ ký trong đó V là 0 hoặc 1 (tính chẵn lẻ của giá trị y của đường cong secp256k1).
Hàm này chỉ được sử dụng cho một số loại giao dịch nhất định. Do đó, bạn nên sử dụng caver.wallet.sign hoặc transaction.sign khi ký giao dịch.
Tham số
Tên
Loại
Mô tả
hash
chuỗi
Chuỗi hàm băm để ký.
vai trò
số
Một con số biểu thị vai trò của khóa. Bạn có thể sử dụng caver.wallet.keyring.role.
chỉ số
số
(tùy chọn) Chỉ mục khóa riêng tư bạn muốn sử dụng. Chỉ mục phải nhỏ hơn độ dài của mảng các khóa riêng tư được định rõ cho mỗi vai trò. Nếu không định rõ chỉ mục, phương pháp này sẽ sử dụng tất cả các khóa riêng tư.
Ký tin nhắn với tiền tố dành riêng cho Klaytn. Thao tác này tính toán chữ ký dành riêng cho Klaytn bằng hàm:
sign(keccak256("\x19Klaytn Signed Message:\n" + len(message) + message)))
Nếu người dùng chưa định rõ tham số chỉ mục, keyring.signMessage sẽ ký tin nhắn bằng tất cả các khóa riêng tư do vai trò này sử dụng. Nếu có tham số chỉ mục, keyring.signMessage sẽ ký tin nhắn chỉ bằng một khóa riêng tư tại chỉ mục đã cho. Bạn có thể tìm thấy vai trò được sử dụng trong caver-js thông qua caver.wallet.keyring.role.
Tham số
Tên
Loại
Mô tả
thông báo
chuỗi
Tin nhắn cần ký.
vai trò
số
Một con số biểu thị vai trò của khóa. Bạn có thể sử dụng caver.wallet.keyring.role.
chỉ số
số
(tùy chọn) Chỉ mục khóa riêng tư bạn muốn sử dụng. Chỉ mục phải nhỏ hơn độ dài của mảng các khóa riêng tư được định rõ cho mỗi vai trò. Nếu không định rõ chỉ mục, phương pháp này sẽ sử dụng tất cả các khóa riêng tư.
Giá trị trả về
type
Mô tả
đối tượng
Một đối tượng bao gồm kết quả ký.
Đối tượng được trả về chứa các mục sau:
Tên
Loại
Mô tả
messageHash
chuỗi
Hàm băm của tin nhắn có tiền tố dành riêng cho Klaytn.
// Ký với roleTransactionKey>keyring.signMessage('message to sign',caver.wallet.keyring.role.roleTransactionKey){ messageHash:'0x9c4c1ae0aa1faf7e59eaf6fcf36a34542698197b379a9949b58c92925e74c069', signatures: [ SignatureData { _v:'0x1b', _r:'0x2dfc6...', _s:'0x15038...' } ], message:'message to sign'}// Ký với roleFeePayerKey và chỉ mục>keyring.signMessage('message to sign',caver.wallet.keyring.role.roleFeePayerKey,1){ messageHash:'0x9c4c1ae0aa1faf7e59eaf6fcf36a34542698197b379a9949b58c92925e74c069', signatures: [ SignatureData { _v:'0x1b', _r:'0x2dfc6...', _s:'0x15038...' } ], message:'message to sign'}
keyring.getKeyByRole
keyring.getKeyByRole(role)
Trả về (các) khóa riêng tư được sử dụng bởi vai trò đã nhập làm tham số.
Tham số
Tên
Loại
Mô tả
vai trò
số
Một con số biểu thị vai trò của khóa. Bạn có thể sử dụng caver.wallet.keyring.role.
// getKeyByRole với singleKeyring. // SingleKeyring sẽ trả về cùng một đối tượng PrivateKey duy nhất bất kể vai trò.>keyring.getKeyByRole(caver.wallet.keyring.role.roleTransactionKey)PrivateKey { _privateKey:'0x{private key}' }>keyring.getKeyByRole(caver.wallet.keyring.role.roleAccountUpdateKey)PrivateKey { _privateKey:'0x{private key}' }>keyring.getKeyByRole(caver.wallet.keyring.role.roleFeePayerKey)PrivateKey { _privateKey:'0x{private key}' }// getKeyByRole với multipleKeyring. // MultipleKeyring cũng sẽ trả về cùng một mảng các đối tượng PrivateKey bất kể vai trò>keyring.getKeyByRole(caver.wallet.keyring.role.roleTransactionKey)[ PrivateKey { _privateKey:'0x{private key1}' }, PrivateKey { _privateKey:'0x{private key2}' }]>keyring.getKeyByRole(caver.wallet.keyring.role.roleAccountUpdateKey)[ PrivateKey { _privateKey:'0x{private key1}' }, PrivateKey { _privateKey:'0x{private key2}' }]>keyring.getKeyByRole(caver.wallet.keyring.role.roleFeePayerKey)[ PrivateKey { _privateKey:'0x{private key1}' }, PrivateKey { _privateKey:'0x{private key2}' }]// getKeyByRole với roleBasedKeyring. // roleBasedKeyring sẽ trả về các mảng đối tượng PrivateKey khác nhau tùy thuộc vào vai trò>keyring.getKeyByRole(caver.wallet.keyring.role.roleTransactionKey)[ PrivateKey { _privateKey:'0x{private key1}' }]>keyring.getKeyByRole(caver.wallet.keyring.role.roleAccountUpdateKey)[ PrivateKey { _privateKey:'0x{private key2}' }, PrivateKey { _privateKey:'0x{private key3}' }]>keyring.getKeyByRole(caver.wallet.keyring.role.roleFeePayerKey)[ PrivateKey { _privateKey:'0x{private key4}' }, PrivateKey { _privateKey:'0x{private key5}' }, PrivateKey { _privateKey:'0x{private key6}' }]
keyring.getKlaytnWalletKey
keyring.getKlaytnWalletKey()
Trả về chuỗi [KlaytnWalletKey](../../../../../klaytn/design/tài khoảns.md#klaytn-wallet-key-format) cho keyring. Với MultipleKeyring hoặc RoleBasedKeyring, bạn không thể sử dụng [KlaytnWalletKey](../../../../../klaytn/design/tài khoảns.md#klaytn-wallet-key-format). Trong trường hợp này, hãy sử dụng keyring.encrypt.
Giá trị trả về
Loại
Mô tả
chuỗi
[KlaytnWalletKey](../../../../../klaytn/design/tài khoảns.md#klaytn-wallet-key-format) của keyring.
Ví dụ
>keyring.getKlaytnWalletKey()'0x{private key}0x{type}0x{address in hex}'
keyring.toAccount
keyring.toAccount([options])
Trả về đối tượng [Tài khoản](../caver.tài khoản.md#tài khoản) để cập nhật [AccountKey](../../../../../klaytn/design/tài khoảns.md#tài khoản-key) của [tài khoản Klaytn](../../../../../klaytn/design/tài khoảns.md#klaytn-tài khoảns). Đối tượng [Tài khoản](../caver.tài khoản.md#tài khoản) có một đối tượng [AccountKey](../caver.tài khoản.md#tài khoảnkeylegacy) có thể chứa (các) khóa công khai bên trong. Khóa này sẽ được gửi đến Mạng Klaytn và được dùng để xác thực giao dịch. Để biết thêm chi tiết về [Tài khoản](../caver.tài khoản.md#tài khoản), xem [Cập nhật tài khoản](../../getting-started.md#tài khoản-update).
Lưu ý rằng nếu bạn cập nhật [AccountKey](../../../../../klaytn/design/tài khoảns.md#tài khoản-key) của [Tài khoản](../../../../../klaytn/design/tài khoảns.md#klaytn-tài khoảns) được lưu trữ trong Klaytn thì (các) khóa riêng tư cũ sẽ không thể sử dụng được nữa. Xem [Bắt đầu](../../getting-started.md#tài khoản-update) về cách sử dụng đối tượng [Tài khoản](../caver.tài khoản.md#tài khoản) được trả về để cập nhật thông tin trong [tài khoản Klaytn](../../../../../klaytn/design/tài khoảns.md#klaytn-tài khoảns) của bạn trên Klaytn.
Tùy thuộc vào loại (các) khóa riêng tư trong keyring, các đối tượng [Tài khoản](../caver.tài khoản.md#tài khoản) được trả về có thể được phân loại như sau.
Khi keyring chứa chuỗi khóa riêng tư: Trả về đối tượng [Tài khoản](../caver.tài khoản.md#tài khoản) bao gồm địa chỉ trong khóa và đối tượng [AccountKeyPublic](../caver.tài khoản.md#tài khoảnkeypublic)
Khi keyring chứa chuỗi khóa riêng tư: Trả về đối tượng [Tài khoản](../caver.tài khoản.md#tài khoản) bao gồm địa chỉ trong khóa và đối tượng [AccountKeyWeigthedMultiSig](../caver.tài khoản.md#tài khoảnkeyweightedmultisig)
Khi keyring chứa các chuỗi khóa riêng tư khác nhau theo vai trò: Trả về đối tượng [Tài khoản](../caver.tài khoản.md#tài khoản) bao gồm địa chỉ trong khóa và đối tượng [AccountKeyRoleBased](../caver.tài khoản.md#tài khoảnkeyrolebased)
Đối tượng Tài khoản sẽ được sử dụng khi người dùng cập nhật AccountKey cho tài khoản của họ trong Klaytn. Lưu ý rằng nếu bạn muốn thay thế chuỗi khóa hiện tại (hoặc (các) khóa riêng tư hiện có) bằng một keyring mới (hoặc (các) khóa riêng tư mới) cho tài khoản của mình thì bạn phải cập nhật AccountKey của mình bằng cách gửi giao dịch Cập nhật tài khoản đến Klaytn trước.