bet-test-sdk 1.2.6 → 1.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -11
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,11 +2,11 @@
2
2
 
3
3
  ## Important
4
4
 
5
- Never click links in this repository leaving github, never click links in Issues, don't run code that others post without reading it, this software is provided "as is," without warranty.
5
+ Never click any links in this repository or its issues that lead you away from GitHub. Do not run any code that others post without reading and understanding it first. This software is provided "as is" without warranty.
6
6
 
7
7
  ## Overview
8
8
 
9
- The `BetSDK` is designed to interact with the bet.com decentralized application. It provides methods for creating, buying, and selling tokens using the Solana blockchain. The SDK handles the necessary transactions and interactions with the bet.com program.
9
+ The `BetSDK` is designed to interact with the bet.com decentralized application. It provides methods for creating, buying, and selling tokens on the Solana blockchain. The SDK manages the necessary transactions and interactions with the bet.com program.
10
10
 
11
11
  ## Installation
12
12
 
@@ -15,8 +15,7 @@ npm i bet-test-sdk
15
15
  `
16
16
 
17
17
  ## Notice (for developers)
18
- If you get an error about `crypto` when building dist with frameworks such as react, vue, nextjs, etc. on the frontend,
19
- consider installing plugins such as node-polyfills OR add the crypto-browserify alias to the configuration file.
18
+ If you encounter an error regarding the `crypto` module when building a front-end project with frameworks such as React, Vue, or Next.js, consider installing a polyfill (for example, the node-polyfills plugin) or adding a crypto-browserify alias to your build configuration.
20
19
 
21
20
  For example:
22
21
  ```
@@ -38,6 +37,7 @@ resolve: {
38
37
  ```
39
38
 
40
39
  ### BetSDK transaction
40
+
41
41
  Get BetSDK transaction-related methods.
42
42
 
43
43
  #### getCreateAndBuyInstructions
@@ -72,9 +72,9 @@ async getCreateAndBuyInstructions(
72
72
  - `name`: Token name.
73
73
  - `symbol`: Token symbol.
74
74
  - `description`: Token description.
75
- - `migrateDex`: After completing the bet curve, the dex you want to migrate to currently only provides Raydium and Meteora. MigrateType can be imported from the SDK.
75
+ - `migrateDex`: After completing the bet curve, the decentralized exchange (DEX) you wish to migrate to currently supports only Raydium and Meteora. The MigrateType can be imported from the SDK.
76
76
  - `file`: Token logo file
77
- - `createdOn`: On which platform was it created?
77
+ - `createdOn`: Specifies the platform on which the token was created.
78
78
  - `twitter`: X link
79
79
  - `telegram`: Telegram link
80
80
  - `discord`: Discord link
@@ -83,7 +83,7 @@ async getCreateAndBuyInstructions(
83
83
  - Creates a new token and buys it.
84
84
  - **Parameters**:
85
85
  - `creator`: The public key of the token creator.
86
- - `createTokenMetadata`: Metadata for the token.(`migrateType` of createTokenMetadata: After completing the bet curve, the dex you want to migrate to currently only provides Raydium and Meteora. MigrateType can be imported from the SDK.)
86
+ - `createTokenMetadata`: Metadata for the token. (For the createTokenMetadata object, the migrateType property specifies that after completing the bet curve, the DEX you wish to migrate to currently supports only Raydium and Meteora. The MigrateType can be imported from the SDK.)
87
87
  - `buyAmountSol`: Amount of SOL to buy.
88
88
  - `slippageBasisPoints`: Slippage in basis points (default: 500).
89
89
  - `commitment`: Commitment level (default: DEFAULT_COMMITMENT).
@@ -166,9 +166,9 @@ async curveStateProgress(mint: PublicKey): Promise<number>
166
166
 
167
167
  ## Usage Example
168
168
 
169
- First you need to create a `.env` file and set your RPC URL like in the `.env.example`
169
+ First, create a `.env` file and set your RPC URL as shown in the `.env.example` file.
170
170
 
171
- Then you need to fund an account with atleast 0.004 SOL that is generated when running the command below
171
+ Then, run the command below to generate a new account, and fund this account with at least 0.004 SOL.
172
172
 
173
173
  `
174
174
  npx ts-node example/basic/index.ts
@@ -332,7 +332,7 @@ main();
332
332
 
333
333
  ### BetSDK Class
334
334
 
335
- The `BetSDK` class provides methods to interact with the Bet protocol. Below are the method signatures and their descriptions.
335
+ The `BetSDK` class provides methods for interacting with the Bet protocol. Below are the method signatures and descriptions.
336
336
 
337
337
 
338
338
  #### createAndBuy
@@ -518,7 +518,7 @@ npx ts-node example/events/events.ts
518
518
 
519
519
  ## Disclaimer
520
520
 
521
- This software is provided "as is," without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
521
+ This software is provided "as is" without any warranty, express or implied, including, but not limited to, the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claims, damages, or other liabilities, whether arising from a contract, tort, or any other legal theory in connection with the software or its use.
522
522
 
523
523
  **Use at your own risk.** The authors take no responsibility for any harm or damage caused by the use of this software. Users are responsible for ensuring the suitability and safety of this software for their specific use cases.
524
524
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bet-test-sdk",
3
- "version": "1.2.6",
3
+ "version": "1.2.7",
4
4
  "description": "A simple SDK for interacting with test bet",
5
5
  "module": "./dist/esm/index.js",
6
6
  "main": "./dist/cjs/index.js",