@algorandfoundation/algokit-utils 8.2.0-beta.2 → 8.2.0

package/types/composer.js

@@ -20,6 +20,7 @@ class TransactionComposer {
     /**
      * Create a `TransactionComposer`.
      * @param params The configuration for this composer
+     * @returns The `TransactionComposer` instance
      */
     constructor(params) {
         /** The ATC used to compose the group */
@@ -47,6 +48,10 @@ class TransactionComposer {
      * @param transaction The pre-built transaction
      * @param signer Optional signer override for the transaction
      * @returns The composer so you can chain method calls
+     * @example
+     * ```typescript
+     * composer.addTransaction(txn)
+     * ```
      */
     addTransaction(transaction, signer) {
         this.txns.push({
@@ -60,6 +65,34 @@ class TransactionComposer {
      * Add a payment transaction to the transaction group.
      * @param params The payment transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addPayment({
+     *   sender: 'SENDERADDRESS',
+     *   receiver: 'RECEIVERADDRESS',
+     *   amount: (4).algo(),
+     * })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addPayment({
+     *   amount: (4).algo(),
+     *   receiver: 'RECEIVERADDRESS',
+     *   sender: 'SENDERADDRESS',
+     *   closeRemainderTo: 'CLOSEREMAINDERTOADDRESS',
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // Use this with caution, it's generally better to use algorand.account.rekeyAccount
+     *   rekeyTo: 'REKEYTOADDRESS',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
      */
     addPayment(params) {
         this.txns.push({ ...params, type: 'pay' });
@@ -69,6 +102,36 @@ class TransactionComposer {
      * Add an asset create transaction to the transaction group.
      * @param params The asset create transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAssetCreate({ sender: "CREATORADDRESS", total: 100n})
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAssetCreate({
+     *   sender: 'CREATORADDRESS',
+     *   total: 100n,
+     *   decimals: 2,
+     *   assetName: 'asset',
+     *   unitName: 'unit',
+     *   url: 'url',
+     *   metadataHash: 'metadataHash',
+     *   defaultFrozen: false,
+     *   manager: 'MANAGERADDRESS',
+     *   reserve: 'RESERVEADDRESS',
+     *   freeze: 'FREEZEADDRESS',
+     *   clawback: 'CLAWBACKADDRESS',
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
      */
     addAssetCreate(params) {
         this.txns.push({ ...params, type: 'assetCreate' });
@@ -78,6 +141,30 @@ class TransactionComposer {
      * Add an asset config transaction to the transaction group.
      * @param params The asset config transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAssetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAssetConfig({
+     *   sender: 'MANAGERADDRESS',
+     *   assetId: 123456n,
+     *   manager: 'MANAGERADDRESS',
+     *   reserve: 'RESERVEADDRESS',
+     *   freeze: 'FREEZEADDRESS',
+     *   clawback: 'CLAWBACKADDRESS',
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
      */
     addAssetConfig(params) {
         this.txns.push({ ...params, type: 'assetConfig' });
@@ -87,6 +174,29 @@ class TransactionComposer {
      * Add an asset freeze transaction to the transaction group.
      * @param params The asset freeze transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAssetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAssetFreeze({
+     *   sender: 'MANAGERADDRESS',
+     *   assetId: 123456n,
+     *   account: 'ACCOUNTADDRESS',
+     *   frozen: true,
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
+     * ```
      */
     addAssetFreeze(params) {
         this.txns.push({ ...params, type: 'assetFreeze' });
@@ -96,6 +206,27 @@ class TransactionComposer {
      * Add an asset destroy transaction to the transaction group.
      * @param params The asset destroy transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAssetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAssetDestroy({
+     *   sender: 'MANAGERADDRESS',
+     *   assetId: 123456n,
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
+     * ```
      */
     addAssetDestroy(params) {
         this.txns.push({ ...params, type: 'assetDestroy' });
@@ -105,6 +236,32 @@ class TransactionComposer {
      * Add an asset transfer transaction to the transaction group.
      * @param params The asset transfer transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAssetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" })
+     * ```
+     * @example Advanced example (with clawback)
+     * ```typescript
+     * composer.addAssetTransfer({
+     *   sender: 'CLAWBACKADDRESS',
+     *   assetId: 123456n,
+     *   amount: 1n,
+     *   receiver: 'RECEIVERADDRESS',
+     *   clawbackTarget: 'HOLDERADDRESS',
+     *   // This field needs to be used with caution
+     *   closeAssetTo: 'ADDRESSTOCLOSETO'
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
+     * ```
      */
     addAssetTransfer(params) {
         this.txns.push({ ...params, type: 'assetTransfer' });
@@ -114,6 +271,27 @@ class TransactionComposer {
      * Add an asset opt-in transaction to the transaction group.
      * @param params The asset opt-in transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAssetOptIn({ sender: "SENDERADDRESS", assetId: 123456n })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAssetOptIn({
+     *   sender: 'SENDERADDRESS',
+     *   assetId: 123456n,
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
+     * ```
      */
     addAssetOptIn(params) {
         this.txns.push({ ...params, type: 'assetOptIn' });
@@ -123,6 +301,33 @@ class TransactionComposer {
      * Add an asset opt-out transaction to the transaction group.
      * @param params The asset opt-out transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example (without creator, will be retrieved from algod)
+     * ```typescript
+     * composer.addAssetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true })
+     * ```
+     * @example Basic example (with creator)
+     * ```typescript
+     * composer.addAssetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAssetOptOut({
+     *   sender: 'SENDERADDRESS',
+     *   assetId: 123456n,
+     *   creator: 'CREATORADDRESS',
+     *   ensureZeroBalance: true,
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
+     * ```
      */
     addAssetOptOut(params) {
         this.txns.push({ ...params, type: 'assetOptOut' });
@@ -134,6 +339,47 @@ class TransactionComposer {
      * Note: we recommend using app clients to make it easier to make app calls.
      * @param params The application create transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAppCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAppCreate({
+     *  sender: 'CREATORADDRESS',
+     *  approvalProgram: "TEALCODE",
+     *  clearStateProgram: "TEALCODE",
+     *  schema: {
+     *    globalInts: 1,
+     *    globalByteSlices: 2,
+     *    localInts: 3,
+     *    localByteSlices: 4
+     *  },
+     *  extraProgramPages: 1,
+     *  onComplete: algosdk.OnApplicationComplete.OptInOC,
+     *  args: [new Uint8Array(1, 2, 3, 4)]
+     *  accountReferences: ["ACCOUNT_1"]
+     *  appReferences: [123n, 1234n]
+     *  assetReferences: [12345n]
+     *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+     *  lease: 'lease',
+     *  note: 'note',
+     *  // You wouldn't normally set this field
+     *  firstValidRound: 1000n,
+     *  validityWindow: 10,
+     *  extraFee: (1000).microAlgo(),
+     *  staticFee: (1000).microAlgo(),
+     *  // Max fee doesn't make sense with extraFee AND staticFee
+     *  //  already specified, but here for completeness
+     *  maxFee: (3000).microAlgo(),
+     *  // Signer only needed if you want to provide one,
+     *  //  generally you'd register it with AlgorandClient
+     *  //  against the sender and not need to pass it in
+     *  signer: transactionSigner,
+     *  maxRoundsToWaitForConfirmation: 5,
+     *  suppressLog: true,
+     *})
+     * ```
      */
     addAppCreate(params) {
         this.txns.push({ ...params, type: 'appCall' });
@@ -145,6 +391,34 @@ class TransactionComposer {
      * Note: we recommend using app clients to make it easier to make app calls.
      * @param params The application update transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAppUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAppUpdate({
+     *  sender: 'CREATORADDRESS',
+     *  approvalProgram: "TEALCODE",
+     *  clearStateProgram: "TEALCODE",
+     *  onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC,
+     *  args: [new Uint8Array(1, 2, 3, 4)]
+     *  accountReferences: ["ACCOUNT_1"]
+     *  appReferences: [123n, 1234n]
+     *  assetReferences: [12345n]
+     *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+     *  lease: 'lease',
+     *  note: 'note',
+     *  // You wouldn't normally set this field
+     *  firstValidRound: 1000n,
+     *  validityWindow: 10,
+     *  extraFee: (1000).microAlgo(),
+     *  staticFee: (1000).microAlgo(),
+     *  // Max fee doesn't make sense with extraFee AND staticFee
+     *  //  already specified, but here for completeness
+     *  maxFee: (3000).microAlgo(),
+     *})
+     * ```
      */
     addAppUpdate(params) {
         this.txns.push({ ...params, type: 'appCall', onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC });
@@ -156,6 +430,32 @@ class TransactionComposer {
      * Note: we recommend using app clients to make it easier to make app calls.
      * @param params The application delete transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAppDelete({ sender: 'CREATORADDRESS' })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAppDelete({
+     *  sender: 'CREATORADDRESS',
+     *  onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC,
+     *  args: [new Uint8Array(1, 2, 3, 4)]
+     *  accountReferences: ["ACCOUNT_1"]
+     *  appReferences: [123n, 1234n]
+     *  assetReferences: [12345n]
+     *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+     *  lease: 'lease',
+     *  note: 'note',
+     *  // You wouldn't normally set this field
+     *  firstValidRound: 1000n,
+     *  validityWindow: 10,
+     *  extraFee: (1000).microAlgo(),
+     *  staticFee: (1000).microAlgo(),
+     *  // Max fee doesn't make sense with extraFee AND staticFee
+     *  //  already specified, but here for completeness
+     *  maxFee: (3000).microAlgo(),
+     *})
+     * ```
      */
     addAppDelete(params) {
         this.txns.push({ ...params, type: 'appCall', onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC });
@@ -169,6 +469,32 @@ class TransactionComposer {
      * Note: we recommend using app clients to make it easier to make app calls.
      * @param params The application call transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addAppCall({ sender: 'CREATORADDRESS' })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addAppCall({
+     *  sender: 'CREATORADDRESS',
+     *  onComplete: algosdk.OnApplicationComplete.OptInOC,
+     *  args: [new Uint8Array(1, 2, 3, 4)]
+     *  accountReferences: ["ACCOUNT_1"]
+     *  appReferences: [123n, 1234n]
+     *  assetReferences: [12345n]
+     *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+     *  lease: 'lease',
+     *  note: 'note',
+     *  // You wouldn't normally set this field
+     *  firstValidRound: 1000n,
+     *  validityWindow: 10,
+     *  extraFee: (1000).microAlgo(),
+     *  staticFee: (1000).microAlgo(),
+     *  // Max fee doesn't make sense with extraFee AND staticFee
+     *  //  already specified, but here for completeness
+     *  maxFee: (3000).microAlgo(),
+     *})
+     * ```
      */
     addAppCall(params) {
         this.txns.push({ ...params, type: 'appCall' });
@@ -180,6 +506,53 @@ class TransactionComposer {
      * Note: we recommend using app clients to make it easier to make app calls.
      * @param params The ABI create method application call transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * const method = new ABIMethod({
+     *   name: 'method',
+     *   args: [{ name: 'arg1', type: 'string' }],
+     *   returns: { type: 'string' },
+     * })
+     * composer.addAppCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * const method = new ABIMethod({
+     *   name: 'method',
+     *   args: [{ name: 'arg1', type: 'string' }],
+     *   returns: { type: 'string' },
+     * })
+     * composer.addAppCreateMethodCall({
+     *  sender: 'CREATORADDRESS',
+     *  method: method,
+     *  args: ["arg1_value"],
+     *  approvalProgram: "TEALCODE",
+     *  clearStateProgram: "TEALCODE",
+     *  schema: {
+     *    globalInts: 1,
+     *    globalByteSlices: 2,
+     *    localInts: 3,
+     *    localByteSlices: 4
+     *  },
+     *  extraProgramPages: 1,
+     *  onComplete: algosdk.OnApplicationComplete.OptInOC,
+     *  args: [new Uint8Array(1, 2, 3, 4)]
+     *  accountReferences: ["ACCOUNT_1"]
+     *  appReferences: [123n, 1234n]
+     *  assetReferences: [12345n]
+     *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+     *  lease: 'lease',
+     *  note: 'note',
+     *  // You wouldn't normally set this field
+     *  firstValidRound: 1000n,
+     *  validityWindow: 10,
+     *  extraFee: (1000).microAlgo(),
+     *  staticFee: (1000).microAlgo(),
+     *  // Max fee doesn't make sense with extraFee AND staticFee
+     *  //  already specified, but here for completeness
+     *  maxFee: (3000).microAlgo(),
+     *})
+     * ```
      */
     addAppCreateMethodCall(params) {
         this.txns.push({ ...params, type: 'methodCall' });
@@ -191,6 +564,46 @@ class TransactionComposer {
      * Note: we recommend using app clients to make it easier to make app calls.
      * @param params The ABI update method application call transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * const method = new ABIMethod({
+     *   name: 'method',
+     *   args: [{ name: 'arg1', type: 'string' }],
+     *   returns: { type: 'string' },
+     * })
+     * composer.addAppUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * const method = new ABIMethod({
+     *   name: 'method',
+     *   args: [{ name: 'arg1', type: 'string' }],
+     *   returns: { type: 'string' },
+     * })
+     * composer.addAppUpdateMethodCall({
+     *  sender: 'CREATORADDRESS',
+     *  method: method,
+     *  args: ["arg1_value"],
+     *  approvalProgram: "TEALCODE",
+     *  clearStateProgram: "TEALCODE",
+     *  onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC,
+     *  args: [new Uint8Array(1, 2, 3, 4)]
+     *  accountReferences: ["ACCOUNT_1"]
+     *  appReferences: [123n, 1234n]
+     *  assetReferences: [12345n]
+     *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+     *  lease: 'lease',
+     *  note: 'note',
+     *  // You wouldn't normally set this field
+     *  firstValidRound: 1000n,
+     *  validityWindow: 10,
+     *  extraFee: (1000).microAlgo(),
+     *  staticFee: (1000).microAlgo(),
+     *  // Max fee doesn't make sense with extraFee AND staticFee
+     *  //  already specified, but here for completeness
+     *  maxFee: (3000).microAlgo(),
+     *})
+     * ```
      */
     addAppUpdateMethodCall(params) {
         this.txns.push({ ...params, type: 'methodCall', onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC });
@@ -202,6 +615,44 @@ class TransactionComposer {
      * Note: we recommend using app clients to make it easier to make app calls.
      * @param params The ABI delete method application call transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * const method = new ABIMethod({
+     *   name: 'method',
+     *   args: [{ name: 'arg1', type: 'string' }],
+     *   returns: { type: 'string' },
+     * })
+     * composer.addAppDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * const method = new ABIMethod({
+     *   name: 'method',
+     *   args: [{ name: 'arg1', type: 'string' }],
+     *   returns: { type: 'string' },
+     * })
+     * composer.addAppDeleteMethodCall({
+     *  sender: 'CREATORADDRESS',
+     *  method: method,
+     *  args: ["arg1_value"],
+     *  onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC,
+     *  args: [new Uint8Array(1, 2, 3, 4)]
+     *  accountReferences: ["ACCOUNT_1"]
+     *  appReferences: [123n, 1234n]
+     *  assetReferences: [12345n]
+     *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+     *  lease: 'lease',
+     *  note: 'note',
+     *  // You wouldn't normally set this field
+     *  firstValidRound: 1000n,
+     *  validityWindow: 10,
+     *  extraFee: (1000).microAlgo(),
+     *  staticFee: (1000).microAlgo(),
+     *  // Max fee doesn't make sense with extraFee AND staticFee
+     *  //  already specified, but here for completeness
+     *  maxFee: (3000).microAlgo(),
+     *})
+     * ```
      */
     addAppDeleteMethodCall(params) {
         this.txns.push({ ...params, type: 'methodCall', onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC });
@@ -213,6 +664,44 @@ class TransactionComposer {
      * Note: we recommend using app clients to make it easier to make app calls.
      * @param params The ABI method application call transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * const method = new ABIMethod({
+     *   name: 'method',
+     *   args: [{ name: 'arg1', type: 'string' }],
+     *   returns: { type: 'string' },
+     * })
+     * composer.addAppCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * const method = new ABIMethod({
+     *   name: 'method',
+     *   args: [{ name: 'arg1', type: 'string' }],
+     *   returns: { type: 'string' },
+     * })
+     * composer.addAppCallMethodCall({
+     *  sender: 'CREATORADDRESS',
+     *  method: method,
+     *  args: ["arg1_value"],
+     *  onComplete: algosdk.OnApplicationComplete.OptInOC,
+     *  args: [new Uint8Array(1, 2, 3, 4)]
+     *  accountReferences: ["ACCOUNT_1"]
+     *  appReferences: [123n, 1234n]
+     *  assetReferences: [12345n]
+     *  boxReferences: ["box1", {appId: 1234n, name: "box2"}]
+     *  lease: 'lease',
+     *  note: 'note',
+     *  // You wouldn't normally set this field
+     *  firstValidRound: 1000n,
+     *  validityWindow: 10,
+     *  extraFee: (1000).microAlgo(),
+     *  staticFee: (1000).microAlgo(),
+     *  // Max fee doesn't make sense with extraFee AND staticFee
+     *  //  already specified, but here for completeness
+     *  maxFee: (3000).microAlgo(),
+     *})
+     * ```
      */
     addAppCallMethodCall(params) {
         this.txns.push({ ...params, type: 'methodCall' });
@@ -222,6 +711,42 @@ class TransactionComposer {
      * Add an online key registration transaction to the transaction group.
      * @param params The online key registration transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addOnlineKeyRegistration({
+     *   sender: 'SENDERADDRESS',
+     *   voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')),
+     *   selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')),
+     *   stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')),
+     *   voteFirst: 1n,
+     *   voteLast: 1000n,
+     *   voteKeyDilution: 1n,
+     * })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addOnlineKeyRegistration({
+     *   sender: 'SENDERADDRESS',
+     *   voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')),
+     *   selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')),
+     *   stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')),
+     *   voteFirst: 1n,
+     *   voteLast: 1000n,
+     *   voteKeyDilution: 1n,
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // Use this with caution, it's generally better to use algorand.account.rekeyAccount
+     *   rekeyTo: 'REKEYTOADDRESS',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
+     * ```
      */
     addOnlineKeyRegistration(params) {
         this.txns.push({ ...params, type: 'keyReg' });
@@ -231,6 +756,30 @@ class TransactionComposer {
      * Add an offline key registration transaction to the transaction group.
      * @param params The offline key registration transaction parameters
      * @returns The composer so you can chain method calls
+     * @example Basic example
+     * ```typescript
+     * composer.addOfflineKeyRegistration({
+     *   sender: 'SENDERADDRESS',
+     * })
+     * ```
+     * @example Advanced example
+     * ```typescript
+     * composer.addOfflineKeyRegistration({
+     *   sender: 'SENDERADDRESS',
+     *   lease: 'lease',
+     *   note: 'note',
+     *   // Use this with caution, it's generally better to use algorand.account.rekeyAccount
+     *   rekeyTo: 'REKEYTOADDRESS',
+     *   // You wouldn't normally set this field
+     *   firstValidRound: 1000n,
+     *   validityWindow: 10,
+     *   extraFee: (1000).microAlgo(),
+     *   staticFee: (1000).microAlgo(),
+     *   // Max fee doesn't make sense with extraFee AND staticFee
+     *   //  already specified, but here for completeness
+     *   maxFee: (3000).microAlgo(),
+     * })
+     * ```
      */
     addOfflineKeyRegistration(params) {
         this.txns.push({ ...params, type: 'keyReg' });
@@ -240,6 +789,12 @@ class TransactionComposer {
      * Add the transactions within an `AtomicTransactionComposer` to the transaction group.
      * @param atc The `AtomicTransactionComposer` to build transactions from and add to the group
      * @returns The composer so you can chain method calls
+     * @example
+     * ```typescript
+     * const atc = new AtomicTransactionComposer()
+     *   .addPayment({ sender: 'SENDERADDRESS', receiver: 'RECEIVERADDRESS', amount: 1000n })
+     * composer.addAtc(atc)
+     * ```
      */
     addAtc(atc) {
         this.txns.push({ atc, type: 'atc' });
@@ -645,6 +1200,10 @@ class TransactionComposer {
      * Compose all of the transactions without signers and return the transaction objects directly along with any ABI method calls.
      *
      * @returns The array of built transactions and any corresponding method calls
+     * @example
+     * ```typescript
+     * const { transactions, methodCalls, signers } = await composer.buildTransactions()
+     * ```
      */
     async buildTransactions() {
         const suggestedParams = await this.getSuggestedParams();
@@ -678,6 +1237,7 @@ class TransactionComposer {
     }
     /**
      * Get the number of transactions currently added to this composer.
+     * @returns The number of transactions currently added to this composer
      */
     async count() {
         return (await this.buildTransactions()).transactions.length;
@@ -689,7 +1249,11 @@ class TransactionComposer {
      *
      * Once this method is called, no further transactions will be able to be added.
      * You can safely call this method multiple times to get the same result.
-     * @returns The built atomic transaction composer and the transactions
+     * @returns The built atomic transaction composer, the transactions and any corresponding method calls
+     * @example
+     * ```typescript
+     * const { atc, transactions, methodCalls } = await composer.build()
+     * ```
      */
     async build() {
         if (this.atc.getStatus() === algosdk.AtomicTransactionComposerStatus.BUILDING) {
@@ -719,6 +1283,10 @@ class TransactionComposer {
      * Rebuild the group, discarding any previously built transactions.
      * This will potentially cause new signers and suggested params to be used if the callbacks return a new value compared to the first build.
      * @returns The newly built atomic transaction composer and the transactions
+     * @example
+     * ```typescript
+     * const { atc, transactions, methodCalls } = await composer.rebuild()
+     * ```
      */
     async rebuild() {
         this.atc = new algosdk.AtomicTransactionComposer();
@@ -728,6 +1296,12 @@ class TransactionComposer {
      * Compose the atomic transaction group and send it to the network.
      * @param params The parameters to control execution with
      * @returns The execution result
+     * @example
+     * ```typescript
+     * const result = await composer.send({
+     *   populateAppCallResources: true,
+     * })
+     * ```
      */
     async send(params) {
         const group = (await this.build()).transactions;