caver.utils (~v1.4.1)
caver-js utility APIs.
caver.utils cung cấp các chức năng tiện ích.
randomHex
caver.utils.randomHex(size)Thư viện randomHex để tạo các chuỗi số HEX giả ngẫu nhiên được mã hóa mạnh mẽ từ một kích thước byte nhất định.một kích thước byte nhất định.
Tham số
kích thước
Số
Kích thước byte cho chuỗi số HEX, ví dụ, 32 sẽ dẫn đến chuỗi số HEX 32 byte có 64 ký tự bắt đầu bằng "0x".
Giá trị trả về
Chuỗi
Chuỗi số HEX ngẫu nhiên được tạo.
Ví dụ
> caver.utils.randomHex(32);
"0xa5b9d60f32436310afebcfda832817a68921beb782fabf7915cc0460b443116a"
> caver.utils.randomHex(4);
"0x6892ffc6"
> caver.utils.randomHex(2);
"0x99d6"
> caver.utils.randomHex(1);
"0x9a"
> caver.utils.randomHex(0);
"0x"_
Thư viện underscore dành cho nhiều hàm JavaScript thuận tiện.
Xem tham chiếu API underscore để biết chi tiết.
Ví dụ
BN
Thư viện BN.js để tính toán với các số lớn trong JavaScript. Xem Tài liệu BN.js để biết thông tin chi tiết.
Tham số
hỗn hợp
Chuỗi | Số
Một số, chuỗi số hoặc chuỗi số HEX để chuyển đổi thành đối tượng BN.
Giá trị trả về
Đối tượng
Phiên bản BN.js.
Ví dụ
isBN
Kiểm tra xem một giá trị đã cho có phải là phiên bản BN.js hay không.
Tham số
Giá trị trả về
Boolean
true nếu giá trị đã cho là phiên bản BN.js.
Ví dụ
isBigNumber
Kiểm tra xem một giá trị đã cho có phải là phiên bản BigNumber.js hay không.
Tham số
Giá trị trả về
Boolean
true nếu giá trị đã cho là đối tượng BigNumber.js.
Ví dụ
sha3
Tính toán sha3 của giá trị đầu vào.
LƯU Ý: Để bắt chước hành vi sha3 của việc sử dụng Solidity caver.utils.soliditySha3.
Tham số
chuỗi
Chuỗi
Một chuỗi thành hàm băm.
Giá trị trả về
Chuỗi
Hàm băm kết quả.
Ví dụ
soliditySha3
Tính toán sha3 của các tham số đầu vào đã cho theo cách tương tự như solidity. Điều này có nghĩa các đối số sẽ được chuyển đổi thành ABI và đóng gói chặt chẽ trước khi đưa vào hàm băm.
Tham số
paramX
Hỗn hợp
Bất kỳ loại hoặc đối tượng nào có {type: 'uint', value: '123456'} hoặc {t: 'bytes', v: '0xfff456'}. Các loại cơ bản được tự động nhận diện như sau:
- String chuỗi UTF-8 không phải là số được hiểu là string.
- `String
Giá trị trả về
Chuỗi
Hàm băm kết quả.
Ví dụ
isHex
Kiểm tra xem một chuỗi đã cho có phải là chuỗi số HEX hay không.
Tham số
hex
Chuỗi | HEX
Chuỗi số HEX đã cho.
Giá trị trả về
Boolean
true nếu một chuỗi đã cho là một chuỗi số HEX.
Ví dụ
isHexStrict
Kiểm tra xem một chuỗi đã cho có phải là chuỗi số HEX hay không. Sự khác biệt đối với caver.utils.isHex là nó cần có HEX tiền tố 0x.
Tham số
hex
Chuỗi | HEX
Chuỗi số HEX đã cho.
Giá trị trả về
Boolean
true nếu một chuỗi đã cho là một chuỗi số HEX.
Ví dụ
isAddress
Kiểm tra xem chuỗi đã cho có phải là địa chỉ Klaytn hợp lệ hay không. Nó cũng sẽ kiểm tra giá trị tổng kiểm nếu địa chỉ có chữ hoa và chữ thường.
Tham số
address
Chuỗi
Một chuỗi địa chỉ.
Giá trị trả về
Boolean
true nếu chuỗi đã cho là địa chỉ Klaytn hợp lệ.
Ví dụ
toChecksumAddress
Chuyển đổi địa chỉ Klaytn viết hoa hoặc viết thường thành địa chỉ giá trị tổng kiểm.
Tham số
address
Chuỗi
Một chuỗi địa chỉ.
Giá trị trả về
Chuỗi
Địa chỉ giá trị tổng kiểm.
Ví dụ
checkAddressChecksum
Kiểm tra giá trị tổng kiểm của một địa chỉ đã cho. Trả về false trên các địa chỉ không phải là giá trị tổng kiểm.
Tham số
address
Chuỗi
Một chuỗi địa chỉ.
Giá trị trả về
Boolean
true khi giá trị tổng kiểm của địa chỉ hợp lệ, false nếu đó không phải là địa chỉ giá trị tổng kiểm hoặc giá trị tổng kiểm không hợp lệ.
Ví dụ
toHex
Chuyển đổi giá trị đã cho bất kỳ thành HEX. Chuỗi số sẽ được hiểu là số. Chuỗi văn bản sẽ được hiểu là chuỗi UTF-8.
Tham số
hỗn hợp
Chuỗi | Số | BN | BigNumber
Đầu vào để chuyển đổi sang HEX.
Giá trị trả về
Chuỗi
Chuỗi số HEX kết quả.
Ví dụ
toBN
Chuyển đổi một cách an toàn mọi giá trị đã cho (bao gồm đối tượng BigNumber.js) thành BN.js để xử lý các số lớn trong JavaScript./a>) thành BN.js để xử lý các số lớn trong JavaScript.
LƯU Ý: Chỉ với lớp BN.js, hãy sử dụng caver.utils.BN.
Tham số
số
Chuỗi | Số | HEX
Số để chuyển đổi thành một số lớn.
Giá trị trả về
Đối tượng
Phiên bản BN.js.
Ví dụ
hexToNumberString
Trả về biểu diễn số của một giá trị HEX nhất định dưới dạng chuỗi.
Tham số
hexString
Chuỗi số HEX
Một chuỗi số HEX được chuyển đổi.
Giá trị trả về
Chuỗi
Số dưới dạng chuỗi.
Ví dụ
hexToNumber
Trả về biểu diễn số của một giá trị HEX đã cho.
LƯU Ý: Hàm này không hiệu quả với các số lớn, thay vào đó hãy sử dụng caver.utils.toBN.
Tham số
hexString
Chuỗi số HEX
Một chuỗi số HEX được chuyển đổi.
Giá trị trả về
Số
Biểu diễn số của một giá trị HEX đã cho.
Ví dụ
numberToHex
Trả về biểu diễn HEX của một giá trị số đã cho.
Tham số
số
Chuỗi | Số | BN | BigNumber
Một số dưới dạng chuỗi hoặc số.
Giá trị trả về
Chuỗi
Giá trị HEX của số đã cho.
Ví dụ
hexToUtf8
Trả về biểu diễn chuỗi UTF-8 của một giá trị HEX đã cho.
Tham số
hex
Chuỗi
Chuỗi số HEX để chuyển đổi thành chuỗi UTF-8.
Giá trị trả về
Chuỗi
Chuỗi UTF-8.
Ví dụ
hexToAscii
Trả về biểu diễn chuỗi ASCII của một giá trị HEX đã cho.
Tham số
hex
Chuỗi
Một chuỗi số HEX để chuyển đổi thành một chuỗi ASCII.
Giá trị trả về
Chuỗi
Chuỗi ASCII.
Ví dụ
utf8ToHex
Trả về biểu diễn HEX của một chuỗi UTF-8 đã cho.
Tham số
chuỗi
Chuỗi
Chuỗi UTF-8 để chuyển đổi thành chuỗi số HEX.
Giá trị trả về
Chuỗi
Chuỗi số HEX.
Ví dụ
asciiToHex
Trả về biểu diễn HEX của một chuỗi ASCII đã cho.
Tham số
chuỗi
Chuỗi
Một chuỗi ASCII để chuyển đổi thành chuỗi số HEX.
Giá trị trả về
Chuỗi
Chuỗi số HEX.
Ví dụ
hexToBytes
Trả về một mảng byte từ chuỗi số HEX đã cho.
Tham số
hex
Chuỗi số HEX
Một chuỗi số HEX được chuyển đổi.
Giá trị trả về
Mảng
Mảng byte.
Ví dụ
bytesToHex
Trả về một chuỗi số HEX từ một mảng byte.
Tham số
byteArray
Mảng
Một mảng byte để chuyển đổi.
Giá trị trả về
Chuỗi
Chuỗi số HEX.
Ví dụ
toPeb
Chuyển đổi giá trị KLAY bất kỳ thành peb.
LƯU Ý: "peb" là đơn vị KLAY nhỏ nhất và bạn phải luôn tính toán bằng peb và chỉ chuyển đổi vì lý do hiển thị.
Tham số
số
Chuỗi | Số | BN
Giá trị.
đơn vị
Chuỗi
(tùy chọn, mặc định là "KLAY") KLAY để chuyển đổi. Các đơn vị có thể là:
- peb: '1'
- kpeb: '1000'
- Mpeb: '1000000'
- Gpeb: '1000000000'
- Ston: '1000000000'
- uKLAY: '1000000000000'
- mKLAY: '1000000000000000'
- KLAY: '1000000000000000000'
- kKLAY: '1000000000000000000000'
- MKLAY: '1000000000000000000000000'
- GKLAY: '1000000000000000000000000000'
Giá trị trả về
Chuỗi | BN
Nếu một số hoặc một chuỗi được cung cấp, nó sẽ trả về một chuỗi số, nếu không thì sẽ là một phiên bản BN.js.
Ví dụ
fromPeb
LƯU Ý: "peb" là đơn vị KLAY nhỏ nhất và bạn phải luôn tính toán bằng KLAY và chỉ chuyển đổi vì lý do hiển thị.
Tham số
số
Chuỗi | Số | BN
Giá trị tính bằng peb.
đơn vị
Chuỗi
(tùy chọn, mặc định là "KLAY") KLAY để chuyển đổi sang. Các đơn vị có thể là:
- peb: '1'
- kpeb: '1000'
- Mpeb: '1000000'
- Gpeb: '1000000000'
- Ston: '1000000000'
- uKLAY: '1000000000000'
- mKLAY: '1000000000000000'
- KLAY: '1000000000000000000'
- kKLAY: '1000000000000000000000'
- MKLAY: '1000000000000000000000000'
- GKLAY: '1000000000000000000000000000'
Giá trị trả về
Chuỗi | BN
Nếu một số hoặc một chuỗi được cung cấp, nó sẽ trả về một chuỗi số, nếu không thì sẽ là một phiên bản BN.js.
Ví dụ
unitMap
Hiển thị tất cả các giá trị KLAY có thể có và số lượng của chúng tính bằng peb.
Giá trị trả về
Đối tượng
Với các thuộc tính sau:
- peb: '1'
- kpeb: '1000'
- Mpeb: '1000000'
- Gpeb: '1000000000'
- Ston: '1000000000'
- uKLAY: '1000000000000'
- mKLAY: '1000000000000000'
- KLAY: '1000000000000000000'
- kKLAY: '1000000000000000000000'
- MKLAY: '1000000000000000000000000'
- GKLAY: '1000000000000000000000000000'
Ví dụ
padLeft
Thêm phần đệm vào bên trái của một chuỗi. Hữu ích khi thêm phần đệm vào chuỗi số HEX.
Tham số
chuỗi
Chuỗi
Chuỗi để thêm phần đệm vào bên trái.
characterAmount
Số
Số lượng ký tự mà tổng chuỗi phải có.
ký
Chuỗi
(tùy chọn) Ký tự để sử dụng, mặc định là "0".
Giá trị trả về
Chuỗi
Chuỗi đệm.
Ví dụ
padRight
Thêm phần đệm vào bên phải của chuỗi, Hữu ích khi thêm phần đệm vào chuỗi số HEX.
Tham số
chuỗi
Chuỗi
Chuỗi để thêm phần đệm vào bên phải.
characterAmount
Số
Số lượng ký tự mà tổng chuỗi phải có.
ký
Chuỗi
(tùy chọn) Ký tự để sử dụng, mặc định là "0".
Giá trị trả về
Chuỗi
Chuỗi đệm.
Ví dụ
toTwosComplement
Chuyển đổi một số âm thành phần bù hai.
Tham số
số
Số | Chuỗi | BigNumber
Số cần chuyển đổi.
Giá trị trả về
Chuỗi
Chuỗi số hex đã chuyển đổi.
Ví dụ
isContractDeployment
Trả về true nếu giao dịch đã cho là giao dịch triển khai hợp đồng thông minh. Trả về false nếu giao dịch không phải là giao dịch triển khai hợp đồng thông minh. Kết quả được xác định bởi giá trị của các tham số trong transactionObject. Đảm bảo tất cả các tham số bắt buộc được đặt chính xác.
LƯU Ý caver.klay.isContractDeployment được hỗ trợ từ v1.0.1-rc.8. Để sử dụng tính năng này, hãy cài đặt từ phiên bản v1.0.1-rc.8 trở lên.
Tham số
transactionObject
Đối tượng
Đối tượng giao dịch mà bạn muốn xác định xem giao dịch có dành cho triển khai hợp đồng thông minh hay không.
Giá trị trả về
Boolean
true nghĩa là đối tượng giao dịch dùng cho việc triển khai hợp đồng thông minh.
Ví dụ
xyPointFromPublicKey
Trả về tọa độ x và y của publicKey đã cho. Để biết thêm thông tin về mật mã khóa, xem Mật mã đường cong Elliptic.cong Elliptic.
LƯU Ý Hàm này không chứa bất kỳ logic nào để kiểm tra xem khóa công khai có hợp lệ hay không. Hàm chỉ chia publicKey đầu vào thành các điểm x và y theo độ dài.
Tham số
publicKey
Chuỗi
PublicKey để nhận điểm x và y.
Giá trị trả về
Mảng
Một mảng lưu trữ các điểm x và y. Chỉ mục 0 có điểm x và chỉ mục 1 có điểm y.
Ví dụ
isHexPrefixed
Trả về true nếu đầu vào là một chuỗi số hex có tiền tố 0x, nếu không sẽ trả về false.
LƯU Ý caver.klay.isHexPrefixed được hỗ trợ kể từ phiên bản v1.0.1. Để sử dụng tính năng này, vui lòng cài đặt phiên bản v1.0.1 trở lên.
Tham số
nhập
Chuỗi
Giá trị được xác định xem tham số có phải là chuỗi số hex có tiền tố 0x hay không.
Giá trị trả về
Boolean
true nghĩa là đầu vào là chuỗi số hex có tiền tố 0x.
Ví dụ
addHexPrefix
Trả về một chuỗi số hex có tiền tố là 0x. Nếu đầu vào đã có tiền tố 0x hoặc một chuỗi không phải hex thì giá trị đầu vào được trả về nguyên trạng.
LƯU Ý caver.klay.addHexPrefix được hỗ trợ kể từ phiên bản v1.0.1. Để sử dụng tính năng này, vui lòng cài đặt phiên bản v1.0.1 trở lên.
Tham số
nhập
Chuỗi
Giá trị chuỗi có tiền tố là 0x.
Giá trị trả về
Chuỗi
Chuỗi hex có tiền tố 0x sẽ được trả về.
Ví dụ
stripHexPrefix
Trả về kết quả với tiền tố 0x bị loại bỏ khỏi đầu vào.
LƯU Ý caver.klay.stripHexPrefix được hỗ trợ từ phiên bản v1.0.1. Để sử dụng tính năng này, vui lòng cài đặt phiên bản v1.0.1 trở lên.
Tham số
nhập
Chuỗi
Chuỗi để xóa tiền tố 0x.
Giá trị trả về
Chuỗi
Một chuỗi bị loại bỏ 0x được trả về.
Ví dụ
toBuffer
Hàm này chuyển đổi đầu vào thành Bộ đệm. Để chuyển đổi một đối tượng thành Bộ đệm bằng toBuffer, đối tượng đó phải triển khai hàm toArray. Đối với đầu vào loại chuỗi, hàm này chỉ hoạt động với chuỗi hex có tiền tố 0x.
LƯU Ý caver.klay.toBuffer được hỗ trợ từ v1.1.0. Để sử dụng tính năng này, hãy cài đặt v1.1.0 trở lên.
Tham số
nhập
Bộ đệm | Chuỗi | Số | Mảng | BN | Đối tượng
Giá trị sẽ được chuyển đổi thành Bộ đệm.
Giá trị trả về
Bộ đệm
Giá trị được chuyển đổi thành loại Bộ đệm được trả về.
Ví dụ
numberToBuffer
Hàm này chuyển đổi một số thành Bộ đệm. caver.utils.toBuffer có hoạt động tương tự như hàm này khi đầu vào là một số.
LƯU Ý caver.klay.numberToBuffer được hỗ trợ từ v1.1.0. Để sử dụng tính năng này, hãy cài đặt v1.1.0 trở lên.
Tham số
nhập
Chuỗi | Số | BN
Một số được chuyển đổi thành Bộ đệm.
Giá trị trả về
Bộ đệm
Giá trị được chuyển đổi thành loại Bộ đệm được trả về.
Ví dụ
isTxHash
Trả về true nếu đầu vào ở định dạng hàm băm giao dịch, nếu không sẽ trả về false. Hàm này chỉ xem xét đầu vào và xác định xem nó có ở định dạng hàm băm giao dịch hay không. LƯU Ý caver.klay.isTxHash được hỗ trợ kể từ phiên bản v1.2.0-rc.1. Để sử dụng tính năng này, hãy cài đặt từ phiên bản v1.2.0-rc.1 trở lên. Tham số
nhập
Chuỗi
Giá trị được xác định xem tham số có ở định dạng hàm băm giao dịch hay không.
Giá trị trả về
Boolean
true nghĩa là đầu vào ở định dạng hàm băm giao dịch.
Ví dụ
isTxHashStrict
Trả về true nếu đầu vào ở định dạng hàm băm giao dịch, nếu không sẽ trả về false. Hàm này chỉ xem xét đầu vào và xác định xem nó có ở định dạng hàm băm giao dịch hay không. Sự khác biệt đối với caver.utils.isTxHash là nó cho là HEX có tiền tố là 0x. LƯU Ý caver.klay.isTxHashStrict được hỗ trợ kể từ phiên bản v1.2.0-rc.1. Để sử dụng tính năng này, hãy cài đặt từ phiên bản v1.2.0-rc.1 trở lên. Tham số
nhập
Chuỗi
Giá trị được xác định xem tham số có ở định dạng hàm băm giao dịch hay không.
Giá trị trả về
Boolean
true nghĩa là đầu vào ở định dạng hàm băm giao dịch.
Ví dụ
isValidPrivateKey
Trả về true nếu privateKey hợp lệ, nếu không thì trả về false.
Tham số
privateKey
Chuỗi
Chuỗi khóa riêng để xác thực.
Giá trị trả về
Boolean
true có nghĩa là privateKey hợp lệ.
Ví dụ
isValidPublicKey
Trả về true nếu publicKey hợp lệ, nếu không sẽ trả về false.
LƯU Ý caver.utils.isValidPublicKey được hỗ trợ kể từ caver-js v1.2.0.
Tham số
publicKey
Chuỗi
Chuỗi khóa công khai để xác thực.
Giá trị trả về
Boolean
true nghĩa là publicKey hợp lệ.
Ví dụ
isValidRole
Trả về true nếu vai trò hợp lệ, nếu không sẽ trả về false. Các vai trò hiện được xác định cho AccountKeyRoleBased là transactionKey, updateKey và feePayerKey.
LƯU Ý caver.utils.isValidRole được hỗ trợ kể từ caver-js v1.2.0.
Tham số
vai trò
Chuỗi
Một chuỗi vai trò để xác thực.
Giá trị trả về
Boolean
true có nghĩa là vai trò hợp lệ.
Ví dụ
isEmptySig
Trả về true nếu sig ở định dạng chữ ký trống ([['0x01', '0x', '0x']] hoặc ['0x01', '0x', '0x']), nếu không sẽ trả về false.
Khi mã hóa RLP một giao dịch trong caver-js, nếu chữ ký hoặc phíPayerSignatures trống, thì giá trị đại diện cho chữ ký trống, [['0x01', '0x', '0x']], được trả về cho thuộc tính. Hàm này dùng để kiểm tra xem chữ ký đã cho có phải là [['0x01', '0x', '0x']] (hay ['0x01', '0x', '0x'] trong giao dịch 'LEGACY').
LƯU Ý caver.utils.isEmptySig được hỗ trợ kể từ caver-js v1.2.0.
Tham số
sig
Mảng
Một mảng các chữ ký để kiểm tra xem có trống hay không.
Giá trị trả về
Boolean
true nghĩa là sig là [['0x01', '0x', '0x']] hoặc ['0x01', '0x', '0x'].
Ví dụ
isKlaytnWalletKey
Trả về true nếu khóa thuộc định dạng [KlaytnWalletKey](../../../../../klaytn/design/tài khoảns.md#klaytn-wallet-key-format), nếu không sẽ trả về false.
LƯU Ý caver.utils.isKlaytnWalletKey đã được cập nhật với logic bổ sung để có kết quả chính xác hơn vì caver-js v1.3.2-rc.3.
Tham số
khóa
Chuỗi
Một chuỗi khóa để kiểm tra có định dạng KlaytnWalletKey hay không.
Giá trị trả về
Boolean
true có nghĩa là khóa là 0x{private key}0x{type}0x{address in hex} hoặc {private key}0x{type}0x{address in hex}.
Ví dụ
bufferToHex
Chuyển đổi bộ đệm thành chuỗi số hex có tiền tố 0x.
LƯU Ý caver.utils.bufferToHex được hỗ trợ kể từ caver-js v1.3.2-rc.1.
Tham số
bộ đệm
Bộ đệm
Một bộ đệm để chuyển đổi sang chuỗi số hex.
Giá trị trả về
Chuỗi
Chuỗi số hex có tiền tố 0x.
Ví dụ
Last updated