Merge pull request #347 from algorandfoundation/v7-fix-factory-signer

fix: some signing and simulate issues

.github/workflows/pr.yml

@@ -2,7 +2,7 @@ name: Pull Request
 
 on:
   pull_request:
-    branches: [main]
+    branches: [main, main-v7]
 
 permissions:
   contents: read

.github/workflows/release.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - main
       - release
+      - 7.x.x
   workflow_dispatch:
 
 concurrency: release

README.md

@@ -6,7 +6,7 @@ The goal of this library is to provide intuitive, productive utility functions t
 
 Note: If you prefer Python there's an equivalent [Python utility library](https://github.com/algorandfoundation/algokit-utils-py).
 
-[Install](#install) | [Documentation](docs/README.md)
+[Install](#install) | [Documentation](./docs/README.md)
 
 ## Install
 

docs/capabilities/transaction-composer.md

@@ -33,10 +33,57 @@ The [methods to construct a transaction](../code/classes/types_composer.default.
 For example:
 
 ```typescript
-const result = algorand.addPayment({ sender: 'SENDER', receiver: 'RECEIVER', amount: (100).microAlgo() }).addAppCallMethodCall({
-  sender: 'SENDER',
-  appId: 123n,
-  method: abiMethod,
-  args: [1, 2, 3],
-}).
+const result = algorand
+  .newGroup()
+  .addPayment({ sender: 'SENDER', receiver: 'RECEIVER', amount: (100).microAlgo() })
+  .addAppCallMethodCall({
+    sender: 'SENDER',
+    appId: 123n,
+    method: abiMethod,
+    args: [1, 2, 3],
+  })
+```
+
+## Simulating a transaction
+
+Transactions can be simulated using the simulate endpoint in algod, which enables evaluating the transaction on the network without it actually being commited to a block.
+This is a powerful feature, which has a number of options which are detailed in the [simulate API docs](https://developer.algorand.org/docs/rest-apis/algod/#post-v2transactionssimulate).
+
+For example you can simulate a transaction group like below:
+
+```typescript
+const result = await algorand
+  .newGroup()
+  .addPayment({ sender: 'SENDER', receiver: 'RECEIVER', amount: (100).microAlgo() })
+  .addAppCallMethodCall({
+    sender: 'SENDER',
+    appId: 123n,
+    method: abiMethod,
+    args: [1, 2, 3],
+  })
+  .simulate()
+```
+
+The above will execute a simulate request asserting that all transactions in the group are correctly signed.
+
+### Simulate without signing
+
+There are situations where you may not be able to (or want to) sign the transactions when executing simulate.
+In these instances you should set `skipSignatures: true` which automatically builds empty transaction signers and sets both `fix-signers` and `allow-empty-signatures` to `true` when sending the algod API call.
+
+For example:
+
+```typescript
+const result = await algorand
+  .newGroup()
+  .addPayment({ sender: 'SENDER', receiver: 'RECEIVER', amount: (100).microAlgo() })
+  .addAppCallMethodCall({
+    sender: 'SENDER',
+    appId: 123n,
+    method: abiMethod,
+    args: [1, 2, 3],
+  })
+  .simulate({
+    skipSignatures: true,
+  })
 ```

docs/code/classes/types_app_client.AppClient.md

@@ -1064,7 +1064,7 @@ ___
 ▸ **getSigner**(`sender`, `signer`): `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)
 
 Returns the signer for a call, using the provided signer or the `defaultSigner`
-if no signer was provided and the call will use default sender
+if no signer was provided and the sender resolves to the default sender, the call will use default signer
 or `undefined` otherwise (so the signer is resolved from `AlgorandClient`)
 
 #### Parameters