@oneaddress/setup 1.1.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/README.md +56 -0
- package/dist/index.js +3515 -0
- package/package.json +32 -0
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# @oneaddress/setup
|
|
2
|
+
|
|
3
|
+
Interactive setup wizard for OneAddress partner webhook integrations.
|
|
4
|
+
|
|
5
|
+
## Quick start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @oneaddress/setup
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
The wizard:
|
|
12
|
+
|
|
13
|
+
1. Collects your three credentials from the [Partner Portal](https://partners.oneaddress.io):
|
|
14
|
+
- Partner ID (UUID)
|
|
15
|
+
- Webhook Secret (HMAC-SHA256)
|
|
16
|
+
- ECDH P-256 Private Key PEM
|
|
17
|
+
2. Asks which platform you want — TypeScript / Python / Go / PHP / Java / C#
|
|
18
|
+
3. Scaffolds a working webhook server into the directory you choose
|
|
19
|
+
4. Installs dependencies for that platform
|
|
20
|
+
5. Starts the server and waits for `/health`
|
|
21
|
+
6. Opens a free Cloudflare HTTPS tunnel (or accepts a URL you provide)
|
|
22
|
+
7. Registers the webhook URL in the Partner Portal
|
|
23
|
+
8. Runs the conformance check against your live URL
|
|
24
|
+
|
|
25
|
+
If everything passes, you're integrated.
|
|
26
|
+
|
|
27
|
+
## What you get
|
|
28
|
+
|
|
29
|
+
A real webhook server (not a toy) with:
|
|
30
|
+
|
|
31
|
+
- HMAC-SHA256 signature verification (timing-safe via Web Crypto)
|
|
32
|
+
- ECDH P-256 + HKDF-SHA256 + AES-256-GCM address decryption
|
|
33
|
+
- Replay-window enforcement (±5 min) before signature verify
|
|
34
|
+
- Persistent dispatch deduplication
|
|
35
|
+
- Address normalisation helper
|
|
36
|
+
- For TypeScript: an optional 250-customer demo database with end-to-end matching
|
|
37
|
+
|
|
38
|
+
## Customise the match logic
|
|
39
|
+
|
|
40
|
+
Open the entry-point file the wizard prints on completion (`src/match.ts` for ts-node,
|
|
41
|
+
`app.py` for Python, etc.) and replace the demo logic with your real database lookup.
|
|
42
|
+
The README inside the scaffolded project walks through the pattern.
|
|
43
|
+
|
|
44
|
+
## Re-run the conformance check
|
|
45
|
+
|
|
46
|
+
From the [Partner Portal](https://partners.oneaddress.io) → My Profile → Integration Conformance.
|
|
47
|
+
|
|
48
|
+
## Documentation
|
|
49
|
+
|
|
50
|
+
- [Partner Portal](https://partners.oneaddress.io)
|
|
51
|
+
- [Protocol Specification](https://github.com/oneaddress-io/oneaddress-app/blob/main/docs/integration/SPEC.md)
|
|
52
|
+
- [Service Level Objectives](https://github.com/oneaddress-io/oneaddress-app/blob/main/docs/integration/SLOS.md)
|
|
53
|
+
|
|
54
|
+
## Issues
|
|
55
|
+
|
|
56
|
+
partners@oneaddress.io
|