Skip to content

Commit 9c4ae12

Browse files
authored
docs: AK-194: Updated dev portal links (#22)
## Proposed Changes - - -
2 parents 09a58fd + b442846 commit 9c4ae12

File tree

3 files changed

+28
-16
lines changed

3 files changed

+28
-16
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
<p align="center">
66
<a target="_blank" href="https://algorandfoundation.github.io/algokit-subscriber-py/"><img src="https://img.shields.io/badge/docs-repository-74dfdc?logo=github&style=flat.svg" /></a>
7-
<a target="_blank" href="https://developer.algorand.org/algokit/"><img src="https://img.shields.io/badge/learn-AlgoKit-74dfdc?logo=algorand&mac=flat.svg" /></a>
7+
<a target="_blank" href="https://algorand.co/algokit"><img src="https://img.shields.io/badge/learn-AlgoKit-74dfdc?logo=algorand&mac=flat.svg" /></a>
88
<a target="_blank" href="https://github.com/algorandfoundation/algokit-subscriber-py"><img src="https://img.shields.io/github/stars/algorandfoundation/algokit-subscriber-py?color=74dfdc&logo=star&style=flat" /></a>
9-
<a target="_blank" href="https://developer.algorand.org/algokit/"><img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgokit-subscriber-py&countColor=%2374dfdc&style=flat" /></a>
9+
<a target="_blank" href="https://algorand.co/algokit"><img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgokit-subscriber-py&countColor=%2374dfdc&style=flat" /></a>
1010
</p>
1111

1212
---

docs/index.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,27 @@ Polled 0 transactions
5353

5454
## Capabilities
5555

56-
- [Notification _and_ indexing](#notification-and-indexing)
57-
- [Low latency processing](#low-latency-processing)
58-
- [Extensive subscription filtering](#extensive-subscription-filtering)
59-
- [ARC-28 event subscription and reads](#arc-28-event-subscription-and-reads)
60-
- [First-class inner transaction support](#first-class-inner-transaction-support)
61-
- [State-proof support](#state-proof-support)
62-
- [Simple programming model](#simple-programming-model)
63-
- [Easy to deploy](#easy-to-deploy)
64-
- [Fast initial index](#fast-initial-index)
56+
- [Algorand transaction subscription / indexing](#algorand-transaction-subscription--indexing)
57+
- [Quick start](#quick-start)
58+
- [Capabilities](#capabilities)
59+
- [Notification _and_ indexing](#notification-and-indexing)
60+
- [Low latency processing](#low-latency-processing)
61+
- [Watermarking and resilience](#watermarking-and-resilience)
62+
- [Extensive subscription filtering](#extensive-subscription-filtering)
63+
- [ARC-28 event subscription and reads](#arc-28-event-subscription-and-reads)
64+
- [First-class inner transaction support](#first-class-inner-transaction-support)
65+
- [State-proof support](#state-proof-support)
66+
- [Simple programming model](#simple-programming-model)
67+
- [Easy to deploy](#easy-to-deploy)
68+
- [Fast initial index](#fast-initial-index)
69+
- [Entry points](#entry-points)
70+
- [Reference docs](#reference-docs)
71+
- [Emit ARC-28 events](#emit-arc-28-events)
72+
- [Algorand Python](#algorand-python)
73+
- [TealScript](#tealscript)
74+
- [PyTEAL](#pyteal)
75+
- [TEAL](#teal)
76+
- [Next steps](#next-steps)
6577

6678
### Notification _and_ indexing
6779

@@ -85,7 +97,7 @@ The `sync_behaviour` parameter can also be set to `sync-oldest`, which is a more
8597

8698
### Low latency processing
8799

88-
You can control the polling semantics of the library when using the [`AlgorandSubscriber`](./subscriber.md) by either specifying the `frequency_in_seconds` parameter to control the duration between polls or you can use the `wait_for_block_when_at_tip` parameter to indicate the subscriber should [call algod to ask it to inform the subscriber when a new round is available](https://developer.algorand.org/docs/rest-apis/algod/#get-v2statuswait-for-block-afterround) so the subscriber can immediately process that round with a much lower-latency. When this mode is set, the subscriber intelligently uses this option only when it's caught up to the tip of the chain, but otherwise uses `frequency_in_seconds` while catching up to the tip of the chain.
100+
You can control the polling semantics of the library when using the [`AlgorandSubscriber`](./subscriber.md) by either specifying the `frequency_in_seconds` parameter to control the duration between polls or you can use the `wait_for_block_when_at_tip` parameter to indicate the subscriber should [call algod to ask it to inform the subscriber when a new round is available](https://dev.algorand.co/reference/rest-apis/algod/#waitforblock) so the subscriber can immediately process that round with a much lower-latency. When this mode is set, the subscriber intelligently uses this option only when it's caught up to the tip of the chain, but otherwise uses `frequency_in_seconds` while catching up to the tip of the chain.
89101

90102
e.g.
91103

@@ -306,11 +318,11 @@ The `intra-round-offset` field in a [subscribed transaction or inner transaction
306318

307319
### State-proof support
308320

309-
You can subscribe to [state proof](https://developer.algorand.org/docs/get-details/stateproofs/) transactions using this subscriber library. At the time of writing state proof transactions are not supported by algosdk v2 and custom handling has been added to ensure this valuable type of transaction can be subscribed to.
321+
You can subscribe to [state proof](https://dev.algorand.co/concepts/protocol/stateproofs) transactions using this subscriber library. At the time of writing state proof transactions are not supported by algosdk v2 and custom handling has been added to ensure this valuable type of transaction can be subscribed to.
310322

311323
The field level documentation of the [returned state proof transaction](subscriptions.md#subscribedtransaction) is comprehensively documented via [AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L277).
312324

313-
By exposing this functionality, this library can be used to create a [light client](https://developer.algorand.org/docs/get-details/stateproofs/light_client/).
325+
By exposing this functionality, this library can be used to create a [light client](https://dev.algorand.co/concepts/protocol/stateproofs).
314326

315327
### Simple programming model
316328

@@ -344,7 +356,7 @@ The indexer catchup isn't magic - if the filter you are trying to catch up with
344356

345357
To understand how the indexer behaviour works to know if you are likely to generate a lot of transactions it's worth understanding the architecture of the indexer catchup; indexer catchup runs in two stages:
346358

347-
1. **Pre-filtering**: Any filters that can be translated to the [indexer search transactions endpoint](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactions). This query is then run between the rounds that need to be synced and paginated in the max number of results (1000) at a time until all of the transactions are retrieved. This ensures we get round-based transactional consistency. This is the filter that can easily explode out though and take a long time when using indexer catchup. For avoidance of doubt, the following filters are the ones that are converted to a pre-filter:
359+
1. **Pre-filtering**: Any filters that can be translated to the [indexer search transactions endpoint](https://dev.algorand.co/reference/rest-apis/indexer/#lookuptransaction). This query is then run between the rounds that need to be synced and paginated in the max number of results (1000) at a time until all of the transactions are retrieved. This ensures we get round-based transactional consistency. This is the filter that can easily explode out though and take a long time when using indexer catchup. For avoidance of doubt, the following filters are the ones that are converted to a pre-filter:
348360
- `sender` (single value)
349361
- `receiver` (single value)
350362
- `type` (single value)

docs/subscriptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ The common model used to expose a transaction that is returned from a subscripti
258258
from algokit_subscriber import SubscribedTransaction
259259
```
260260

261-
This type is substantively, based on the Indexer [`TransactionResult`](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L77) [model](https://developer.algorand.org/docs/rest-apis/indexer/#transaction) format. While the indexer type is used, the subscriber itself doesn't have to use indexer - any transactions it retrieves from algod are transformed to this common model type. Beyond the indexer type it has some modifications to:
261+
This type is substantively, based on the Indexer [`TransactionResult`](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L77) [model](https://dev.algorand.co/reference/rest-apis/indexer#transaction) format. While the indexer type is used, the subscriber itself doesn't have to use indexer - any transactions it retrieves from algod are transformed to this common model type. Beyond the indexer type it has some modifications to:
262262

263263
- Add the `parent_transaction_id` field so inner transactions have a reference to their parent
264264
- Override the type of `inner-txns` to be `SubscribedTransaction[]` so inner transactions (recursively) get these extra fields too

0 commit comments

Comments
 (0)