mirror of
https://github.com/0xfnzero/solana-streamer.git
synced 2026-08-09 15:10:56 +00:00
William
65 lines
2.3 KiB
Markdown
65 lines
2.3 KiB
Markdown
# PumpFun Rust SDK
|
|
|
|
A comprehensive Rust SDK for seamless interaction with the PumpFun Solana program. This SDK provides a robust set of tools and interfaces to integrate PumpFun functionality into your applications.
|
|
|
|
|
|
# Explanation
|
|
This repository is forked from [https://github.com/nhuxhr/pumpfun-rs](https://github.com/nhuxhr/pumpfun-rs).
|
|
|
|
1. Change `PumpFun<'a>` to `PumpFun`, and `payer: &'a Keypair` to `payer: Arc<Keypair>`.
|
|
2. Add `logs_filters` and `logs_paser` to parse the logs of the PumpFun program.
|
|
3. Add `logs_data` to define the data structure of the logs.
|
|
4. Add `logs_subscribe` to subscribe the logs of the PumpFun program.
|
|
5. Add `logs_events` to define the event of the logs.
|
|
6. Add `logs_parser` to parse the logs.
|
|
7. Add `logs_process` to process the logs.
|
|
|
|
## Table of Contents
|
|
|
|
- [Crates](#crates)
|
|
- [Features](#features)
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
- [API Reference](#api-reference)
|
|
- [Contributing](#contributing)
|
|
|
|
## Crates
|
|
|
|
| Name | Description | Version |
|
|
| ------------------------------------- | ---------------------------------------------------------------------------------- | ------- |
|
|
| [`pumpfun`](./crates/pumpfun) | Main client library for interacting with the PumpFun program | 2.2.2 |
|
|
| [`pumpfun-cpi`](./crates/pumpfun-cpi) | CPI (Cross-Program Invocation) interfaces for integrating with the PumpFun program | 1.1.0 |
|
|
|
|
## Features
|
|
|
|
- **Easy-to-use API**: Simplified interfaces for interacting with the PumpFun Solana program.
|
|
- **Cross-Program Invocation**: Seamless integration with other Solana programs.
|
|
- **Comprehensive Documentation**: Detailed guides and API references for all functionalities.
|
|
|
|
## Installation
|
|
|
|
Add the following to your `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
mai3-pumpfun-sdk = "2.2.2"
|
|
```
|
|
|
|
## Usage
|
|
|
|
For detailed usage instructions, please refer to the documentation of each crate.
|
|
|
|
## API Reference
|
|
|
|
For detailed API documentation, run:
|
|
|
|
```
|
|
cargo doc --open
|
|
```
|
|
|
|
This will generate and open the API documentation in your default web browser.
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions to the PumpFun Rust SDK! Please see our [Contributing Guide](CONTRIBUTING.md) for more details on how to get started.
|