CU-86drpne8x - Implement changes on ContractInvocation format to allo…

…w adding witnesses

common/changes/@cityofzion/neon-dappkit/CU-86drpne8x_2024-03-18-13-29.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/neon-dappkit",
+      "comment": "Update invokeFunction and signTransaction to add smart contract witnesses when the signer is not an account used on the construtor",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@cityofzion/neon-dappkit"
+}

packages/neon-dappkit/src/NeonInvoker.spec.ts

@@ -203,6 +203,151 @@ describe('NeonInvoker', function () {
     await wait(15000)
   })
 
+  it('can sign and invoke with signingCallback using different NeonInvokers/accounts', async () => {
+    const accountSignCallback = new wallet.Account('02eecb8c0c3ae4e3c65457581c8c8dc0ecf52f74953166ce84d3c5b67a42a1ee73')
+    const privateAccount = new wallet.Account('3bd06d95e9189385851aa581d182f25de34af759cf7f883af57030303ded52b8')
+
+    const accountSignPrivKey = new wallet.Account('fb1f57cc1347ae5b6251dc8bae761362d2ecaafec4c87f4dc9e97fef6dd75014') // NbnjKGMBJzJ6j5PHeYhjJDaQ5Vy5UYu4Fv
+
+    const invokerSignCallback = await NeonInvoker.init({
+      rpcAddress: NeonInvoker.TESTNET,
+      signingCallback: async (transaction, details) => {
+        const hex = NeonParser.numToHex(details.network, 4, true) + NeonParser.reverseHex(transaction.hash())
+        return wallet.sign(hex, privateAccount.privateKey)
+      },
+      account: accountSignCallback,
+    })
+
+    const invokerSignPrivKey = await NeonInvoker.init({
+      rpcAddress: NeonInvoker.TESTNET,
+      account: accountSignPrivKey,
+    })
+
+    let bt = await invokerSignCallback.signTransaction({
+      invocations: [
+        {
+          scriptHash: '0xd2a4cff31913016155e38e474a2c06d08be276cf',
+          operation: 'transfer',
+          args: [
+            { type: 'Hash160', value: accountSignCallback.address },
+            { type: 'Hash160', value: accountSignPrivKey.address },
+            { type: 'Integer', value: '100000000' },
+            { type: 'Array', value: [] },
+          ],
+        },
+      ],
+      signers: [
+        {
+          account: accountSignCallback.scriptHash,
+          scopes: 'CalledByEntry',
+        },
+        {
+          account: accountSignPrivKey.scriptHash,
+          scopes: 'CalledByEntry',
+        },
+      ],
+    })
+
+    let txId = await invokerSignPrivKey.invokeFunction(bt)
+
+    assert(txId.length > 0, 'has txId')
+
+    await wait(15000)
+
+    bt = await invokerSignPrivKey.signTransaction({
+      invocations: [
+        {
+          scriptHash: '0xd2a4cff31913016155e38e474a2c06d08be276cf',
+          operation: 'transfer',
+          args: [
+            { type: 'Hash160', value: accountSignPrivKey.address },
+            { type: 'Hash160', value: accountSignCallback.address },
+            { type: 'Integer', value: '100000000' },
+            { type: 'Array', value: [] },
+          ],
+        },
+      ],
+      signers: [
+        {
+          account: accountSignPrivKey.scriptHash,
+          scopes: 'CalledByEntry',
+        },
+        {
+          account: accountSignCallback.scriptHash,
+          scopes: 'CalledByEntry',
+        },
+      ],
+    })
+
+    txId = await invokerSignCallback.invokeFunction(bt)
+
+    assert(txId.length > 0, 'has txId')
+
+    await wait(15000)
+  })
+
+  it('add accounts and witnesses to verify smart contracts', async () => {
+    const account = new wallet.Account('3bd06d95e9189385851aa581d182f25de34af759cf7f883af57030303ded52b8')
+    const invoker = await NeonInvoker.init({
+      rpcAddress: NeonInvoker.TESTNET,
+      account,
+    })
+
+    // A smart contract that always return True on verify
+    const verifyTrueSmartContract = '0x7aa88cc764b80cae2267d4fdf63cd09f7e9baeba'
+
+    // NeoToken smart contract, we are not verified
+    const verifyFalseSmartContract = '0xef4073a0f2b305a38ec4050e4d3d28bc40ea63f5'
+
+    const txIdVerifyTrue = await invoker.invokeFunction({
+      invocations: [
+        {
+          scriptHash: '0xd2a4cff31913016155e38e474a2c06d08be276cf',
+          operation: 'totalSupply',
+          args: [],
+        },
+      ],
+      signers: [
+        {
+          account: account.scriptHash,
+          scopes: 'CalledByEntry',
+        },
+        {
+          account: verifyTrueSmartContract,
+          scopes: 'CalledByEntry',
+        },
+      ],
+    })
+
+    assert(txIdVerifyTrue.length > 0, 'has txId')
+
+    await assert.rejects(
+      invoker.invokeFunction({
+        invocations: [
+          {
+            scriptHash: '0xd2a4cff31913016155e38e474a2c06d08be276cf',
+            operation: 'totalSupply',
+            args: [],
+          },
+        ],
+        signers: [
+          {
+            account: account.scriptHash,
+            scopes: 'CalledByEntry',
+          },
+          {
+            account: verifyFalseSmartContract,
+            scopes: 'CalledByEntry',
+          },
+        ],
+      }),
+      {
+        name: 'Error',
+        message: 'Invalid',
+      },
+    )
+  })
+
   it("can throw an error if the signed transaction doesn't match the invocation", async () => {
     const accountPayer = new wallet.Account('fb1f57cc1347ae5b6251dc8bae761362d2ecaafec4c87f4dc9e97fef6dd75014') // NbnjKGMBJzJ6j5PHeYhjJDaQ5Vy5UYu4Fv
     const accountOwner = new wallet.Account('3bd06d95e9189385851aa581d182f25de34af759cf7f883af57030303ded52b8') // NhGomBpYnKXArr55nHRQ5rzy79TwKVXZbr

packages/neon-dappkit/src/NeonInvoker.ts

@@ -203,27 +203,37 @@ export class NeonInvoker implements Neo3Invoker {
     transaction: NeonTypes.tx.Transaction,
     accountArr: NeonTypes.wallet.Account[],
   ): Promise<NeonTypes.tx.Transaction> {
-    let txClone = new tx.Transaction(transaction)
-
-    for (const account of accountArr) {
-      if (this.options.signingCallback) {
-        transaction.addWitness(
-          new tx.Witness({
-            invocationScript: '',
-            verificationScript: wallet.getVerificationScriptFromPublicKey(account.publicKey),
-          }),
-        )
-
-        const facade = await api.NetworkFacade.fromConfig({
-          node: this.options.rpcAddress,
-        })
+    const txClone = new tx.Transaction(transaction)
 
-        txClone = await facade.sign(transaction, {
-          signingCallback: this.options.signingCallback,
-        })
-      } else {
-        txClone.sign(account, this.options.networkMagic)
+    let signerIndex = 0
+    for (const signer of txClone.signers) {
+      for (const account of accountArr) {
+        if (signer.account.equals(account.scriptHash)) {
+          let txCopy = new tx.Transaction(transaction)
+          txCopy.witnesses = []
+
+          if (this.options.signingCallback) {
+            txCopy.addWitness(
+              new tx.Witness({
+                invocationScript: '',
+                verificationScript: wallet.getVerificationScriptFromPublicKey(account.publicKey),
+              }),
+            )
+
+            const facade = await api.NetworkFacade.fromConfig({
+              node: this.options.rpcAddress,
+            })
+
+            txCopy = await facade.sign(txCopy, {
+              signingCallback: this.options.signingCallback,
+            })
+          } else {
+            txCopy.sign(account, this.options.networkMagic)
+          }
+          txClone.witnesses[signerIndex] = txCopy.witnesses[0]
+        }
       }
+      signerIndex++
     }
 
     return txClone
@@ -268,6 +278,7 @@ export class NeonInvoker implements Neo3Invoker {
     const networkFee = await this.getNetworkFee(cimOrBt, rpcClient, accountArr, transaction)
     transaction.networkFee = networkFee
     transaction.systemFee = systemFee
+    transaction.witnesses = signers.map(() => tx.Witness.fromJson({ invocation: '', verification: '' }))
 
     return transaction
   }