Support for Read Only Transactions #963

bradlhart · 2021-06-16T18:00:28Z

Change Description

Adds support for Read Only Transactions and the return failure traces option (exclusive to read only transactions for now). Additionally changes the RPCError object to include a details variable that includes the error object for responses.

API Changes

API Changes

transact option readOnlyTrx
transact option returnFailureTraces

Documentation Additions

Documentation Additions

Section about read only transactions, returnFailureTraces, and a new page about RPCError

bradlhart · 2021-06-21T18:24:30Z

src/eosjs-jsonrpc.ts

@@ -93,6 +96,7 @@ export class JsonRpc implements AuthorityProvider, AbiProvider {
        if (!response.ok) {
            throw new RpcError(json);
        }
+        // check each return value for every action for an error and call `new RpcError`?


Delete this comment

halsaphi · 2021-06-30T07:58:23Z

docs/how-to-guides/01_how-to-submit-a-transaction.md

@@ -133,3 +133,8 @@ By providing that function inside `tx.associateContextFree()`, the transaction o

 #### Return Values
 From nodeos version 2.1, the ability to receive return values from smart contracts to eosjs has been introduced.  In the above examples, the `transaction` object will include the values `transaction_id` and the `processed` object.  If your smart contract returns values, you will be able to find the values within the `transaction.processed.action_traces` array.  The order of the `action_traces` array matches the order of actions in your transaction and within those `action_trace` objects, you can find your deserialized return value for your action in the `return_value` field.
+
+### Read-Only Transactions
+Adding `readOnlyTrx` to the `transact` config will send the transaction through the `push_ro_transaction` endpoint in the `chain_api`.  This endpoint will ensure that the transaction will not make any changes despite the actions in the transaction.  It is typically useful for doing queries using actions but normal actions will also work with this endpoint, but they won't make changes.


Maybe:

This endpoint will ensure that the transaction will not make any changes despite the actions in the transaction. It is typically useful for doing queries using actions but normal actions will also work with this endpoint, but they won't make changes.

to ->

The push_ro_transaction endpoint does not allow the transaction to make any data changes despite the actions in the transaction. The push_ro_transaction endpoint may also be used to call normal actions, though the actions will not make any data changes. => what if you call an action that does make changes - is this rolled back? Perhaps explicitly state what happens in this case <=

maybe start the ### Read-Only Transactions paragraph with:
From nodeos version 2.2, read-only queries have been introduced to eosjs. Adding readOnlyTrx to the transact config ... etc

Maybe:

This endpoint will ensure that the transaction will not make any changes despite the actions in the transaction. It is typically useful for doing queries using actions but normal actions will also work with this endpoint, but they won't make changes.

to ->

The push_ro_transaction endpoint does not allow the transaction to make any data changes despite the actions in the transaction. The push_ro_transaction endpoint may also be used to call normal actions, though the actions will not make any data changes. => what if you call an action that does make changes - is this rolled back? Perhaps explicitly state what happens in this case <=

It is rolled back, so I changed your adjustments slightly to state that.

halsaphi · 2021-06-30T08:03:10Z

docs/how-to-guides/01_how-to-submit-a-transaction.md

+### Read-Only Transactions
+Adding `readOnlyTrx` to the `transact` config will send the transaction through the `push_ro_transaction` endpoint in the `chain_api`.  This endpoint will ensure that the transaction will not make any changes despite the actions in the transaction.  It is typically useful for doing queries using actions but normal actions will also work with this endpoint, but they won't make changes.
+
+Adding `returnFailureTraces` to the `transact` config will return a trace of the failure if your transaction fails.  At this time, this is only available for read-only transactions.


Maybe:

Adding returnFailureTraces to the transact config will return a trace of the failure if your transaction fails. At this time, this is only available for read-only transactions.

to =>

Adding returnFailureTraces to the transact config enables the return of a trace message if your transaction fails. At this time, this is only available for read-only transactions. => what happens if you add this to a push_ro_transaction that is calling a non read only action - is nothing returned?.

I changed your changes slightly to state that it is only available for the push_ro_transaction endpoint.

halsaphi · 2021-06-30T08:04:18Z

docs/troubleshooting/02_rpcerror.md

@@ -0,0 +1,72 @@
+When a call to the chain_api is performed and fails, it will result in an RPCError object being generated to inform why the transaction failed.


maybe:

When a call to the chain_api is performed and fails, it will result in an RPCError object being generated to inform why the transaction failed.

to =>

When a call to the chain_api is performed and fails, it will result in an RPCError object being generated which contains information on why the transaction failed.

halsaphi · 2021-06-30T08:10:29Z

docs/troubleshooting/02_rpcerror.md

@@ -0,0 +1,72 @@
+When a call to the chain_api is performed and fails, it will result in an RPCError object being generated to inform why the transaction failed.
+
+The RPCError object will error with the concise message, for instance 'Invalid transaction', but additional details can be found in both the `details` field and the `json` field.  The `json` field holds the entire json response from `nodeos` while the `details` field specifically holds the error object in the `json`.  This is typically in different places of the `json` depending on what endpoint is used in `nodeos` so the `details` field is available to quickly see the error information without needing to search through the `json` object.


maybe

The RPCError object will error with the concise message, for instance 'Invalid transaction', but additional details can be found in both the details field and the json field. The json field holds the entire json response from nodeos while the details field specifically holds the error object in the json. This is typically in different places of the json depending on what endpoint is used in nodeos so the details field is available to quickly see the error information without needing to search through the json object.

to =>

The RPCError object will contain a concise error message, for instance 'Invalid transaction'. However additional details can be found in the details field and the json field. The json field holds the complete json response from nodeos. The details field specifically holds the error object in the json field. The data content of the json and ``detailsvary depending on the endpoint is used to callnodeos`. Use the `details` field to quickly find error information.

halsaphi · 2021-06-30T08:24:14Z

docs/troubleshooting/02_rpcerror.md

+
+The RPCError object will error with the concise message, for instance 'Invalid transaction', but additional details can be found in both the `details` field and the `json` field.  The `json` field holds the entire json response from `nodeos` while the `details` field specifically holds the error object in the `json`.  This is typically in different places of the `json` depending on what endpoint is used in `nodeos` so the `details` field is available to quickly see the error information without needing to search through the `json` object.
+
+As you can see below, the concise error message might not give enough information to really discern the issue.  While the error has `eosio_assert_message assertion failure` as the concise error, in the `details` field the `overdrawn balance` error mentioned.  It's important to note that the format of the `details` object can be different depending on what endpoint is used.


Maybe

As you can see below, the concise error message might not give enough information to really discern the issue. While the error has eosio_assert_message assertion failure as the concise error, in the details field the overdrawn balance error mentioned. It's important to note that the format of the details object can be different depending on what endpoint is used.

to =>

In the details and json examples below, you can see that the error message may not contain enough information to discern what caused the action to fail. The error message contains eosio_assert_message assertion failure. Looking further at the details you can see an overdrawn balance message.

It's important to note that the format of the details object can be different depending on what endpoint is used. => removed this bit as it is mentioned above. If you wanted to emphasise (or I have misunderstood) pwerhaps
=> Please note that the format of the details object will differ dependant on which endpoint is used.

=> as an additional thing - I think you choose the endpoint with the readOnlyTrx flag, is it worth mentioning the other endpoint explicitly and/or showing an example from calls to both endpoints -assuming there are two endpoints.

There are a large amount of different responses from nodeos, unfortunately it won't be easy to state all of them.

CI/CD changes for PRs #937/#963/#964 - merging per a request from Brad this is a bug with github actions, version 12.14.1 has been replaced by the v15.14.0 ones, can you override and merge it? It also might be because I have to copy the workflow files to master but I won't be certain until this one is merged Will be verified and can be reverted if something else breaks.

data is optional already in the type

Bradley Hart and others added 8 commits April 27, 2021 16:59

In progress changes

d4c35c2

Tests passing

f084bd4

Updating package.json and yarn.lock

b6966c2

Removing type changes for separate PR

6df4a34

Adjusting to renamed endpoint and additional changes

5b1bd49

Adjusting the type and adding returnFailureTraces to tests

3d35686

Merge branch 'develop' into read_only_queries

e29147a

Adding support for failure traces

093c437

bradlhart requested review from venu-block1 and praphael and removed request for venu-block1 June 16, 2021 18:02

bradlhart commented Jun 21, 2021

View reviewed changes

Removing comment

ac605ca

halsaphi reviewed Jun 30, 2021

View reviewed changes

Making requested changes

dd851d9

praphael approved these changes Jul 1, 2021

View reviewed changes

Brad Hart and others added 4 commits July 1, 2021 11:53

Merge branch 'develop' into read_only_queries

5597821

Adjusting data to be empty in the push_ro_transaction test

91fd1f7

data is optional already in the type

Adding bill_to_accounts to push_ro_transaction endpoint

11e3efe

Updating package.json and yarn.lock

c498592

bradlhart merged commit d0ab284 into develop Jul 1, 2021

bradlhart deleted the read_only_queries branch July 1, 2021 17:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for Read Only Transactions #963

Support for Read Only Transactions #963

bradlhart commented Jun 16, 2021

bradlhart Jun 21, 2021

halsaphi Jun 30, 2021

halsaphi Jun 30, 2021

bradlhart Jul 1, 2021

halsaphi Jun 30, 2021

bradlhart Jul 1, 2021 •

edited

halsaphi Jun 30, 2021

halsaphi Jun 30, 2021 •

edited

halsaphi Jun 30, 2021

bradlhart Jul 1, 2021

		@@ -0,0 +1,72 @@
		When a call to the chain_api is performed and fails, it will result in an RPCError object being generated to inform why the transaction failed.

		@@ -0,0 +1,72 @@
		When a call to the chain_api is performed and fails, it will result in an RPCError object being generated to inform why the transaction failed.

		The RPCError object will error with the concise message, for instance 'Invalid transaction', but additional details can be found in both the `details` field and the `json` field. The `json` field holds the entire json response from `nodeos` while the `details` field specifically holds the error object in the `json`. This is typically in different places of the `json` depending on what endpoint is used in `nodeos` so the `details` field is available to quickly see the error information without needing to search through the `json` object.


		The RPCError object will error with the concise message, for instance 'Invalid transaction', but additional details can be found in both the `details` field and the `json` field. The `json` field holds the entire json response from `nodeos` while the `details` field specifically holds the error object in the `json`. This is typically in different places of the `json` depending on what endpoint is used in `nodeos` so the `details` field is available to quickly see the error information without needing to search through the `json` object.

		As you can see below, the concise error message might not give enough information to really discern the issue. While the error has `eosio_assert_message assertion failure` as the concise error, in the `details` field the `overdrawn balance` error mentioned. It's important to note that the format of the `details` object can be different depending on what endpoint is used.

Support for Read Only Transactions #963

Support for Read Only Transactions #963

Conversation

bradlhart commented Jun 16, 2021

Change Description

API Changes

Documentation Additions

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradlhart Jul 1, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

halsaphi Jun 30, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradlhart Jul 1, 2021 •

edited

halsaphi Jun 30, 2021 •

edited