Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prepare test transactions #777

Open
wants to merge 1 commit into
base: 01-17-testing_processor
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ export default {
"migration-guide": {
title: "Migrate to Indexer SDK",
},
"test-transactions": {
title: "Preparing Test Transactions",
},
"txn-importer": {
title: "Importing Transactions",
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Aptos Indexer Testing Framework Overview

The Aptos Indexer Testing Framework provides two ways to generate test transactions: **by Importing Transactions from Network** and **By writing a Move Scripts**. Both approaches are suited for specific scenarios based on your development and testing requirements, enabling you to test how your system handles various transaction types.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The capitalization and grammar in the two options should be consistent. Consider updating to "By Importing Transactions from Network" and "By Writing a Move Script" (note: "Move Scripts" should be singular since it refers to a single script).

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.



## When to Import transactions
Imported transactions are primarily used to validate processor logic or database integrity by replaying transactions from live networks.

## When to Use **Move Script** to generate transactions
Scripted transactions are primarily used to create and test transaction scenarios that are not yet live on the network. In most cases, you should use transaction importing to test your processor logic.

## Summary
Aptos-indexer-transaction-generator tool is an essential tool in the Aptos Indexer Testing Framework. Import transactions for replaying and analyzing real-world transactions, while generating transactions with **Move Scripts** is best for testing new AIPs that may impact processing logic. Choose the method that aligns with your testing goals to ensure a comprehensive validation process.

## Next Steps
For detailed instructions on how to use these methods, refer to the following guides:
1. [Importing Transactions](./txn-importer)
2. [Generating Transactions with Move Scripts](./txn-script)