caver.contract
Đối tượng caver.contract
giúp tương tác dễ dàng hơn với các hợp đồng thông minh trên nền tảng chuỗi khối Klaytn. Khi bạn tạo một phiên bản hợp đồng mới, bạn phải cung cấp giao diện JSON cho hợp đồng thông minh đó và caver-js sẽ tự động chuyển đổi tất cả lệnh gọi với phiên bản hợp đồng trong javascript thành lệnh gọi ABI cấp độ thấp qua RPC cho bạn.
Điều này cho phép bạn tương tác với các hợp đồng thông minh như thể chúng là các đối tượng JavaScript.
caver.contract.create
Tạo một phiên bản hợp đồng mới với tất cả các phương pháp và sự kiện được xác định trong đối tượng giao diện JSON của hợp đồng đó. Hàm này hoạt động tương tự như caver.contract mới.
LƯU Ý caver.contract.create
được hỗ trợ kể từ đối tượng caver-js v1.6.1.
Tham số
Xem new caver.contract.
Giá trị trả về
Xem new caver.contract.
Ví dụ
caver.contract
Tạo một phiên bản hợp đồng mới với tất cả các phương pháp và sự kiện được xác định trong đối tượng giao diện JSON của hợp đồng đó.
Tham số
Tên | type | Mô tả |
---|---|---|
jsonInterface | đối tượng | Giao diện JSON để khởi tạo hợp đồng |
address | chuỗi | (tùy chọn) Địa chỉ của hợp đồng thông minh để gọi. Có thể thêm sau bằng cách sử dụng |
tùy chọn | đối tượng | (tùy chọn) Các tùy chọn của hợp đồng. Xem bảng dưới đây để biết thông tin chi tiết. |
Đối tượng tùy chọn chứa các mục sau:
Tên | Loại | Mô tả |
---|---|---|
từ | chuỗi | (tùy chọn) Địa chỉ mà các giao dịch sẽ được thực hiện. |
giá gas | chuỗi | (tùy chọn) Giá gas tính bằng peb để sử dụng cho giao dịch. |
gas | số | (tùy chọn) Lượng gas tối đa được cung cấp cho một giao dịch (giới hạn gas). |
data | chuỗi | (tùy chọn) Mã byte của hợp đồng. Được sử dụng khi hợp đồng được triển khai. |
feeDelegation | boolean | (tùy chọn) Có sử dụng giao dịch ủy thác phí hay không. |
feePayer | chuỗi | (tùy chọn) Địa chỉ của người trả phí thanh toán phí giao dịch. Khi |
feeRatio | chuỗi | (tùy chọn) Tỷ lệ phí giao dịch mà người trả phí sẽ phải chịu. Nếu |
Giá trị trả về
Loại | Mô tả |
---|---|
đối tượng | Đối tượng hợp đồng với tất cả các phương pháp và sự kiện của nó. |
Ví dụ
myContract.options
Đối tượng options
cho phiên bản hợp đồng. from
, gas
, gasPrice
, feePayer
và feeRatio
được sử dụng làm giá trị dự phòng khi gửi giao dịch.
Thuộc tính
Tên | Loại | Mô tả |
---|---|---|
address | chuỗi | Địa chỉ triển khai hợp đồng. |
jsonInterface | Mảng | Giao diện JSON của hợp đồng. |
từ | chuỗi | Địa chỉ mặc định mà giao dịch triển khai/thực thi hợp đồng được gửi đi. Nếu không xác định địa chỉ |
giá gas | chuỗi | Giá gas tính bằng peb để sử dụng cho giao dịch. |
gas | số | Lượng gas tối đa được cung cấp cho một giao dịch (giới hạn gas). |
data | chuỗi | Mã byte của hợp đồng. Được sử dụng khi hợp đồng được triển khai. |
feeDelegation | boolean | (tùy chọn) Có sử dụng giao dịch ủy thác phí hay không. |
feePayer | chuỗi | (tùy chọn) Địa chỉ của người trả phí thanh toán phí giao dịch. Khi |
feeRatio | chuỗi | (tùy chọn) Tỷ lệ phí giao dịch mà người trả phí sẽ phải chịu. Nếu |
LƯU Ý feeDelegation
, feePayer
và feeRatio
được hỗ trợ kể từ phiên bản caver-jsv1.6.1. tượng caver-jsv1.6.1.
Ví dụ
myContract.options.address
Địa chỉ được sử dụng cho phiên bản hợp đồng này myContract
. Tất cả các giao dịch do caver-js tạo ra từ hợp đồng này sẽ chứa địa chỉ này dưới dạng to
của giao dịch.
Thuộc tính
Tên | Loại | Mô tả |
---|---|---|
address | chuỗi \ |
|
Ví dụ
myContract.options.jsonInterface
Đối tượng giao diện JSON bắt nguồn từ ABI của hợp đồng này myContract
.
Thuộc tính
Tên | type | Mô tả |
---|---|---|
jsonInterface | Mảng | Giao diện JSON cho hợp đồng này. Đặt lại điều này sẽ tạo lại các phương pháp và sự kiện của phiên bản hợp đồng. |
Ví dụ
myContract.clone
Sao chép phiên bản hợp đồng hiện tại.
Tham số
Tên | Loại | Mô tả |
---|---|---|
contractAddress | Chuỗi | (tùy chọn) Địa chỉ của hợp đồng mới. Nếu bỏ qua, địa chỉ này sẽ được đặt thành địa chỉ trong đối tượng gốc (e.g., |
Giá trị trả về
Loại | Mô tả |
---|---|
đối tượng | Đối tượng hợp đồng được sao chép mới. |
Ví dụ
myContract.deploy
Triển khai hợp đồng cho mạng lưới Klaytn. Sau khi triển khai thành công, promise sẽ được xử lý bằng một phiên bản hợp đồng mới. Không giống cách hoạt động của hàm myContract.deploy hiện tại, hàm này gửi giao dịch trực tiếp đến mạng lưới Klaytn. Bạn không cần lệnh gọi send()
với đối tượng được trả về.
LƯU Ý caver.wallet
phải chứa các đối tượng keyring tương ứng với from
và feePayer
trong options
hoặc myContract.options
để tạo chữ ký.
LƯU Ý myContract.deploy
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | Các tùy chọn được sử dụng để gửi. Xem bảng trong methods.methodName.send để biết chi tiết. |
byteCode | chuỗi | Mã byte của hợp đồng. |
Tham số | Hỗn hợp | (tùy chọn) Các tham số được chuyển đến hàm tạo khi triển khai. |
Giá trị trả về
Promise
trả về PromiEvent
: Promise sẽ được xử lý với phiên bản hợp đồng mới.
Loại | Mô tả |
---|---|
PromiEvent | Trình phát sự kiện kết hợp promise. Nó sẽ được xử lý khi có biên lai giao dịch. Nếu |
Đối với PromiEvent, sẽ có các sự kiện sau đây:
transactionHash
: nó được kích hoạt ngay sau khi giao dịch được gửi và có sẵn hàm băm giao dịch. Loại của nó làstring
.receipt
: Nó được kích hoạt khi có sẵn biên lai giao dịch. Xem caver.rpc.klay.getTransactionReceipt để biết thêm chi tiết. Loại của nó làobject
.error
: Nó được kích hoạt nếu xảy ra lỗi trong khi gửi. Khi xảy ra lỗi hết gas, tham số thứ hai sẽ là biên lai. Loại của nó làError
.
Ví dụ
myContract.deploy
Trả về đối tượng được sử dụng khi triển khai hợp đồng thông minh cho Klaytn. Bạn có thể gửi giao dịch triển khai hợp đồng thông minh bằng cách gọi lệnh myContract.deploy({ data, arguments }).send(options)
. Sau khi triển khai thành công, promise sẽ được xử lý bằng một phiên bản hợp đồng mới.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | Đối tượng tùy chọn dùng để triển khai. Xem bảng dưới đây để tìm phần thông tin mô tả. |
Đối tượng tùy chọn có thể chứa các thông tin sau:
Tên | type | Mô tả |
---|---|---|
data | chuỗi | Mã byte của hợp đồng. |
đối số | Mảng | (tùy chọn) Các đối số được chuyển đến hàm tạo khi triển khai. |
Giá trị trả về
type | Mô tả |
---|---|
đối tượng | Một đối tượng trong đó các đối số và hàm để phân phối hợp đồng được xác định. Xem bảng dưới đây để tìm phần thông tin mô tả. |
Đối tượng chứa các mục sau:
Tên | Loại | Mô tả |
---|---|---|
đối số | Mảng | Các đối số được chuyển vào |
hàm | Hàm sẽ triển khai hợp đồng đến Klaytn. Promise là kết quả của hàm sẽ được xử lý với phiên bản hợp đồng mới. | |
hàm | Hàm sẽ ký giao dịch triển khai hợp đồng thông minh với tư cách là người gửi. Hàm ký sẽ trả về giao dịch đã ký. | |
hàm | Hàm sẽ ký giao dịch triển khai hợp đồng thông minh với tư cách là người trả phí. Hàm signAsFeePayer sẽ trả về giao dịch đã ký. | |
hàm | Hàm sẽ ước tính lượng gas sử dụng cho việc triển khai. Việc thực thi hàm này không triển khai hợp đồng. | |
hàm | Hàm mã hóa ABI của quá trình triển khai là dữ liệu hợp đồng + tham số hàm tạo. Việc thực thi hàm này không triển khai hợp đồng. |
LƯU Ý myContract.deploy({ data, arguments }).sign(options)
và myContract.deploy({ data, arguments }).signAsFeePayer(options)
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Ví dụ
myContract.send
Gửi một giao dịch để thực hiện hàm của hợp đồng thông minh. Điều này có thể thay đổi trạng thái hợp đồng thông minh.
Loại giao dịch được sử dụng cho hàm này tùy thuộc vào options
hoặc giá trị được xác định trong myContract.options
. Nếu bạn muốn sử dụng giao dịch có phí ủy thác thông qua myContract.send
thì phải đặt feeDelegation
và feePayer
đúng cách.
feeDelegation
không được xác định hoặc được xác định làfalse
: SmartContractExecutionfeeDelegation
được xác định làtrue
nhưngfeePayer
không được xác định : Thông báo lỗi.feeDelegation
được xác định làtrue
vàfeePayer
được xác định nhưngfeeRatio
không được xác định: FeeDelegatedSmartContractExecutionfeeDelegation
được xác định làtrue
vàfeePayer
vàfeeRatio
được xác định: FeeDelegatedSmartContractExecutionWithRatio
LƯU Ý caver.wallet
phải chứa các đối tượng keyring tương ứng với from
và feePayer
trong options
hoặc myContract.options
để tạo chữ ký.
LƯU Ý myContract.send
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | Các tùy chọn được sử dụng để gửi. Xem bảng trong methods.methodName.send để biết chi tiết. |
methodName | chuỗi | Tên phương pháp của hàm hợp đồng để thực thi. |
Tham số | Hỗn hợp | (tùy chọn) Các tham số được chuyển đến hàm hợp đồng thông minh. |
Giá trị trả về
Promise
trả về PromiEvent
Loại | Mô tả |
---|---|
PromiEvent | Trình phát sự kiện kết hợp promise. Nó sẽ được xử lý khi có biên lai giao dịch. Promise sẽ được xử lý với phiên bản hợp đồng mới. |
Đối với PromiEvent, sẽ có các sự kiện sau đây:
transactionHash
: Nó được kích hoạt ngay sau khi giao dịch được gửi và có sẵn hàm băm giao dịch. Loại của nó làstring
.receipt
: Nó được kích hoạt khi có sẵn biên lai giao dịch. Xem caver.rpc.klay.getTransactionReceipt để biết thêm chi tiết. Loại của nó làobject
.error
: Nó được kích hoạt nếu xảy ra lỗi trong khi gửi. Khi xảy ra lỗi hết gas, tham số thứ hai sẽ là biên lai. Loại của nó làError
.
Ví dụ
myContract.sign
Ký một giao dịch hợp đồng thông minh với tư cách là người gửi để triển khai hợp đồng thông minh hoặc thực thi hàm của hợp đồng thông minh.
Nếu hợp đồng thông minh được triển khai, 'constructor' có thể được nhập vào methodName, chẳng hạn như myContract.sign({ from, ... }, 'constructor', byteCode, ...)
.
Loại giao dịch được sử dụng cho hàm này tùy thuộc vào options
hoặc giá trị được xác định trong myContract.options
. Nếu bạn muốn sử dụng giao dịch có phí ủy thác thông qua myContract.sign
thì feeDelegation
phải được xác định là true
.
feeDelegation
không được xác định hoặc được xác định làfalse
: SmartContractDeploy / SmartContractExecutionfeeDelegation
được xác định làtrue
nhưngfeeRatio
không được xác định: FeeDelegatedSmartContractDeploy / FeeDelegatedSmartContractExecutionfeeDelegation
được xác định làtrue
vàfeeRatio
được xác định: FeeDelegatedSmartContractDeployWithRatio / FeeDelegatedSmartContractExecutionWithRatio
LƯU Ý caver.wallet
phải chứa các đối tượng keyring tương ứng với from
trong options
hoặc myContract.options
để tạo chữ ký.
LƯU Ý myContract.sign
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Tham số
Tên | type | Mô tả |
---|---|---|
tùy chọn | đối tượng | Các tùy chọn được sử dụng để gửi. Xem bảng trong methods.methodName.send để biết chi tiết. |
methodName | chuỗi | Tên phương pháp của hàm hợp đồng để thực thi. Nếu bạn muốn ký một giao dịch để triển khai hợp đồng thông minh, hãy sử dụng chuỗi 'constructor' thay vì tên phương pháp. |
Tham số | Hỗn hợp | (tùy chọn) Các tham số được chuyển đến hàm hợp đồng thông minh. Nếu bạn muốn ký một giao dịch triển khai hợp đồng thông minh, hãy thông qua byteCode và các tham số hàm tạo. |
Giá trị trả về
Promise
trả về Giao dịch - Giao dịch hợp đồng thông minh đã ký.
Ví dụ
myContract.signAsFeePayer
Ký một giao dịch hợp đồng thông minh với tư cách là người trả phí để triển khai hợp đồng thông minh hoặc thực thi hàm của hợp đồng thông minh.
Nếu hợp đồng thông minh được triển khai, 'constructor' có thể được nhập vào methodName, chẳng hạn như myContract.signAsFeePayer({ from, feeDelegation: true, feePayer, ... }, 'constructor', byteCode, ...)
.
Loại giao dịch được sử dụng cho hàm này tùy thuộc vào options
hoặc giá trị được xác định trong myContract.options
. signAsFeePayer
là một hàm ký với tư cách là người trả phí giao dịch nên trường feeDelegation
phải được xác định là true
. Ngoài ra, địa chỉ của người trả phí phải được xác định trong trường feePayer
.
feeDelegation
không được xác định : Thông báo lỗi.feeDelegation
được xác định nhưngfeePayer
không được xác định : Thông báo lỗi.feeDelegation
được xác định làtrue
vàfeePayer
được xác định nhưngfeeRatio
không được xác định: FeeDelegatedSmartContractDeploy / FeeDelegatedSmartContractExecutionfeeDelegation
được xác định làtrue
vàfeePayer
vàfeeRatio
được xác định: FeeDelegatedSmartContractDeployWithRatio / FeeDelegatedSmartContractExecutionWithRatio
LƯU Ý caver.wallet
phải chứa các đối tượng keyring tương ứng với feePayer
trong options
hoặc myContract.options
để tạo chữ ký.
LƯU Ý myContract.signAsFeePayer
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Tham số
Tên | type | Mô tả |
---|---|---|
tùy chọn | đối tượng | Các tùy chọn được sử dụng để gửi. Xem bảng trong methods.methodName.send để biết chi tiết. |
methodName | chuỗi | Tên phương pháp của hàm hợp đồng để thực thi. Nếu bạn muốn ký một giao dịch để triển khai hợp đồng thông minh, hãy sử dụng chuỗi 'constructor' thay vì tên phương pháp. |
Tham số | Hỗn hợp | (tùy chọn) Các tham số được chuyển đến hàm hợp đồng thông minh. Nếu bạn muốn ký một giao dịch triển khai hợp đồng thông minh, hãy thông qua byteCode và các tham số hàm tạo. |
Giá trị trả về
Promise
trả về Giao dịch - Giao dịch hợp đồng thông minh đã ký.
Ví dụ
myContract.call
Sẽ gọi một phương pháp hằng số và thực thi phương pháp hợp đồng thông minh của nó trong Máy ảo Klaytn mà không gửi bất kỳ giao dịch nào. Lưu ý rằng việc gọi không thể thay đổi trạng thái hợp đồng thông minh.
LƯU Ý myContract.call
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | (tùy chọn) Các tùy chọn dùng để gọi. Xem bảng trong methods.methodName.call để biết chi tiết. |
methodName | chuỗi | Tên phương pháp của hàm hợp đồng để gọi. |
Tham số | Hỗn hợp | (tùy chọn) Các tham số được chuyển đến hàm hợp đồng thông minh. |
Giá trị trả về
Promise
trả về Mixed
- (Các) giá trị trả về của phương pháp hợp đồng thông minh. Nếu trả về một giá trị duy nhất, nó sẽ được trả về như cũ. Nếu nó có nhiều giá trị trả về, nó sẽ trả về một đối tượng có thuộc tính và chỉ số.
Ví dụ
myContract.decodeFunctionCall
Giải mã lệnh gọi hàm và trả về tham số.
LƯU Ý myContract.decodeFunctionCall
được hỗ trợ kể từ caver-js phiên bản v1.6.3.
Tham số
Tên | Loại | Mô tả |
---|---|---|
functionCall | chuỗi | Chuỗi lệnh gọi hàm được mã hóa. |
Giá trị trả về
Loại | Mô tả |
---|---|
đối tượng | Một đối tượng bao gồm các tham số đơn giản. Bạn có thể sử dụng |
Ví dụ
myContract.methods
Tạo một đối tượng giao dịch cho phương pháp đó, sau đó có thể gọi, gửi, ước tính hoặc mã hóa dưới dạng ABI.
Các phương pháp của hợp đồng thông minh này có sẵn thông qua:
Tên phương pháp:
myContract.methods.methodName(123)
hoặcmyContract.methods[methodName](123)
Nguyên mẫu phương pháp:
myContract.methods['methodName(uint256)'](123)
Chữ ký phương pháp:
myContract.methods['0x58cf5f10'](123)
Điều này cho phép gọi các hàm có cùng tên nhưng khác tham số từ phiên bản hợp đồng JavaScript.
cf) *function signature (function selector)
Bốn byte đầu tiên của dữ liệu lệnh gọi cho lệnh gọi hàm chỉ định chức năng sẽ được gọi. Đây là bốn byte đầu tiên (left, high-order in big-endian) của hàm băm Keccak-256 (SHA-3) của chữ ký của hàm.
Chữ ký hàm có thể được cung cấp thông qua 2 phương pháp khác nhau.
1. caver.abi.encodefunctionSignature('funcName(paramType1,paramType2,...)')
2. caver.utils.sha3('funcName(paramType1,paramType2,...)').substr(0, 10)
ex)
Tham số
Các tham số của bất kỳ phương pháp nào thuộc về hợp đồng thông minh này, được xác định trong giao diện JSON.
Giá trị trả về
Promise
trả về object
- Một đối tượng trong đó các đối số và hàm để thực thi hợp đồng được xác định.:
Tên | Loại | Mô tả |
---|---|---|
đối số | Mảng | Các đối số được đưa vào phương pháp này. |
hàm | Hàm sẽ gọi và thực thi một phương pháp không đổi trong hợp đồng thông minh của nó trên Máy ảo Klaytn mà không gửi giao dịch (không thể thay đổi trạng thái hợp đồng thông minh). | |
hàm | Hàm sẽ gửi giao dịch đến Klaytn và thực hiện phương pháp của nó (có thể thay đổi trạng thái hợp đồng thông minh). | |
hàm | Hàm sẽ ký một giao dịch với tư cách là người gửi. Hàm ký sẽ trả về giao dịch đã ký. | |
hàm | Hàm sẽ ký một giao dịch với tư cách là người trả phí. Hàm signAsFeePayer sẽ trả về giao dịch đã ký. | |
hàm | Hàm đó sẽ ước tính lượng gas dùng để thực thi. | |
hàm | Hàm mã hóa ABI cho phương pháp này. Nó có thể được gửi bằng cách sử dụng một giao dịch, gọi phương pháp hoặc chuyển sang một phương pháp hợp đồng thông minh khác làm đối số của nó. |
LƯU Ý sign
và signAsFeePayer
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Ví dụ
methods.methodName.call
Sẽ gọi một phương pháp hằng số và thực thi phương pháp hợp đồng thông minh của nó trong Máy ảo Klaytn mà không gửi bất kỳ giao dịch nào. Lưu ý rằng việc gọi không thể thay đổi trạng thái hợp đồng thông minh. Bạn nên sử dụng myContract.call được cung cấp dưới dạng hàm rút gọn.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | (tùy chọn) Các tùy chọn dùng để gọi. Xem bảng dưới đây để biết thông tin chi tiết. |
callback | hàm | (tùy chọn) Lệnh gọi lại này sẽ được kích hoạt với kết quả thực thi phương pháp hợp đồng thông minh làm đối số thứ hai hoặc với một đối tượng lỗi làm đối số đầu tiên. |
Đối tượng tùy chọn có thể chứa các thông tin sau:
Tên | type | Mô tả |
---|---|---|
từ | chuỗi | (tùy chọn) Địa chỉ mà các phương pháp hợp đồng gọi sẽ được thực hiện từ đó. |
giá gas | chuỗi | (tùy chọn) Giá gas tính bằng peb để sử dụng cho lệnh gọi này. |
gas | số | (tùy chọn) Lượng gas tối đa được cung cấp cho lệnh gọi này (giới hạn gas). |
Giá trị trả về
Promise
trả về Mixed
- (Các) giá trị trả về của phương pháp hợp đồng thông minh. Nếu trả về một giá trị duy nhất, nó sẽ được trả về như cũ. Nếu nó có nhiều giá trị trả về, nó sẽ trả về một đối tượng có thuộc tính và chỉ số.
Ví dụ
methods.methodName.send
Sẽ gửi một giao dịch để triển khai hợp đồng thông minh hoặc thực hiện hàm của hợp đồng thông minh. Điều này có thể thay đổi trạng thái hợp đồng thông minh. Bạn nên sử dụng myContract.send được cung cấp dưới dạng hàm rút gọn.
Nếu hợp đồng thông minh được triển khai, 'constructor' có thể được nhập vào methodName như myContract.methods.constructor
hoặc myContract.methods['constructor']
, tuy nhiên nên sử dụng hàm myContract.deploy.
Loại giao dịch được sử dụng cho hàm này tùy thuộc vào options
hoặc giá trị được xác định trong myContract.options
. Nếu bạn muốn sử dụng giao dịch có phí ủy thác thông qua methods.methodName.send
thì phải đặt feeDelegation
và feePayer
đúng cách.
feeDelegation
không được xác định hoặc được xác định làfalse
: SmartContractDeploy / SmartContractExecutionfeeDelegation
được xác định làtrue
nhưngfeePayer
không được xác định : Thông báo lỗi.feeDelegation
được xác định làtrue
vàfeePayer
được xác định nhưngfeeRatio
không được xác định: FeeDelegatedSmartContractDeploy / FeeDelegatedSmartContractExecutionfeeDelegation
được xác định làtrue
vàfeePayer
vàfeeRatio
được xác định: FeeDelegatedSmartContractDeployWithRatio / FeeDelegatedSmartContractExecutionWithRatio
LƯU Ý caver.wallet
phải chứa các đối tượng keyring tương ứng với from
và feePayer
trong options
hoặc myContract.options
để tạo chữ ký.
Tham số
Tên | type | Mô tả |
---|---|---|
tùy chọn | đối tượng | Các tùy chọn được sử dụng để gửi. Xem bảng dưới đây để biết thông tin chi tiết. |
callback | hàm | (tùy chọn) Lệnh gọi lại này sẽ được kích hoạt trước với "transactionHash" hoặc với một đối tượng lỗi làm đối số đầu tiên. |
Đối tượng tùy chọn có thể chứa các thông tin sau:
Tên | Loại | Mô tả |
---|---|---|
từ | chuỗi | Địa chỉ mà từ đó giao dịch sẽ được gửi. Nếu bỏ qua, |
gas | số | Lượng gas tối đa được cung cấp cho giao dịch này (giới hạn gas). |
giá gas | chuỗi | (tùy chọn) Giá gas tính bằng peb để sử dụng cho giao dịch này. |
giá trị | số \ | chuỗi | BN | Bignumber |
feeDelegation | boolean | (tùy chọn, mặc định |
feePayer | chuỗi | (tùy chọn) Địa chỉ của người trả phí thanh toán phí giao dịch. Khi |
feeRatio | chuỗi | (tùy chọn) Tỷ lệ phí giao dịch mà người trả phí sẽ phải chịu. Nếu |
LƯU Ý feeDelegation
, feePayer
và feeRatio
được hỗ trợ kể từ phiên bản caver-jsv1.6.1. tượng caver-jsv1.6.1.
Giá trị trả về
Promise
trả về PromiEvent
Loại | Mô tả |
---|---|
PromiEvent | Trình phát sự kiện kết hợp promise. Nó sẽ được xử lý khi có biên lai giao dịch. Promise sẽ được xử lý với phiên bản hợp đồng mới. |
Đối với PromiEvent, sẽ có các sự kiện sau đây:
transactionHash
: Nó được kích hoạt ngay sau khi giao dịch được gửi và có sẵn hàm băm giao dịch. Loại của nó làstring
.receipt
: Nó được kích hoạt khi có sẵn biên lai giao dịch. Xem caver.rpc.klay.getTransactionReceipt để biết thêm chi tiết. Loại của nó làobject
.error
: Nó được kích hoạt nếu xảy ra lỗi trong khi gửi. Khi xảy ra lỗi hết gas, tham số thứ hai sẽ là biên lai. Loại của nó làError
.
Ví dụ
methods.methodName.sign
Ký một giao dịch hợp đồng thông minh với tư cách là người gửi để triển khai hợp đồng thông minh hoặc thực thi hàm của hợp đồng thông minh. Bạn nên sử dụng myContract.sign được cung cấp dưới dạng hàm rút gọn.
Nếu một hợp đồng thông minh được triển khai, 'constructor' có thể được nhập vào methodName chẳng hạn như myContract.methods.constructor
hoặc myContract.methods['constructor']
.
Loại giao dịch được sử dụng cho hàm này tùy thuộc vào options
hoặc giá trị được xác định trong myContract.options
. Nếu bạn muốn sử dụng giao dịch có phí ủy thác thông qua methods.methodName.sign
thì feeDelegation
phải được xác định là true
.
feeDelegation
không được xác định hoặc được xác định làfalse
: SmartContractDeploy / SmartContractExecutionfeeDelegation
được xác định làtrue
nhưngfeeRatio
không được xác định: FeeDelegatedSmartContractDeploy / FeeDelegatedSmartContractExecutionfeeDelegation
được xác định làtrue
vàfeeRatio
được xác định: FeeDelegatedSmartContractDeployWithRatio / FeeDelegatedSmartContractExecutionWithRatio
LƯU Ý caver.wallet
phải chứa các đối tượng keyring tương ứng với from
trong options
hoặc myContract.options
để tạo chữ ký.
LƯU Ý methods.methodName.sign
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | Các tùy chọn dùng để tạo giao dịch. Xem bảng tham số trong methods.methodName.send để biết chi tiết. |
Giá trị trả về
Promise
trả về Giao dịch - Giao dịch hợp đồng thông minh đã ký.
Ví dụ
methods.methodName.signAsFeePayer
Ký một giao dịch hợp đồng thông minh với tư cách là người trả phí để triển khai hợp đồng thông minh hoặc thực thi hàm của hợp đồng thông minh. Bạn nên sử dụng myContract.signAsFeePayer được cung cấp dưới dạng hàm rút gọn.
Nếu một hợp đồng thông minh được triển khai, 'constructor' có thể được nhập vào methodName chẳng hạn như myContract.methods.constructor
hoặc myContract.methods['constructor']
.
Loại giao dịch được sử dụng cho hàm này tùy thuộc vào options
hoặc giá trị được xác định trong myContract.options
. signAsFeePayer
là một hàm ký với tư cách là người trả phí giao dịch nên trường feeDelegation
phải được xác định là true
. Ngoài ra, địa chỉ của người trả phí phải được xác định trong trường feePayer
.
feeDelegation
không được xác định : Thông báo lỗi.feeDelegation
được xác định nhưngfeePayer
không được xác định : Thông báo lỗi.feeDelegation
được xác định làtrue
vàfeePayer
được xác định nhưngfeeRatio
không được xác định: FeeDelegatedSmartContractDeploy / FeeDelegatedSmartContractExecutionfeeDelegation
được xác định làtrue
vàfeePayer
vàfeeRatio
được xác định: FeeDelegatedSmartContractDeployWithRatio / FeeDelegatedSmartContractExecutionWithRatio
LƯU Ý caver.wallet
phải chứa các đối tượng keyring tương ứng với feePayer
trong options
hoặc myContract.options
để tạo chữ ký.
LƯU Ý methods.methodName.signAsFeePayer
được hỗ trợ kể từ caver-js phiên bản v1.6.1.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | Các tùy chọn dùng để tạo giao dịch. Xem bảng tham số trong methods.methodName.send để biết chi tiết. |
Giá trị trả về
Promise
trả về Giao dịch - Giao dịch hợp đồng thông minh đã ký.
Ví dụ
methods.methodName.estimateGas
Sẽ ước tính mức gas mà việc thực thi phương pháp sẽ sử dụng khi được thực thi trong Máy ảo Klaytn. Ước tính có thể khác với gas thực tế được sử dụng khi gửi giao dịch sau này, vì trạng thái của hợp đồng thông minh có thể khác vào thời điểm đó.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | (tùy chọn) Các tùy chọn dùng để gọi. Xem bảng dưới đây để biết thông tin chi tiết. |
callback | hàm | (tùy chọn) Lệnh gọi lại này sẽ được kích hoạt với kết quả ước tính gas làm đối số thứ hai hoặc với một đối tượng lỗi làm đối số đầu tiên. |
Đối tượng tùy chọn có thể chứa các thông tin sau:
Tên | Loại | Mô tả |
---|---|---|
từ | chuỗi | (tùy chọn) Địa chỉ mà từ đó việc gọi phương pháp hợp đồng sẽ được thực hiện. |
gas | số | (tùy chọn) Lượng gas tối đa được cung cấp cho lệnh gọi này (giới hạn gas). Đặt một giá trị cụ thể giúp phát hiện lỗi hết gas. Nếu dùng hết gas sẽ về số như cũ. |
giá trị | số \ | chuỗi | BN | Bignumber |
Giá trị trả về
Promise
trả về số
Loại | Mô tả |
---|---|
số | Gas được sử dụng cho lệnh gọi/giao dịch mô phỏng. |
Ví dụ
methods.methodName.encodeABI
Mã hóa ABI cho phương pháp này. Nó có thể dùng để gửi một giao dịch hoặc gọi một phương pháp hoặc chuyển nó vào một phương pháp hợp đồng thông minh khác làm đối số.
Tham số
Các tham số của bất kỳ phương pháp nào thuộc về hợp đồng thông minh này, được xác định trong giao diện JSON.
Giá trị trả về
Loại | Mô tả |
---|---|
chuỗi | Mã byte ABI được mã hóa để gửi qua giao dịch hoặc cuộc gọi. |
Ví dụ
myContract.once
Đăng ký một sự kiện và hủy đăng ký ngay sau sự kiện hoặc lỗi đầu tiên. Sẽ chỉ kích hoạt cho một sự kiện duy nhất.
Tham số
Tên | Loại | Mô tả |
---|---|---|
sự kiện | chuỗi | Tên của sự kiện trong hợp đồng hoặc |
tùy chọn | đối tượng | (tùy chọn) Các tùy chọn dùng để đăng ký. Xem bảng dưới đây để biết thông tin chi tiết. |
callback | hàm | Lệnh gọi lại này sẽ được kích hoạt cho sự kiện đầu tiên làm đối số thứ hai hoặc lỗi làm đối số thứ nhất. Xem myContract.getPastEvents để biết chi tiết về cấu trúc sự kiện. |
Đối tượng tùy chọn có thể chứa các thông tin sau:
Tên | Loại | Mô tả |
---|---|---|
bộ lọc | đối tượng | (tùy chọn) Cho phép bạn lọc các sự kiện theo các tham số được lập chỉ mục, vd: |
chủ đề | Mảng | (tùy chọn) Điều này cho phép bạn đặt chủ đề cho bộ lọc sự kiện theo cách thủ công. Nếu được cung cấp thuộc tính bộ lọc và chữ ký sự kiện, |
Giá trị trả về
Promise
trả về object
- Đối tượng sự kiện. Để biết thêm chi tiết về đối tượng sự kiện, vui lòng tham khảo myContract.getPastEvents.
Ví dụ
myContract.subscribe
Đăng ký một sự kiện. Hàm này hoạt động giống như myContract.events.eventName.
Bạn có thể hủy đăng ký một sự kiện bằng cách gọi hàm unsubscribe
của đối tượng đăng ký được trả về bởi hàm subscribe
.
LƯU Ý myContract.subscribe
được hỗ trợ kể từ caver-js phiên bản v1.9.1-rc.1.
Tham số
Tên | Loại | Mô tả |
---|---|---|
sự kiện | chuỗi | Tên của sự kiện trong hợp đồng hoặc |
tùy chọn | đối tượng | (tùy chọn) Các tùy chọn dùng để đăng ký. Xem bảng dưới đây để biết thông tin chi tiết. |
callback | hàm | Lệnh gọi lại này sẽ được kích hoạt cho sự kiện đầu tiên làm đối số thứ hai hoặc lỗi làm đối số thứ nhất. Xem myContract.getPastEvents để biết chi tiết về cấu trúc sự kiện. |
Đối tượng tùy chọn có thể chứa các thông tin sau:
Tên | Loại | Mô tả |
---|---|---|
bộ lọc | đối tượng | (tùy chọn) Cho phép bạn lọc các sự kiện theo các tham số được lập chỉ mục, vd: |
chủ đề | Mảng | (tùy chọn) Điều này cho phép bạn đặt chủ đề cho bộ lọc sự kiện theo cách thủ công. Nếu được cung cấp thuộc tính bộ lọc và chữ ký sự kiện, |
Giá trị trả về
Promise
trả về object
- Đối tượng sự kiện. Để biết thêm chi tiết về đối tượng sự kiện, vui lòng tham khảo myContract.getPastEvents.
Ví dụ
myContract.events
Đăng ký một sự kiện.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tùy chọn | đối tượng | (tùy chọn) Các tùy chọn dùng để đăng ký. Xem bảng dưới đây để biết thông tin chi tiết. |
callback | hàm | (tùy chọn) Lệnh gọi lại này sẽ được kích hoạt cho từng sự kiện làm đối số thứ hai hoặc lỗi làm đối số thứ nhất. |
Đối tượng tùy chọn có thể chứa các thông tin sau:
Tên | Loại | Mô tả |
---|---|---|
bộ lọc | đối tượng | (tùy chọn) Cho phép bạn lọc các sự kiện theo các tham số được lập chỉ mục, vd: |
fromBlock | số | (tùy chọn) Số khối bắt đầu các sự kiện. |
chủ đề | Mảng | (tùy chọn) Điều này cho phép bạn đặt chủ đề cho bộ lọc sự kiện theo cách thủ công. Nếu được cung cấp thuộc tính bộ lọc và chữ ký sự kiện, |
Giá trị trả về
EventEmitter
: Trình phát sự kiện có các sự kiện sau:
Tên | Loại | Mô tả |
---|---|---|
data | đối tượng | Kích hoạt từng sự kiện đến với đối tượng sự kiện làm đối số. |
connected | chuỗi | Kích hoạt một lần sau khi đăng ký được kết nối thành công. Nó sẽ trả về ID đăng ký. |
lỗi | đối tượng | Kích hoạt khi xảy ra lỗi trong đăng ký. |
LƯU Ý connected
khả dụng với caver-js phiên bản v1.5.7.
Cấu trúc của sự kiện trả về Đối tượng
sẽ có dạng như sau:
Tên | type | Mô tả |
---|---|---|
sự kiện | chuỗi | Tên sự kiện. |
chữ ký | chuỗi \ |
|
address | chuỗi | Địa chỉ bắt nguồn từ sự kiện này. |
returnValues | đối tượng | Các giá trị trả về đến từ sự kiện, ví dụ:, |
logIndex | số | Số nguyên của vị trí chỉ mục sự kiện trong khối. |
transactionIndex | số | Số nguyên của vị trí chỉ mục giao dịch nơi sự kiện được tạo ra. |
transactionHash | chuỗi 32 byte | Hàm băm của giao dịch mà sự kiện này được tạo. |
blockHash | chuỗi 32 byte | Hàm băm của khối mà sự kiện này đã được tạo. |
blocknumber | số | Số khối mà bản ghi này đã được tạo. Giá trị là |
raw.data | chuỗi | Dữ liệu chứa tham số bản ghi không được lập chỉ mục. |
raw.topics | Mảng | Một mảng có tối đa bốn chủ đề 32 byte và chủ đề 1-3 chứa các tham số được lập chỉ mục của sự kiện. |
id | chuỗi | Mã số định danh bản ghi. Mã định danh được tạo thông qua việc nối chuỗi "log_" với |
Ví dụ
events.allEvents
Tương tự như myContract.events nhưng nhận tất cả các sự kiện từ hợp đồng thông minh này. Theo tùy chọn, thuộc tính bộ lọc có thể lọc các sự kiện đó.
getPastEvents
Nhận các sự kiện trong quá khứ cho hợp đồng này.
Tham số
Tên | Loại | Mô tả |
---|---|---|
sự kiện | chuỗi | Tên của sự kiện trong hợp đồng hoặc |
tùy chọn | đối tượng | (tùy chọn) Các tùy chọn dùng để đăng ký. Xem bảng dưới đây để biết thông tin chi tiết. |
callback | hàm | (tùy chọn) Lệnh gọi lại này sẽ được kích hoạt với một mảng bản ghi sự kiện làm đối số thứ hai hoặc một lỗi làm đối số thứ nhất. |
Đối tượng tùy chọn có thể chứa các thông tin sau:
Tên | Loại | Mô tả |
---|---|---|
bộ lọc | đối tượng | (tùy chọn) Cho phép bạn lọc các sự kiện theo các tham số được lập chỉ mục, vd: |
fromBlock | số | (tùy chọn) Số khối bắt đầu các sự kiện. |
toBlock | số | (tùy chọn) Số khối để nhận các sự kiện lên đến (mặc định là |
chủ đề | Mảng | (tùy chọn) Điều này cho phép đặt chủ đề cho bộ lọc sự kiện theo cách thủ công. Nếu được cung cấp thuộc tính bộ lọc và chữ ký sự kiện, |
Giá trị trả về
Promise
trả về Array
: - Một mảng chứa các đối tượng sự kiện trong quá khứ, khớp với tên sự kiện và bộ lọc đã cho.
Một đối tượng sự kiện có thể chứa những thông tin sau đây:
Tên | Loại | Mô tả |
---|---|---|
sự kiện | chuỗi | Tên sự kiện. |
chữ ký | chuỗi \ |
|
address | chuỗi | Địa chỉ bắt nguồn sự kiện. |
returnValues | đối tượng | Các giá trị trả về đến từ sự kiện, ví dụ: {myVar: 1, myVar2: '0x234...'}. |
logIndex | số | Vị trí chỉ mục sự kiện trong khối. |
transactionIndex | số | Vị trí chỉ mục của giao dịch nơi sự kiện được tạo. |
transactionHash | chuỗi | Hàm băm của giao dịch mà sự kiện này được tạo. |
blockHash | chuỗi | Hàm băm của khối mà sự kiện này đã được tạo in. null khi nó vẫn đang chờ xử lý. |
blockNumber | số | Số khối mà bản ghi này đã được tạo in. null khi vẫn đang chờ xử lý. |
raw | đối tượng | Một đối tượng xác định |
Ví dụ
Last updated