@skip-go/client 0.4.3

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 (21) hide show
  1. package/README.md +55 -0
  2. package/dist/chunk-6AMBIQDN.js +1868 -0
  3. package/dist/chunk-6FNC3XMI.js +45 -0
  4. package/dist/chunk-JRIEAGIQ.js +10 -0
  5. package/dist/chunk-PV2ELBDQ.js +3248 -0
  6. package/dist/index.d.ts +307 -0
  7. package/dist/index.js +2874 -0
  8. package/dist/parser.d.ts +1 -0
  9. package/dist/parser.js +11 -0
  10. package/dist/shared-UW-rSz3r.d.ts +943 -0
  11. package/dist/transactions.d.ts +11 -0
  12. package/dist/transactions.js +23 -0
  13. package/dist/types.d.ts +565 -0
  14. package/dist/types.js +639 -0
  15. package/package.json +38 -0
  16. package/parser.d.ts +1 -0
  17. package/parser.js +1 -0
  18. package/transactions.d.ts +1 -0
  19. package/transactions.js +1 -0
  20. package/types.d.ts +1 -0
  21. package/types.js +1 -0
package/README.md ADDED
@@ -0,0 +1,55 @@
1
+ [![npm/v](https://badgen.net/npm/v/@skip-go/client)](https://www.npmjs.com/package/@skip-go/client)
2
+ [![npm/dt](https://badgen.net/npm/dt/@skip-go/client?)](https://www.npmjs.com/package/@skip-go/client)
3
+ [![stars](https://badgen.net/github/stars/skip-mev/skip-go?)](https://github.com/skip-mev/skip-go)
4
+
5
+ # @skip-go/client
6
+
7
+ JavaScript SDK for Skip Go API
8
+
9
+ ## Install
10
+
11
+ ```bash
12
+ npm install @skip-go/client
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ Read more at Skip Go API docs website on [Getting Started: TypeScript SDK](https://docs.skip.build/go/general/getting-started).
18
+
19
+ ## Development
20
+
21
+ ```bash
22
+ # clone repository
23
+ git clone https://github.com/skip-mev/skip-go.git
24
+ cd skip-go/packages/client
25
+
26
+ # prepare submodules
27
+ git submodule update --init --recursive
28
+
29
+ # install dependencies
30
+ npm install
31
+
32
+ # run watch server to build on changes
33
+ npm -w @skip-go/client run watch
34
+
35
+ # build packages
36
+ npm run build
37
+ ```
38
+
39
+ ## Unit Tests
40
+
41
+ ```bash
42
+ # run unit tests
43
+ npm run test
44
+
45
+ # run unit tests in watch mode
46
+ npm run test -- --watch
47
+
48
+ # run unit tests with coverage
49
+ npm run test -- --coverage
50
+ ```
51
+
52
+ ## Documentation
53
+
54
+ - [Skip Go API documentation](https://docs.skip.build/go)
55
+ - [Skip Go API Reference](https://docs.skip.build/go/api-reference/prod/info/get-v2infochains)