Get Transaction

Get the details for a posted transaction

Get details about a transaction that has already been posted to the network with the help of the getTransaction function.

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 { getTransaction } from 'arweavekit/transaction'

const data = await getTransaction({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 here.

Returned Data

The function call returns the following data:

    transaction: [TransactionObject]
  • transaction: Transaction : An object of type Transaction is returned by Arweave.

Last updated