search

hyperledger-caliper / caliper

A blockchain benchmark framework to measure performance of multiple blockchain solutions https://wiki.hyperledger.org/display/caliper
https://hyperledger-caliper.github.io/caliper/
Apache License 2.0
655 stars 404 forks source link

Workload implementation documentation looks incorrect and incomplete #1507

Open davidkel opened 1 year ago

davidkel commented 1 year ago

Looking at the documentation here https://hyperledger.github.io/caliper/v0.5.0/workload-module/#submittransaction

It refers to an api call invokeSmartContract yet this api doesn't exist. The api call on an sut adapter is sendRequests and this is not even mentioned. It also needs to provide details of what is returned which means documenting the TxStatus class the contains information about the result of the requests. Finally there is no guidance on how to handle thrown errors and how a workload module should handle these (if at all). If you send multiple requests what happens if one of those results in an error being thrown ? Not sure the code for doing this is consistent with what just sending a single request does see https://github.com/hyperledger/caliper/blob/8cef10ccce9d75397152b2d37af2ea40699cd645/packages/caliper-core/lib/common/core/connector-base.js#L77

vinayakjaas commented 7 months ago

@davidkel In documentation for Hyperledger Caliper v0.5.0, we noticed a reference to an invokeSmartContract API call. However, upon further investigation, we couldn't find this API in the codebase. Could you please confirm if this is an error in the documentation or if the API has been deprecated or renamed?

davidkel commented 1 week ago

@vinayakjaas This is what this issue is about invokeSmartContract definitely does not exist and the documentation needs to be fixed