Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Algod

Hierarchy

  • Algod

Index

Constructors

  • new Algod(token?: string, baseServer?: string, port?: number, headers?: {}): Algod
  • Parameters

    • token: string = ''
    • baseServer: string = 'http://r2.algorand.network'
    • port: number = 4180
    • headers: {} = {}

      Returns Algod

    Properties

    accountInformation: (addr: any, headerObj?: {}) => Promise<any>

    Type declaration

      • (addr: any, headerObj?: {}): Promise<any>
      • accountInformation returns the passed account's information

        Parameters

        • addr: any

          string

        • headerObj: {} = {}

          Returns Promise<any>

      assetInformation: (index: any, headerObj?: {}) => Promise<any>

      Type declaration

        • (index: any, headerObj?: {}): Promise<any>
        • assetInformation returns the information for the asset with the passed creator and index

          Parameters

          • index: any

            number

          • headerObj: {} = {}

            Returns Promise<any>

        block: (roundNumber: any, headerObj?: {}) => Promise<any>

        Type declaration

          • (roundNumber: any, headerObj?: {}): Promise<any>
          • block gets the block info for the given round This call blocks

            Parameters

            • roundNumber: any
            • headerObj: {} = {}

              Returns Promise<any>

          getTransactionParams: (headerObj?: {}) => Promise<any>

          Type declaration

            • (headerObj?: {}): Promise<any>
            • getTransactionParams returns to common needed parameters for a new transaction

              Parameters

              • headerObj: {} = {}

                Returns Promise<any>

            healthCheck: (headerObj?: {}) => Promise<any>

            Type declaration

              • (headerObj?: {}): Promise<any>
              • healthCheck returns an empty object iff the node is running

                Parameters

                • headerObj: {} = {}

                  Returns Promise<any>

              ledgerSupply: (headerObj?: {}) => Promise<any>

              Type declaration

                • (headerObj?: {}): Promise<any>
                • LedgerSupply gets the supply details for the specified node's Ledger

                  Parameters

                  • headerObj: {} = {}

                    Returns Promise<any>

                pendingTransactionInformation: (txid: any, headerObj?: {}) => Promise<any>

                Type declaration

                  • (txid: any, headerObj?: {}): Promise<any>
                  • pendingTransactionInformation returns the transaction information for a specific txid of a pending transaction

                    Parameters

                    • txid: any
                    • headerObj: {} = {}

                      Returns Promise<any>

                  pendingTransactions: (maxTxns: any, headerObj?: {}) => Promise<any>

                  Type declaration

                    • (maxTxns: any, headerObj?: {}): Promise<any>
                    • pendingTransactions asks algod for a snapshot of current pending txns on the node, bounded by maxTxns. If maxTxns = 0, fetches as many transactions as possible.

                      Parameters

                      • maxTxns: any

                        number

                      • headerObj: {} = {}

                        Returns Promise<any>

                    sendRawTransaction: (txn: any, headerObj?: {}) => Promise<any>

                    Type declaration

                      • (txn: any, headerObj?: {}): Promise<any>
                      • sendRawTransaction gets an encoded SignedTxn and broadcasts it to the network

                        Parameters

                        • txn: any

                          Uin8Array

                        • headerObj: {} = {}

                          Returns Promise<any>

                      sendRawTransactions: (txns: any, headerObj?: {}) => Promise<any>

                      Type declaration

                        • (txns: any, headerObj?: {}): Promise<any>
                        • sendRawTransactions gets a list of encoded SignedTxns and broadcasts it to the network

                          Parameters

                          • txns: any
                          • headerObj: {} = {}

                            Returns Promise<any>

                        status: (headerObj?: {}) => Promise<any>

                        Type declaration

                          • (headerObj?: {}): Promise<any>
                          • status retrieves the StatusResponse from the running node

                            Parameters

                            • headerObj: {} = {}

                              Returns Promise<any>

                          statusAfterBlock: (roundNumber: any, headerObj?: {}) => Promise<any>

                          Type declaration

                            • (roundNumber: any, headerObj?: {}): Promise<any>
                            • statusAfterBlock waits for round roundNumber to occur then returns the StatusResponse for this round. This call blocks

                              Parameters

                              • roundNumber: any
                              • headerObj: {} = {}

                                Returns Promise<any>

                            suggestParams: (headerObj?: {}) => any

                            Type declaration

                              • (headerObj?: {}): any
                              • suggestParams returns to common needed parameters for a new transaction, in a format the transaction builder expects

                                Parameters

                                • headerObj: {} = {}

                                  Returns any

                              suggestedFee: (headerObj?: {}) => Promise<any>

                              Type declaration

                                • (headerObj?: {}): Promise<any>
                                • suggestedFee gets the recommended transaction fee from the node

                                  Parameters

                                  • headerObj: {} = {}

                                    Returns Promise<any>

                                transactionByAddress: (addr: any, first?: any, last?: any, maxTxns?: any, headerObj?: {}) => Promise<any>

                                Type declaration

                                  • (addr: any, first?: any, last?: any, maxTxns?: any, headerObj?: {}): Promise<any>
                                  • transactionsByAddress returns all transactions for a PK [addr] in the [first, last] rounds range.

                                    Parameters

                                    • addr: any

                                      string

                                    • first: any = null

                                      number, optional

                                    • last: any = null

                                      number, optional

                                    • maxTxns: any = null

                                      number, optional

                                    • headerObj: {} = {}

                                      Returns Promise<any>

                                  transactionByAddressAndDate: (addr: any, fromDate: any, toDate: any, maxTxns?: any, headerObj?: {}) => Promise<any>

                                  Type declaration

                                    • (addr: any, fromDate: any, toDate: any, maxTxns?: any, headerObj?: {}): Promise<any>
                                    • transactionsByAddressAndDate returns all transactions for a PK [addr] in the [fromDate, toDate] date range. The date is a string in the YYYY-MM-DD format.

                                      Parameters

                                      • addr: any

                                        string

                                      • fromDate: any

                                        string

                                      • toDate: any

                                        string

                                      • maxTxns: any = null

                                        number, optional

                                      • headerObj: {} = {}

                                        Returns Promise<any>

                                    transactionById: (txid: any, headerObj?: {}) => Promise<any>

                                    Type declaration

                                      • (txid: any, headerObj?: {}): Promise<any>
                                      • transactionById returns the a transaction information of a specific txid [txId] Note - This method is allowed only when Indexer is enabled.

                                        Parameters

                                        • txid: any
                                        • headerObj: {} = {}

                                          Returns Promise<any>

                                      transactionInformation: (addr: any, txid: any, headerObj?: {}) => Promise<any>

                                      Type declaration

                                        • (addr: any, txid: any, headerObj?: {}): Promise<any>
                                        • transactionInformation returns the transaction information of a specific txid and an address

                                          Parameters

                                          • addr: any
                                          • txid: any
                                          • headerObj: {} = {}

                                            Returns Promise<any>

                                        versions: (headerObj?: {}) => Promise<any>

                                        Type declaration

                                          • (headerObj?: {}): Promise<any>
                                          • versions retrieves the VersionResponse from the running node

                                            Parameters

                                            • headerObj: {} = {}

                                              Returns Promise<any>

                                          Generated using TypeDoc