Merge pull request #972 from EOSIO/feature_adjustments

Feature adjustments to resource payer and read only

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 .idea
+.vscode
 dist/
 dist-web/
 node_modules/

docs/how-to-guides/20_how-to-set-a-payer.md

@@ -1,4 +1,4 @@
-After the release of v2.2 of nodeos, the transaction sponsorship feature is available to sponsor the resources for a transaction.  To set a separate payer for the resources for a transaction, add a `resource_payer` object to your transaction that specifies the `payer`, `max_net_bytes`, `max_cpu_us`, and `max_memory_bytes`.  This functionality requires the `RESOURCE_PAYER` feature to be enabled on the chain.
+After the release of v2.2 of nodeos, the resource payer feature is available to sponsor the resources for a transaction.  To set a separate payer for the resources for a transaction, add a `resource_payer` object to your transaction that specifies the `payer`, `max_net_bytes`, `max_cpu_us`, and `max_memory_bytes`.  This functionality requires the `RESOURCE_PAYER` protocol feature to be enabled on the chain.
 
 A typical use-case for this feature has a service or application pay for the resources of a transaction instead of their users. Since authorization is required for both the user in the transaction and the payer, a possible workflow would have the transaction signed by the user's wallet application and then also signed by the service/application before sent to nodeos.
 

package.json

@@ -44,15 +44,15 @@
     "crypto-browserify": "^3.12.0",
     "cypress": "^7.6.0",
     "eosjs-ecc": "^4.0.7",
-    "eslint": "^7.29.0",
+    "eslint": "^7.30.0",
     "jest": "^26.6.3",
     "jest-extended": "^0.11.5",
     "jest-fetch-mock": "^3.0.3",
     "rimraf": "^3.0.2",
     "ts-jest": "^26.5.6",
     "ts-loader": "^9.2.3",
     "typescript": "^4.3.5",
-    "webpack": "^5.41.1",
+    "webpack": "^5.42.1",
     "webpack-cli": "^4.7.2"
   },
   "jest": {

src/eosjs-api-interfaces.ts

@@ -74,9 +74,9 @@ export interface SignatureProvider {
 
 export interface ResourcePayer {
     payer: string;
-    max_net_bytes: number|string;
-    max_cpu_us: number|string;
-    max_memory_bytes: number|string;
+    max_net_bytes: number;
+    max_cpu_us: number;
+    max_memory_bytes: number;
 }
 
 export interface Transaction {

src/eosjs-api.ts

@@ -250,6 +250,9 @@ export class Api {
             extensionBuffer.pushArray(ser.hexToUint8Array(extensionData[1]));
             const deserializedObj = types.get(transactionExtension.type).deserialize(extensionBuffer);
             if (extensionData[0] === 1) {
+                deserializedObj.max_net_bytes = Number(deserializedObj.max_net_bytes);
+                deserializedObj.max_cpu_us = Number(deserializedObj.max_cpu_us);
+                deserializedObj.max_memory_bytes = Number(deserializedObj.max_memory_bytes);
                 transaction.resource_payer = deserializedObj;
             }
         });
@@ -390,14 +393,18 @@ export class Api {
             });
         }
         if (broadcast) {
-            let result;
-            if (readOnlyTrx) {
-                return this.rpc.push_ro_transaction(pushTransactionArgs, returnFailureTraces) as Promise<ReadOnlyTransactResult>;
-            }
             if (compression) {
-                return this.pushCompressedSignedTransaction(pushTransactionArgs) as Promise<TransactResult>;
+                return this.pushCompressedSignedTransaction(
+                    pushTransactionArgs,
+                    readOnlyTrx,
+                    returnFailureTraces,
+                ) as Promise<TransactResult|ReadOnlyTransactResult>;
             }
-            return this.pushSignedTransaction(pushTransactionArgs) as Promise<TransactResult>;
+            return this.pushSignedTransaction(
+                pushTransactionArgs,
+                readOnlyTrx,
+                returnFailureTraces,
+            ) as Promise<TransactResult|ReadOnlyTransactResult>;
         }
         return pushTransactionArgs as PushTransactionArgs;
     }
@@ -462,8 +469,17 @@ export class Api {
 
     /** Broadcast a signed transaction */
     public async pushSignedTransaction(
-        { signatures, serializedTransaction, serializedContextFreeData }: PushTransactionArgs
-    ): Promise<TransactResult> {
+        { signatures, serializedTransaction, serializedContextFreeData }: PushTransactionArgs,
+        readOnlyTrx = false,
+        returnFailureTraces = false,
+    ): Promise<TransactResult|ReadOnlyTransactResult> {
+        if (readOnlyTrx) {
+            return this.rpc.push_ro_transaction({
+                signatures,
+                serializedTransaction,
+                serializedContextFreeData,
+            }, returnFailureTraces);
+        }
         return this.rpc.push_transaction({
             signatures,
             serializedTransaction,
@@ -472,12 +488,22 @@ export class Api {
     }
 
     public async pushCompressedSignedTransaction(
-        { signatures, serializedTransaction, serializedContextFreeData }: PushTransactionArgs
-    ): Promise<TransactResult> {
+        { signatures, serializedTransaction, serializedContextFreeData }: PushTransactionArgs,
+        readOnlyTrx = false,
+        returnFailureTraces = false,
+    ): Promise<TransactResult|ReadOnlyTransactResult> {
         const compressedSerializedTransaction = this.deflateSerializedArray(serializedTransaction);
         const compressedSerializedContextFreeData =
             this.deflateSerializedArray(serializedContextFreeData || new Uint8Array(0));
 
+        if (readOnlyTrx) {
+            return this.rpc.push_ro_transaction({
+                signatures,
+                compression: 1,
+                serializedTransaction: compressedSerializedTransaction,
+                serializedContextFreeData: compressedSerializedContextFreeData
+            }, returnFailureTraces);
+        }
         return this.rpc.push_transaction({
             signatures,
             compression: 1,

src/tests/eosjs-api.test.ts

@@ -329,18 +329,18 @@ describe('eosjs-api', () => {
                 context_free_actions: [] as any,
                 resource_payer: {
                     payer: 'payer',
-                    max_net_bytes: '4096',
-                    max_cpu_us: '250',
-                    max_memory_bytes: '0'
+                    max_net_bytes: 4096,
+                    max_cpu_us: 250,
+                    max_memory_bytes: 0
                 }
             };
             const serialized = [[1, '0000000080ABBCA90010000000000000FA000000000000000000000000000000']];
             const deserialized = {
                 resource_payer: {
                     payer: 'payer',
-                    max_net_bytes: '4096',
-                    max_cpu_us: '250',
-                    max_memory_bytes: '0'
+                    max_net_bytes: 4096,
+                    max_cpu_us: 250,
+                    max_memory_bytes: 0
                 }
             };
 

src/tests/node.js

@@ -222,25 +222,23 @@ const readOnlyQuery = async () => {
     }, {
         blocksBehind: 3,
         expireSeconds: 30,
+        compression: true,
         readOnlyTrx: true,
-        returnFailureTraces: true,
     });
 };
 
 const readOnlyFailureTrace = async () => {
     return await api.transact({
         actions: [{
-            account: 'eosio.token',
-            name: 'transfer',
+            account: 'eosio',
+            name: 'setpriv',
             authorization: [{
-                actor: 'alice',
+                actor: 'bob',
                 permission: 'active',
             }],
             data: {
-                from: 'alice',
-                to: 'bob',
-                quantity: '2000000.0000 SYS',
-                memo: 'failureTrace',
+                account: 'bob',
+                is_priv: '1'
             },
         }]
     }, {

src/tests/node.test.ts

@@ -122,14 +122,12 @@ describe('Node JS environment', () => {
     });
 
     it('returns failure trace for failed transaction', async () => {
-        let err;
         try {
             await tests.readOnlyFailureTrace();
         } catch (e) {
-            err = e.details;
+            expect(e.details.code).toEqual(3090004);
+            expect(e.details.stack[0].format).toEqual('missing authority of ${account}');
         }
-        expect(err.code).toEqual(3050003);
-        expect(err.stack[0].data.s).toEqual('overdrawn balance');
     });
 
     it('throws appropriate error message without configuration object or TAPOS in place', async () => {

src/tests/web.html

@@ -544,6 +544,7 @@
               }, {
                   blocksBehind: 3,
                   expireSeconds: 30,
+                  compression: true,
                   readOnlyTrx: true,
               });
             }
@@ -583,20 +584,18 @@
 
             const readOnlyFailureTrace = async () => {
               return await api.transact({
-                  actions: [{
-                      account: 'eosio.token',
-                      name: 'transfer',
-                      authorization: [{
-                          actor: 'alice',
-                          permission: 'active',
-                      }],
-                      data: {
-                          from: 'alice',
-                          to: 'bob',
-                          quantity: '2000000.0000 SYS',
-                          memo: 'failureTrace',
-                      },
-                  }]
+                actions: [{
+                    account: 'eosio',
+                    name: 'setpriv',
+                    authorization: [{
+                        actor: 'bob',
+                        permission: 'active',
+                    }],
+                    data: {
+                        account: 'bob',
+                        is_priv: '1'
+                    },
+                }]
               }, {
                   blocksBehind: 3,
                   expireSeconds: 30,
@@ -613,8 +612,7 @@
               try {
                 await readOnlyFailureTrace();
               } catch (err) {
-                console.log(err);
-                if (err.details.code === 3050003 && err.details.stack[0].data.s === 'overdrawn balance') {
+                if (err.details.code === 3090004 && err.details.stack[0].format === 'missing authority of ${account}') {
                     resultsLabel.className = "success";
                     resultsLabel.innerText = SUCCESS;
                     return true;