@xkova/sdk 0.1.0-alpha.1 → 0.1.0-alpha.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 -10
- package/llms.txt +1 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ holders, wallets, payments, tokenization, and other customer resources.
|
|
|
6
6
|
## Install
|
|
7
7
|
|
|
8
8
|
```bash
|
|
9
|
-
npm install @xkova/sdk@0.1.0-alpha.
|
|
9
|
+
npm install @xkova/sdk@0.1.0-alpha.2
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Requires Node.js 22 or newer. Keep this package and your API keys on the server.
|
|
@@ -412,7 +412,7 @@ import { verifyWebhookSignature } from '@xkova/sdk/webhook';
|
|
|
412
412
|
import type { components, paths } from '@xkova/sdk/types';
|
|
413
413
|
```
|
|
414
414
|
|
|
415
|
-
Pass the raw request body to `verifyWebhookSignature`.
|
|
415
|
+
Pass the raw request body to `verifyWebhookSignature`. Import request and response types from `@xkova/sdk/types`.
|
|
416
416
|
|
|
417
417
|
The package also exposes `@xkova/sdk/rwa-verify` for offline RWA transparency proof verification and `@xkova/sdk/abi` for the documented customer contract ABIs.
|
|
418
418
|
|
|
@@ -432,14 +432,6 @@ idempotency, and settlement. It links the public customer OpenAPI and expanded
|
|
|
432
432
|
documentation. Installed declarations determine the methods available in your
|
|
433
433
|
version; live documentation may describe a newer release.
|
|
434
434
|
|
|
435
|
-
## Thirdweb and dependencies
|
|
436
|
-
|
|
437
|
-
The only direct runtime dependency is `viem`, used for offline RWA signature
|
|
438
|
-
verification. This SDK does not import Thirdweb. The optional `@xkova/browser`
|
|
439
|
-
browser companion has no runtime dependencies. XKOVA manages wallet signing,
|
|
440
|
-
and API provider metadata may name Thirdweb. You do not need to install its SDK
|
|
441
|
-
or obtain Thirdweb credentials.
|
|
442
|
-
|
|
443
435
|
## Contributing
|
|
444
436
|
|
|
445
437
|
Run `pnpm check` from the source repository root before committing. The
|
package/llms.txt
CHANGED
|
@@ -22,7 +22,6 @@ Use this package on a Node.js 22+ server. Read the installed declarations before
|
|
|
22
22
|
1. Server business integration: create XKOVAClient.forTenant({ baseUrl, apiKey }). Use https://sandbox-api.xkova.com for sandbox and https://api.xkova.com for production. The API key binds the workspace and mode.
|
|
23
23
|
2. Member application: use XKOVAMemberBffClient from @xkova/sdk/member-bff in your BFF. Resolve confidential sessions to request-scoped resources with resolveResources(). The browser sends only its application cookie and CSRF proof to your BFF.
|
|
24
24
|
3. Browser companion: optionally install @xkova/browser. It calls your same-origin routes; it does not create those routes or install a session store.
|
|
25
|
-
4. Institution staff and management: use the Console and its documented setup flows. Do not invent customer SDK methods for API-key lifecycle, treasury administration, staff governance, or platform management.
|
|
26
25
|
|
|
27
26
|
## Find a capability
|
|
28
27
|
|
|
@@ -58,7 +57,7 @@ API availability does not grant permission. Product entitlement, selected API-ke
|
|
|
58
57
|
## Requests and results
|
|
59
58
|
|
|
60
59
|
- Start with the README's sandbox read example. Validate required environment variables on the server; never emit their values into logs, generated files, browser bundles, or prompts.
|
|
61
|
-
- Use exported package entry points and typed resource methods. Do not import dist files as runtime subpaths,
|
|
60
|
+
- Use exported package entry points and typed resource methods. Do not import dist files as runtime subpaths, fabricate request fields, or suppress type errors with any.
|
|
62
61
|
- Production writes require the bearer key plus an active asymmetric requestSigner credential. Its async callback signs through your key provider. The SDK supplies RFC 9421 signatures and RFC 9530 digests. Production reads use bearer authentication.
|
|
63
62
|
- Generate one idempotency key before a logical mutation and persist it. Reuse it only with the identical request. The SDK does not automatically retry writes. A timeout or disconnect can leave the outcome unknown; reconcile the existing resource before starting another operation.
|
|
64
63
|
- Use decimal strings for monetary values according to the request type. Preserve asset and chain identity throughout a flow. Do not perform monetary calculations with JavaScript floating-point numbers.
|
|
@@ -75,10 +74,6 @@ API availability does not grant permission. Product entitlement, selected API-ke
|
|
|
75
74
|
- Reuse one createMemberActionReference() from @xkova/browser for a durable review. Save the draft before setup detours. Expired or missing reviews require checking activity and an explicit new review.
|
|
76
75
|
- Setup readiness is advisory. beginMemberAction() and completeMemberAction() obtain fresh approval for the exact resource. Browser code must not receive provider wallet credentials or internal signing capabilities. Completion of authorization is distinct from execution and settlement.
|
|
77
76
|
|
|
78
|
-
## Dependencies
|
|
79
|
-
|
|
80
|
-
The server SDK uses viem for offline RWA signature verification. The browser companion has no runtime dependencies. Neither imports Thirdweb. You may see Thirdweb in API provider metadata, but these integrations require no Thirdweb SDK or credentials.
|
|
81
|
-
|
|
82
77
|
## Before handing off code
|
|
83
78
|
|
|
84
79
|
List the Console setup and stores the application needs. Test denied access, uncertain writes, pagination, cancellation, and terminal outcomes. Report a missing method or setup requirement explicitly. Do not invent methods, suppress type errors, or bypass authorization to make an example run.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xkova/sdk",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.0-alpha.2",
|
|
4
|
+
"description": "TypeScript SDK for the XKOVA API.",
|
|
5
5
|
"homepage": "https://docs.xkova.com",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|