@deserialize/swap-sdk 0.0.5 → 0.0.6
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.
- package/README.md +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
# Swap SDK
|
|
6
6
|
|
|
7
|
-
The **Swap SDK** is a TypeScript library that simplifies interacting with a
|
|
7
|
+
The **Swap SDK** is a TypeScript library that simplifies interacting with a Deserialize swap endpoint. It abstracts away the low-level details of converting between SVM types (e.g., `PublicKey`, `Keypair`) and the API’s JSON formats. Use it to easily construct swap transactions or retrieve underlying instructions for advanced scenarios.
|
|
8
8
|
|
|
9
9
|
## Features
|
|
10
10
|
|
|
11
11
|
- **Simple API:**
|
|
12
|
-
Accepts
|
|
12
|
+
Accepts SVM `PublicKey` objects and numerical amounts while handling all necessary conversions.
|
|
13
13
|
- **Transaction Deserialization & Signing:**
|
|
14
14
|
Automatically converts a base64-encoded transaction from the API into a `VersionedTransaction` and applies signatures.
|
|
15
15
|
- **Flexible Usage:**
|
|
@@ -22,12 +22,11 @@ The **Swap SDK** is a TypeScript library that simplifies interacting with a Sola
|
|
|
22
22
|
Install the package via npm (or yarn):
|
|
23
23
|
|
|
24
24
|
```bash
|
|
25
|
-
npm install swap-sdk
|
|
25
|
+
npm install @deserialize/swap-sdk
|
|
26
26
|
# or
|
|
27
|
-
yarn add swap-sdk
|
|
27
|
+
yarn add @deserialize/swap-sdk
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
*Note:* Replace `swap-sdk` with the actual package name when you publish it.
|
|
31
30
|
|
|
32
31
|
## Usage
|
|
33
32
|
|
|
@@ -144,3 +143,4 @@ Happy swapping!
|
|
|
144
143
|
```
|
|
145
144
|
|
|
146
145
|
---
|
|
146
|
+
|