pons-client 0.1.0 → 0.1.1
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 +9 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
#
|
|
1
|
+
# pons-client
|
|
2
2
|
|
|
3
3
|
TypeScript client for the [Pons v2](https://docs.ponsfamily.com/v2) token launch protocol on Robinhood Chain (4663).
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install
|
|
8
|
+
npm install pons-client
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Setup
|
|
12
12
|
|
|
13
13
|
```ts
|
|
14
|
-
import { createPonsClient } from "
|
|
14
|
+
import { createPonsClient } from "pons-client";
|
|
15
15
|
|
|
16
16
|
// Read-only client
|
|
17
17
|
const pons = createPonsClient({ rpcUrl: "https://rpc.robinhood.com" });
|
|
@@ -115,7 +115,7 @@ Copy `.env.example` to `.env` and fill in your values.
|
|
|
115
115
|
| 03 | `npx tsx examples/03-buy-sell-curve.ts` | Quote trades on curve | `RPC_URL`, `CURVE_ADDRESS` |
|
|
116
116
|
| 04 | `npx tsx examples/04-quote-trade.ts` | Local curve math | `RPC_URL`, `CURVE_ADDRESS` |
|
|
117
117
|
| 05 | `npx tsx examples/05-track-graduation.ts` | Track graduation progress | `RPC_URL`, `TOKEN_ADDRESS` |
|
|
118
|
-
| 06 | `npx tsx examples/06-claim-fees.ts` | Claim creator fees | `RPC_URL`, `PRIVATE_KEY
|
|
118
|
+
| 06 | `npx tsx examples/06-claim-fees.ts` | Claim creator fees | `RPC_URL`, `PRIVATE_KEY` |
|
|
119
119
|
| 07 | `npx tsx examples/07-read-vesting.ts` | Read buyback vesting | `RPC_URL`, `TOKEN_ADDRESS` |
|
|
120
120
|
| 08 | `npx tsx examples/08-index-events.ts` | Query historical events | `RPC_URL`, `FROM_BLOCK` |
|
|
121
121
|
| 09 | `npx tsx examples/09-pool-swap.ts` | Read pool state | `RPC_URL`, `TOKEN_ADDRESS` |
|
|
@@ -142,9 +142,11 @@ Robinhood Chain (4663):
|
|
|
142
142
|
## Development
|
|
143
143
|
|
|
144
144
|
```bash
|
|
145
|
-
npm run build
|
|
146
|
-
npm test
|
|
147
|
-
npm run typecheck
|
|
145
|
+
npm run build # build dist/
|
|
146
|
+
npm test # run 49 unit tests
|
|
147
|
+
npm run typecheck # check for type errors
|
|
148
|
+
npm run lint # lint source files
|
|
149
|
+
npm run format:check # check formatting
|
|
148
150
|
```
|
|
149
151
|
|
|
150
152
|
## License
|