@gibwork/sdk 0.0.1 → 0.0.2
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 +2 -44
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -52,30 +52,6 @@ const gibwork = new GibworkClient({
|
|
|
52
52
|
});
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
### API URL builds
|
|
56
|
-
|
|
57
|
-
`https://sdk.gib.work` is embedded into normal package builds. SDK maintainers
|
|
58
|
-
can produce an environment-specific build by setting `GIBWORK_SDK_API_URL`
|
|
59
|
-
while building:
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
GIBWORK_SDK_API_URL=https://sdk-stage.gib.work npm run build
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
The selected URL is compiled into `dist`; installed applications do not need
|
|
66
|
-
that environment variable. `DEFAULT_GIBWORK_API_URL` exposes the embedded
|
|
67
|
-
value.
|
|
68
|
-
|
|
69
|
-
For local tests or custom deployments, `baseUrl` remains an optional runtime
|
|
70
|
-
override:
|
|
71
|
-
|
|
72
|
-
```ts
|
|
73
|
-
const gibwork = createGibworkClient({
|
|
74
|
-
privateKey: process.env.SOLANA_PRIVATE_KEY!,
|
|
75
|
-
baseUrl: 'http://localhost:3334',
|
|
76
|
-
});
|
|
77
|
-
```
|
|
78
|
-
|
|
79
55
|
## Methods
|
|
80
56
|
|
|
81
57
|
```ts
|
|
@@ -147,26 +123,8 @@ npm install
|
|
|
147
123
|
npm run check
|
|
148
124
|
```
|
|
149
125
|
|
|
150
|
-
The package
|
|
151
|
-
|
|
152
|
-
resolved before the first npm publish.
|
|
153
|
-
|
|
154
|
-
## Structure
|
|
155
|
-
|
|
156
|
-
```text
|
|
157
|
-
src/
|
|
158
|
-
auth/ Request normalization, hashing, nonces, and signatures
|
|
159
|
-
client/ Top-level SDK client and configuration
|
|
160
|
-
errors/ Typed SDK and API errors
|
|
161
|
-
resources/ Task and submission resource clients
|
|
162
|
-
signers/ Wallet signer contracts and opt-in adapters
|
|
163
|
-
transactions/ Prepare, sign, and submit orchestration
|
|
164
|
-
transport/ HTTP transport, response parsing, and retry policy
|
|
165
|
-
types/ Public request and response types
|
|
166
|
-
tests/
|
|
167
|
-
integration/ Tests against a running External API
|
|
168
|
-
unit/ Isolated SDK behavior tests
|
|
169
|
-
```
|
|
126
|
+
The package currently remains `UNLICENSED`; select and add the intended public
|
|
127
|
+
license before treating the release as generally reusable open-source software.
|
|
170
128
|
|
|
171
129
|
## Private-key safety
|
|
172
130
|
|