@orca-so/whirlpools-automation 0.1.0 → 0.2.0
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/CHANGELOG.md +7 -0
- package/README.md +46 -0
- package/dist/index.browser.js +1497 -1346
- package/dist/index.d.ts +2 -0
- package/dist/index.node.js +1486 -1340
- package/dist/pda.d.ts +5 -0
- package/dist/staging.d.ts +3 -0
- package/package.json +2 -2
package/CHANGELOG.md
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @orca-so/whirlpools-automation
|
|
2
|
+
|
|
3
|
+
TypeScript client for the Whirlpools Automation program on Solana.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @orca-so/whirlpools-automation
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
This package provides generated TypeScript types, instruction builders, account decoders, and error definitions for the Whirlpools Automation program. It is built on top of [`@solana/kit`](https://github.com/anza-xyz/kit).
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import {
|
|
17
|
+
getCreateAutomationInstruction,
|
|
18
|
+
getHarvestAndReinvestInstruction,
|
|
19
|
+
fetchAutomation,
|
|
20
|
+
} from "@orca-so/whirlpools-automation";
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Build
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
yarn build
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
This produces both Node.js and browser ESM bundles in `dist/`.
|
|
30
|
+
|
|
31
|
+
## Development
|
|
32
|
+
|
|
33
|
+
The code under `src/generated/` is auto-generated by [Codama](https://github.com/codama-idl/codama) from the program's Shank IDL. Do not edit these files directly. To regenerate:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
# from the repository root
|
|
37
|
+
yarn generate
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Publish
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
npm publish
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Requires npm authentication with publish access to the `@orca-so` scope.
|