Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
outsmartchad authored Aug 22, 2024
1 parent 0cd6432 commit c9937cc
Showing 1 changed file with 112 additions and 91 deletions.
203 changes: 112 additions & 91 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,97 +17,6 @@
- https://github.com/rckprtr/pumpdotfun-sdk
- https://github.com/Al366io/solana-transactions-wrapper


## Project Structure
```
.solana-memecoin-cli
├── data
| ├── Image_file # store image file (jpeg, jpg,...)
| ├── metadata_file # store .json file about the token metadata
| ├── payer_keypair # store wallet keypair .json
| └── token_keypair # store token keypair .json
├── examples (Screenshots of Commands) # all screenshot to show how we use the command line tool
| ├── add_liquidity # see how to add liquidity to a pool on Raydium
| ├── burn_token # see how to burn a token with WSOL using Raydium swap
| ├── create_token # see how to create a SPL token on mainnet or devnet
| ├── buy_token # buy a token using raydium with both jito bundles and priority fees
| ├── create_token # create a token with 0% extra fees on solana (mainnet or devnet)
| ├── remove_liquidity # remove some liquidity from a pool on Raydium
| ├── boost_volume # boost the volume of a token on raydium
| ├── pump_createAndInitialBuy # create and initial buy token on pump.fun
| ├── pump_buy # buy token on pump.fun
| ├── pump_sell # sell token on pump.fun
| └── sell_token # sell the token with a percentage using Raydium swap
├── src
| ├── helpers
| | ├── .env.copy # .env file to store your keys, rmb change to .env
| | ├── check_balance
| | ├── config.js # get value from .env
| | └── util.js # useful functions
| ├── Pool # Only Supporting Raydium right now
| | ├── add_pool.js # adding liquidity to AMM pool on Raydium
| | ├── create_pool.js # create pool/create open book market on Raydium (not done)
| | ├── check_pool.js # check the pool's info (pool size, burn percentage of LP token...)
| | ├── formatAmmKeysById.js # get well-informated info of pool
| | ├── query_pool.js # query the pool's current info (not done)_
| | ├── remove_pool.js # remove liquidity from AMM pool on Raydium
| | └── swap.js # swap on Raydium
| ├── pumpfunsdk
| | ├── pump-keypair # store your new generated token keypair
| | ├── pumpdotfun-sdk
| | | ├── example
| | | ├── images # store your token image
| | | ├── src
| | | | ├── IDL
| | | | ├── pump-events-listener
| | | | | ├── listener.js # listen to the create, trade, and complete bonding curve event
| | | | ├── amm.js
| | | | ├── createAndBuy.js # create token and initial buy it in pump.fun
| | | | ├── buy.js # buy token in pump.fun
| | | | ├── sell.js # sell token in pump.fun
| | | | ├── pumpfun.js # the implementation of pump.fun sdk
| | | | ├── util.js # useful functions
| | | | └── tools.js # interact with pump.fun sdk
| ├── Token
| | ├── create.js # create token with uploading token image and metadata to irys (storage provider)
| | ├── burn.js # burn a percentage of token
| | ├── query.js # query token's info (creator, price, metadata, holder...) (not done)
| | └── revoke_authority.js # revoke token's freeze and mint authority
| ├── Trading
| | ├── dex
| | | ├── jupiter
| | | | ├── swap
| | | | | ├── buy-helper.js # buy token with sol using jup swap api
| | | | | ├── sell-helper.js # sell token to sol using jup swap api
| | | | | └── swap-helper.js # swap any to any token using jup swap api
| | | | ├── dca.js # create a dollar cost average program using jup api
| | | | └── limit_order.js # create a limit order program using jup api
| | | ├── meteora
| | | ├── orca
| | | └── raydium
| | | ├── buy-helper.js # buy token with WSOL using src\Pool\swap.js
| | | ├── buy.js
| | | ├── sell-helper.js # sell token to WSOL using src\Pool\swap.js
| | | └── sell.js
| | ├── volume
| | | └── boost-volume.js # boosting token's volume
| | | # by doing one buy and one sell instruction in one transaction
| | | # [buy(), sell()] (only losing your gas fee)
| | └── memecoin-trading-strategies
| | ├── copy_trading
| | | ├── copy-buy.js # copy trader's buy tx
| | | ├── copy-sell.js # copy trader's sell tx
| | | └── copy-trade.js # Use two core to both copy-buy and copy-sell
| | ├── Filters
| | ├── take-profit.js # taking profits by setting a limit order
| | └── stop-loss.js # stop loss by setting a limit order
| └── Transactions
| ├── jito-tips-tx-executor.js # sending bundles(list of instructions) to Jito validators
| # validators help our tx land faster
| ├── simple-tx-executor.js # submitting ur tx to RPC provider with predefined priority fees
| └── bloXroute-tips-tx-executor.js # submitting ur tx to bloXroute staked rpc and their server will send ur tx to current blockleader
└── help.js
```
### Installation 🛠️

1. `git clone https://github.com/outsmartchad/solana-trading-cli.git`
Expand Down Expand Up @@ -278,6 +187,118 @@ node sell --token_address <ADDRESS_TOKEN> --percentage <SELL_PERCENTAGE>

- src/helpers/check_balance.js: check the balance of a given token in your wallet

## Project Structure
```
.solana-memecoin-cli
├── data
| ├── Image_file # store image file (jpeg, jpg,...)
| ├── metadata_file # store .json file about the token metadata
| ├── payer_keypair # store wallet keypair .json
| └── token_keypair # store token keypair .json
├── examples (Screenshots of Commands) # all screenshot to show how we use the command line tool
| ├── add_liquidity # see how to add liquidity to a pool on Raydium
| ├── burn_token # see how to burn a token with WSOL using Raydium swap
| ├── create_token # see how to create a SPL token on mainnet or devnet
| ├── buy_token # buy a token using raydium with both jito bundles and priority fees
| ├── create_token # create a token with 0% extra fees on solana (mainnet or devnet)
| ├── remove_liquidity # remove some liquidity from a pool on Raydium
| ├── boost_volume # boost the volume of a token on raydium
| ├── pump_createAndInitialBuy # create and initial buy token on pump.fun
| ├── pump_buy # buy token on pump.fun
| ├── pump_sell # sell token on pump.fun
| └── sell_token # sell the token with a percentage using Raydium swap
└── src
├── helpers
│ ├── .env
│ ├── .env.copy
│ ├── check_balance.js
│ ├── config.js
│ ├── unwrap_sol.js
│ ├── util.js
│ └── wrap_sol.js
├── Trading_dev
│ ├── dex
│ │ ├── meteora
│ │ │ ├── swap.js
│ │ │ ├── buy.js
│ │ │ ├── sell.js
│ │ │ ├── constants.js
│ │ │ ├── fetch-pool.js
│ │ │ ├── fetch-price.js
│ │ │ └── idl.js
│ │ └── orca
│ │ └── #same as meteora/raydium
│ └── memecoin_trading_strategies/
│ ├── copy-trading/
│ │ ├── copy-buy.js
│ │ ├── copy-sell.js
│ │ ├── copy-trade.js
│ │ └── grpc-copy-bot/
│ └── tp_sl
│ ├── stop-loss.js
│ └── take-profit.js
├── Memecoin_dev
│ ├── bundled_launcher
│ ├── market-making_dev/
│ │ └── boost_volume.js
│ └── sniping_dev
│ ├── grpc_pump_sniper/
│ └── grpc_raydium_sniper/
├── Transactions
│ ├── bloXroute_tips_tx_executor.js
│ ├── jito_tips_tx_executor.js
│ └── simple_tx_executor.js
├── Token
│ ├── zk-compression/
│ ├── burn.js
│ ├── create.js
│ └── revoke_authority.js
├── raydium
│ ├── Pool/
│ │ ├── add_pool.js
│ │ ├── create_pool.js
│ │ ├── fetch_pool.js
│ │ ├── formatAmmKeysById.js
│ │ ├── query_pool.js
│ │ ├── remove_pool.js
│ │ └── swap.js
│ ├── token-filters
│ │ ├── lp-burn.js
│ │ ├── maker-count.js
│ │ ├── marketcap.js
│ │ ├── pool-sol.js
│ │ ├── tx-count.js
│ │ └── volume.js
│ ├── buy.js
│ ├── constants.js
│ ├── fetch-price.js
│ ├── raydium_config.js
│ └── sell.js
├── jupiter
│ ├── swap/
│ │ ├── buy-helper.js
│ │ ├── sell-helper.js
│ │ └── swap-helper.js
│ ├── dca.js
│ └── limit-order.js
└── pumpfunsdk
├── pump-keypair/
└── pumpdotfun-sdk
├── images/
└── src
├── IDL/
├── pump-events-listener/
│ └── listeners.js
├── amm.js
├── buy.js
├── createAndBuy.js
├── pumpfun.js
├── sell.js
├── tools.js
└── util.js
```

## Contributing
- Contributions is wellcome!!!
- Fork it
Expand Down

0 comments on commit c9937cc

Please sign in to comment.