Merge main into release

docs/code/modules/index.md

@@ -37,4 +37,4 @@ The result of this subscription pull/poll.
 
 #### Defined in
 
-[subscriptions.ts:58](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriptions.ts#L58)
+[subscriptions.ts:57](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriptions.ts#L57)

docs/subscriptions.md

@@ -340,7 +340,8 @@ If you ran the following code on a cron schedule of (say) every 5 seconds it wou
 it would drop old records and restart notifications from the new tip.
 
 ```typescript
-const algod = await algokit.getAlgoClient()
+const algorand = AlgorandClient.defaultLocalNet()
+
 // You would need to implement getLastWatermark() to retrieve from a persistence store
 const watermark = await getLastWatermark()
 const subscription = await getSubscribedTransactions(
@@ -357,7 +358,7 @@ const subscription = await getSubscribedTransactions(
     maxRoundsToSync: 100,
     onMaxRounds: 'skip-sync-newest',
   },
-  algod,
+  algorand.client.algod,
 )
 if (transactions.subscribedTransactions.length > 0) {
   // You would need to implement notifyTransactions to action the transactions
@@ -373,7 +374,7 @@ If you ran the following code on a cron schedule of (say) every 5 seconds it wou
 it would pick up where it left off and catch up using algod (note: you need to connect it to a archival node).
 
 ```typescript
-const algod = await algokit.getAlgoClient()
+const algorand = AlgorandClient.defaultLocalNet()
 // You would need to implement getLastWatermark() to retrieve from a persistence store
 const watermark = await getLastWatermark()
 const subscription = await getSubscribedTransactions(
@@ -390,7 +391,7 @@ const subscription = await getSubscribedTransactions(
     maxRoundsToSync: 100,
     onMaxRounds: 'sync-oldest-start-now',
   },
-  algod,
+  algorand.client.algod,
 )
 if (transactions.subscribedTransactions.length > 0) {
   // You would need to implement notifyTransactions to action the transactions
@@ -405,8 +406,7 @@ await saveWatermark(transactions.newWatermark)
 If you ran the following code on a cron schedule of (say) every 30 - 60 seconds it would create a cached index of all assets created by the account (in this case the Data History Museum TestNet account `ER7AMZRPD5KDVFWTUUVOADSOWM4RQKEEV2EDYRVSA757UHXOIEKGMBQIVU`). Given it uses indexer to catch up you can deploy this into a fresh environment with an empty database and it will catch up in seconds rather than days.
 
 ```typescript
-const algod = await algokit.getAlgoClient()
-const indexer = await algokit.getAlgoIndexerClient()
+const algorand = AlgorandClient.defaultLocalNet()
 // You would need to implement getLastWatermark() to retrieve from a persistence store
 const watermark = await getLastWatermark()
 const subscription = await getSubscribedTransactions(
@@ -425,8 +425,8 @@ const subscription = await getSubscribedTransactions(
     maxRoundsToSync: 1000,
     onMaxRounds: 'catchup-with-indexer',
   },
-  algod,
-  indexer,
+  algorand.client.algod,
+  algorand.client.indexer,
 )
 
 if (transactions.subscribedTransactions.length > 0) {

eslint.config.mjs

@@ -0,0 +1,42 @@
+import eslint from '@eslint/js'
+import prettier from 'eslint-config-prettier'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  {
+    ignores: ['.eslint.config.mjs', 'node_modules/**', 'dist/**', 'build/**', 'coverage/**', '**/*.d.ts', '.idea/**', '.vscode/**'],
+  },
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        project: './tsconfig.json',
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      'no-console': 'warn',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { ignoreRestSiblings: true, argsIgnorePattern: '^_', destructuredArrayIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+      '@typescript-eslint/no-unused-expressions': 'off',
+      'prefer-template': 'error',
+      'no-restricted-syntax': [
+        'error',
+        {
+          // Algosdk v2.x.x exports a malformed ES module and when using subscriber-ts in an ESM project
+          // the CJS module may be loaded, which may not fuly support all named exports.
+          // The easiest solution for now, is to only use the default export.
+          message: "Only use the default export in 'algosdk'. See rule comment for details",
+          selector: 'ImportDeclaration[source.value="algosdk"] ImportSpecifier',
+        },
+      ],
+    },
+  },
+  prettier,
+)

examples/data-history-museum/index.ts

@@ -1,4 +1,4 @@
-import * as algokit from '@algorandfoundation/algokit-utils'
+import { AlgorandClient } from '@algorandfoundation/algokit-utils'
 import { TransactionResult } from '@algorandfoundation/algokit-utils/types/indexer'
 import algosdk from 'algosdk'
 import fs from 'fs'
@@ -23,8 +23,8 @@ interface DHMAsset {
 }
 
 async function getDHMSubscriber() {
-  const algod = await algokit.getAlgoClient()
-  const indexer = await algokit.getAlgoIndexerClient()
+  const algorand = AlgorandClient.testNet()
+
   const subscriber = new AlgorandSubscriber(
     {
       filters: [
@@ -33,7 +33,7 @@ async function getDHMSubscriber() {
           filter: {
             type: TransactionType.acfg,
             // Data History Museum creator accounts
-            sender: (await algokit.isTestNet(algod))
+            sender: (await algorand.client.isTestNet())
               ? 'ER7AMZRPD5KDVFWTUUVOADSOWM4RQKEEV2EDYRVSA757UHXOIEKGMBQIVU'
               : 'EHYQCYHUC6CIWZLBX5TDTLVJ4SSVE4RRTMKFDCG4Z4Q7QSQ2XWIQPMKBPU',
           },
@@ -47,8 +47,8 @@ async function getDHMSubscriber() {
         set: saveWatermark,
       },
     },
-    algod,
-    indexer,
+    algorand.client.algod,
+    algorand.client.indexer,
   )
   subscriber.onBatch('dhm-asset', async (events) => {
     // eslint-disable-next-line no-console

examples/usdc/index.ts

@@ -1,4 +1,4 @@
-import * as algokit from '@algorandfoundation/algokit-utils'
+import { AlgorandClient } from '@algorandfoundation/algokit-utils'
 import algosdk from 'algosdk'
 import fs from 'fs'
 import path from 'path'
@@ -12,7 +12,7 @@ if (!fs.existsSync(path.join(__dirname, '..', '..', '.env')) && !process.env.ALG
 }
 
 ;(async () => {
-  const algod = await algokit.getAlgoClient()
+  const algorand = AlgorandClient.testNet()
   let watermark = 0
 
   const subscriber = new AlgorandSubscriber(
@@ -36,7 +36,7 @@ if (!fs.existsSync(path.join(__dirname, '..', '..', '.env')) && !process.env.ALG
         },
       },
     },
-    algod,
+    algorand.client.algod,
   )
   subscriber.on('usdc', (transfer) => {
     // eslint-disable-next-line no-console

examples/xgov-voting/index.ts

@@ -1,6 +1,6 @@
 import { AlgorandClient } from '@algorandfoundation/algokit-utils'
 import { Prisma, PrismaClient } from '@prisma/client'
-import algosdk, { ABIValue } from 'algosdk'
+import algosdk from 'algosdk'
 import fs from 'fs'
 import path from 'path'
 import { AlgorandSubscriber } from '../../src/subscriber'
@@ -18,17 +18,17 @@ if (!fs.existsSync(path.join(__dirname, '..', '..', '.env')) && !process.env.ALG
 
 const prisma = new PrismaClient()
 
-const votingRoundId = 1821334702 // Grab from https://voting.algorand.foundation/
+const votingRoundId = 1821334702n // Grab from https://voting.algorand.foundation/
 const watermarkId = `voting-${votingRoundId}`
 
 async function getXGovSubscriber() {
   const algorand = AlgorandClient.fromEnvironment()
 
   // Get voting round metadata
   const appClient = algorand.client.getTypedAppClientById(VotingRoundAppClient, {
-    id: votingRoundId,
+    appId: votingRoundId,
   })
-  const votingRoundState = await appClient.getGlobalState()
+  const votingRoundState = await appClient.state.global.getAll()
   const votingRoundMetadata = (await (
     await fetch(`https://ipfs.algonode.xyz/ipfs/${votingRoundState.metadataIpfsCid!.asString()}`)
   ).json()) as VotingRoundMetadata
@@ -147,7 +147,7 @@ async function getXGovSubscriber() {
           data: poll.subscribedTransactions.flatMap((t) => {
             return answerArrayType
               .decode(Buffer.from(t!['application-transaction']!['application-args']![answerAppArgsIndex], 'base64'))
-              .map((v: ABIValue, i: number) => {
+              .map((v: algosdk.ABIValue, i: number) => {
                 if (!useWeighting) {
                   const questionIndex = i
                   const answerIndex = parseInt(v.toString())