algokit-subscriber-ts

@algorandfoundation/algokit-subscriber / index

Module: index

Table of contents

Classes

• AlgorandSubscriber

Functions

• getSubscribedTransactions

Functions

getSubscribedTransactions

▸ getSubscribedTransactions(subscription, algod, indexer?): Promise<TransactionSubscriptionResult>

Executes a single pull/poll to subscribe to transactions on the configured Algorand blockchain for the given subscription context.

Parameters

Name	Type	Description
subscription	TransactionSubscriptionParams	The subscription context.
algod	AlgodClient	An Algod client.
indexer?	IndexerClient	An optional indexer client, only needed when onMaxRounds is catchup-with-indexer.

Returns

Promise<TransactionSubscriptionResult>

The result of this subscription pull/poll.

Defined in

src/subscriptions.ts:56

This site is open source. Improve this page.