Docs executetx (#739)

* docs: update executeTx and deploy* docs

* add note about rekeyed accounts

Author: robert-zaremba

packages/algob/src/internal/deployer.ts

@@ -866,7 +866,9 @@ export class DeployerDeployMode extends DeployerBasicMode implements Deployer {
 	 * Note: If passing transaction object a signer/s must be provided.
 	 * @param transactions transaction parameters or atomic transaction parameters
 	 * https://github.com/scale-it/algo-builder/blob/docs/docs/guide/execute-transaction.md
-	 * or TransactionAndSign object(SDK transaction object and signer parameters)
+	 * or TransactionAndSign object(SDK transaction object and signer parameters).
+	 * If `ExecParams` are used, the deployer will connect to appropriate accounts / wallets to sign
+	 * constructed transactions.
 	 */
 	async executeTx(
 		transactions: wtypes.ExecParams[] | wtypes.TransactionAndSign[]

packages/algob/src/lib/tx.ts

@@ -275,7 +275,9 @@ export function signTransactions(txnAndSign: wtypes.TransactionAndSign[]): Uint8
  * @param deployer Deployer
  * @param transactions transaction parameters or atomic transaction parameters
  * https://github.com/scale-it/algo-builder/blob/docs/docs/guide/execute-transaction.md
- * or TransactionAndSign object(SDK transaction object and signer parameters)
+ * or TransactionAndSign object(SDK transaction object and signer parameters).
+ * If `ExecParams` are used, the deployer will connect to appropriate deployer accounts / wallets
+ * to sign constructed transactions.
  */
 export async function executeTx(
 	deployer: Deployer,

packages/algob/src/types.ts

@@ -443,7 +443,9 @@ export interface Deployer {
 	/**
 	 * Creates and deploys ASA defined in asa.yaml.
 	 * @name  ASA name - deployer will search for the ASA in the /assets/asa.yaml file
-	 * @flags  deployment flags */
+	 * @flags  deployment flags. Required.
+	 *   `flags.creator` must be defined - it's an account which will sign the constructed transaction.
+	 * NOTE: support for rekeyed accounts is limited (creator must have updated sk to properly sign transaction) */
 	deployASA: (
 		name: string,
 		flags: rtypes.ASADeploymentFlags,
@@ -455,7 +457,8 @@ export interface Deployer {
 	 * @name ASA name
 	 * @asaDef ASA definitions
 	 * @flags deployment flags
-	 */
+	 *   `flags.creator` must be defined - it's an account which will sign the constructed transaction.
+	 * NOTE: support for rekeyed accounts is limited (creator must have updated sk to properly sign transaction) */
 	deployASADef: (
 		name: string,
 		asaDef: wtypes.ASADef,
@@ -548,7 +551,8 @@ export interface Deployer {
 
 	/**
 	 * Deploys stateful smart contract.
-	 * @approvalProgram  approval program filename (must be present in assets folder)
+	 * @creator is the signer of the transaction.
+	 * @appDefinition is an object providing details about approval and clear program.
 	 * @clearProgram  clear program filename (must be present in assets folder)
 	 * @flags  AppDeploymentFlags
 	 * @payFlags  Transaction Parameters

packages/web/src/lib/web-mode.ts

@@ -147,7 +147,8 @@ export class WebMode {
 	/**
 	 * Execute single transaction or group of transactions (atomic transaction)
 	 * @param transactions transaction parameters, atomic transaction parameters
-	 * or TransactionAndSign object(SDK transaction object and signer parameters)
+	 * or TransactionAndSign object(SDK transaction object and signer parameters).
+	 * When list of ExecParams is used, the function will request wallet to sign transactions.
 	 */
 	async executeTx(
 		transactions: ExecParams[] | TransactionAndSign[]