@atumlabs/payment-gateway-client 1.0.1 → 1.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +7 -39
  3. package/package.json +3 -2
package/CHANGELOG.md ADDED
@@ -0,0 +1,25 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [1.0.2] - 2026-07-17
9
+
10
+ ### Added
11
+ - Turnkey signing provider: sign payments with a Turnkey-managed wallet using `--provider turnkey` (CLI and SDK), as an alternative to a local private key. The sender address is resolved from and verified against the Turnkey wallet per source chain.
12
+
13
+ ### Changed
14
+ - README now targets npm consumers; the monorepo source setup moved to `CONTRIBUTING.md`.
15
+
16
+ ## [1.0.1] - 2024-12-04
17
+
18
+ ### Added
19
+ - Help documentation now includes instructions on how to check payment status
20
+
21
+ ### Changed
22
+ - Default payment gateway now points to prod-testnet instead of staging-testnet
23
+
24
+ ### Fixed
25
+ - CLI now properly respects the `/defaults` fulfillment verifier endpoint
package/README.md CHANGED
@@ -8,47 +8,15 @@ TypeScript client for Atum Payment Gateway API with CLI support.
8
8
 
9
9
  ## Installation
10
10
 
11
- The package can be published to npm or to GitHub Packages (same artifact). Install
12
- from whichever registry it was published to.
13
-
14
- ### From npm (public)
11
+ `@atumlabs/payment-gateway-client` is a private npm package. Once your npm account
12
+ has been granted access, install it with npm:
15
13
 
16
14
  ```bash
17
- npm install @atum-labs/payment-gateway-client
15
+ npm install @atumlabs/payment-gateway-client
18
16
  ```
19
17
 
20
- ### From GitHub Packages (private)
21
-
22
- Point the `@atum-labs` scope at GitHub's npm registry and authenticate with a
23
- classic personal access token that has the `read:packages` scope. Add an `.npmrc`
24
- in your project (or `~/.npmrc`):
25
-
26
- ```
27
- @atum-labs:registry=https://npm.pkg.github.com
28
- //npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
29
- ```
30
-
31
- Then `npm install @atum-labs/payment-gateway-client`. Your GitHub account must
32
- have been granted read access to the package.
33
-
34
- Either way this also installs the `send-payment`, `request-quote`,
35
- `quote-status`, and `payment-status` CLI commands.
36
-
37
- ### From source (monorepo)
38
-
39
- payment-gateway-client lives inside the protocol monorepo. To work on it from source:
40
-
41
- ```bash
42
- git clone https://github.com/Atum-Labs/protocol.git
43
- cd protocol
44
-
45
- # Install the workspace with pnpm. This builds payment-gateway-client and its
46
- # in-repo deps (km-core, turnkey-signer, solana-escrow-encoding) via the workspace:
47
- pnpm install
48
-
49
- # (Optional) expose the CLI globally:
50
- cd payment-gateway-client && pnpm link --global
51
- ```
18
+ This also installs the `send-payment`, `request-quote`, `quote-status`, and
19
+ `payment-status` CLI commands.
52
20
 
53
21
  ## CLI Usage
54
22
 
@@ -142,7 +110,7 @@ PRIVATE_KEY=0xabc... send-payment \
142
110
  To remove the global CLI command:
143
111
 
144
112
  ```bash
145
- npm unlink -g @atum-labs/payment-gateway-client
113
+ npm unlink -g @atumlabs/payment-gateway-client
146
114
  ```
147
115
 
148
116
  ## SDK Usage
@@ -154,7 +122,7 @@ import {
154
122
  PaymentGatewayClient,
155
123
  type PaymentResponse,
156
124
  ApiError
157
- } from '@atum-labs/payment-gateway-client';
125
+ } from '@atumlabs/payment-gateway-client';
158
126
  import { ethers } from 'ethers';
159
127
 
160
128
  const client = new PaymentGatewayClient({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atumlabs/payment-gateway-client",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "TypeScript client for Atum Payment Gateway API",
5
5
  "author": "Atum Labs, Inc.",
6
6
  "homepage": "https://github.com/Atum-Labs/protocol/tree/main/payment-gateway-client#readme",
@@ -74,7 +74,8 @@
74
74
  "uuid": "^9.0.0"
75
75
  },
76
76
  "files": [
77
- "dist/**/*"
77
+ "dist/**/*",
78
+ "CHANGELOG.md"
78
79
  ],
79
80
  "license": "MIT"
80
81
  }