Skip to content

Commit e300b4c

Browse files
committed
done
1 parent 8c2c050 commit e300b4c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const pumpTxn = parser.parse(txn)
4848

4949
The parser returns a `PumpFunTransaction` object (or an array of `PumpFunTransaction` objects if `parseMultiple` is called):
5050

51-
### PumpFun Transaction Structure
51+
#### PumpFun Transaction Structure
5252
The `PumpFunTransaction` object shows the different operations that occurred in the transaction. These operations are gotten from the events emitted during the transaction execution and are represented by the `PumpFunAction` interface as follows:
5353
```typescript
5454
interface PumpFunTransaction {
@@ -57,7 +57,7 @@ interface PumpFunTransaction {
5757
}
5858
```
5959

60-
### PumpFun Action Structure
60+
#### PumpFun Action Structure
6161
The `PumpFunAction` interface contains the three major actions that can occur in a PumpFun transaction (`create`, `complete`, `trade`), with the `info` field containing the relevant information for each action. The info field is of type `TradeInfo`, `CreateInfo`, or `CompleteInfo` depending on the action.
6262

6363
```typescript
@@ -94,8 +94,10 @@ type CompleteInfo = {
9494
timestamp: bigint;
9595
};
9696
```
97+
9798
> NB: The `CompleteInfo` event might return unexpected results due to issues with parsing variable length string fields (`name`, `symbol`, `uri`).
9899
100+
99101
### ▶️ Raydium Parser [Comming soon]
100102

101103
### ▶️ Jupiter Parser [Coming soon]
@@ -133,8 +135,10 @@ class CustomParser extends BaseParser<CustomTransaction> {
133135
}
134136
}
135137
```
138+
136139
> NB: For anchor specific parsers that rely on events, you can use the `anchorLogScanner` function present in the `src/core/utils` file to get program events from the transaction.
137140
141+
138142
## 🤝 Contributing
139143

140144
Here's how you can contribute to the library:
@@ -160,7 +164,8 @@ You can check the parser directory for more information on how to implement your
160164
- Update the README.md if your changes affect the usage of the parser.
161165
- Submit a pull request with your changes, explaining the modifications and their purpose.
162166

163-
> NB:For all contributions, please ensure your code passes all existing tests and include additional tests for the new parser. I also recommend using the `anchorLogScanner` function present in the `src/core/utils` file to get anchor program events from the transaction to avoid having to install anchor library (trying to make this library as lightweight as possible).
167+
168+
> NB: For all contributions, please ensure your code passes all existing tests and include additional tests for the new parser. I also recommend using the `anchorLogScanner` function present in the `src/core/utils` file to get anchor program events from the transaction to avoid having to install anchor library (trying to make this library as lightweight as possible).
164169
165170
## 🗂️ License
166171

0 commit comments

Comments
 (0)