ArweaveKit Docs
  • ArweaveKit
    • Introduction
  • 🔐Wallets
    • Introduction to Wallets
    • Create Wallet
    • Get Wallet Address
    • Get Wallet Balance
    • Wallet Plugins
  • 💳ARWEAVE WALLET KIT
    • Introduction to Arweave Wallet Kit
    • Setup
    • Connect Button
    • Hooks
    • Customization
  • 🏦Transactions
    • Introduction to Transactions
    • Create Transaction
    • Sign Transaction
    • Post Transaction
    • Get Transaction Status
    • Get Transaction
    • Create and Post Transaction with Othent
    • Transaction Plugins
  • 📄SMART CONTRACTS
    • Introduction to Smart Contracts
    • Create Contract
    • Write Contract
    • Read Contract State
    • View Contract State
    • Write Contract with Othent
    • Read Contract with Othent
    • Smart Contract Plugins
  • ✅AUTH
    • Introduction to Auth
    • Connect
    • Disconnect
    • Get Active Address
    • Get Permissions
    • Get Wallet Names
    • Get All Addresses
    • Get Active Public Key
    • Is Installed
    • Log In with Othent
    • Log Out with Othent
    • Get User Details with Othent
    • Auth Plugins
  • 🔐Encryption
    • Introduction to Encryption
    • Encrypt Data with AES
    • Decrypt Data with AES
    • Encrypt AES Key with RSA
    • Decrypt AES Key with RSA
    • Encryption Plugins
  • 🌐GRAPHQL
    • Introduction to GraphQL
    • Query All Arweave Transactions
    • Query Arweave Data
    • Query Arweave Transactions
    • GraphQL Plugins
  • 🗺️RoadMap
    • Features
  • 📘REFERENCES
    • ArweaveKit in Browser Environments
  • 🛠️SUPPORTING TOOLS
    • Arweave StarterKit
Powered by GitBook
On this page
  • Basic Syntax
  • Input Parameters
  • Returned Data

Was this helpful?

  1. Transactions

Get Transaction Status

Get the transaction status of a posted transaction

PreviousPost TransactionNextGet Transaction

Last updated 3 months ago

Was this helpful?

There is a wait time involved between requesting to post a transaction on chain and it actually being posted.

The getTransactionStatus functions provides the status for a given transaction on whether it has been successfully posted on chain or is amidst processing.

This function is only valid for transactions for which the post request has already been sent to the network. Additionally, this function only works with transactions generated with the default param for network (i.e. the arweave-js library. Support for the Bundlr SDK is not available currently.

Basic Syntax

The function is called as follows:

import { getTransactionStatus } from 'arweavekit/transaction'

const status = await getTransactionStatus({params});

Input Parameters

The following params are available for this function and they must be passed in as an object:

  • transactionId: string : The unique identification Id associated with a transaction.

  • environment: 'local' | 'mainnet' : The environment on which the transaction was posted.

An arlocal instance must be running on port 1984 for the function to work with the local environment. To create one, simply run npx arlocal in the command line. Learn more about arlocal .

Returned Data

The function call returns the following data:

{
  status: 200,
  confirmed: {
    block_height: 1107205,
    block_indep_hash: 'O0VduHn7GsBx0jsLVKXSPpx_ue-GRXpX56_1hfmIOrVI9sQFVe1ABb8iDDLJBzlu',
    number_of_confirmations: 18358
  }
}
  • status: number : The status is an indicator on whether the transaction has been successfully processed. It must return the value 200 for the same.

  • confirmed: object : The confirmed object contains additional information regarding the successful processing of the transaction.

    • block_height: number : The height or block number in which the transaction has been processed.

    • block_indep_hash: string :

    • number_of_confirmations: number : The number of blocks in the network that have been mined since processing of the given transaction.

🏦
here