@vera-pay/sdk 0.1.0 → 0.1.1
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 +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @vera-pay/sdk
|
|
2
2
|
|
|
3
3
|
On-chain subscription payments SDK for [Flow Blockchain](https://flow.com). Create plans, accept recurring stablecoin payments, schedule autonomous on-chain payment processing, and pin immutable receipts to IPFS via [Storacha](https://storacha.network) (Protocol Labs).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @
|
|
8
|
+
npm install @vera-pay/sdk ethers
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
`ethers` v6 is a peer dependency.
|
|
@@ -28,7 +28,7 @@ Both support optional IPFS integration for pinning payment receipts.
|
|
|
28
28
|
### 1. Connect to VeraPay
|
|
29
29
|
|
|
30
30
|
```typescript
|
|
31
|
-
import { VeraPayClient, createStorachaAdapter, DEPLOYED_CONTRACTS } from "@
|
|
31
|
+
import { VeraPayClient, createStorachaAdapter, DEPLOYED_CONTRACTS } from "@vera-pay/sdk";
|
|
32
32
|
import { ethers } from "ethers";
|
|
33
33
|
|
|
34
34
|
const provider = new ethers.BrowserProvider(window.ethereum);
|
|
@@ -51,7 +51,7 @@ const client = VeraPayClient.fromNetwork(
|
|
|
51
51
|
### 2. Create a Subscription Plan (Merchant)
|
|
52
52
|
|
|
53
53
|
```typescript
|
|
54
|
-
import { KNOWN_TOKENS } from "@
|
|
54
|
+
import { KNOWN_TOKENS } from "@vera-pay/sdk";
|
|
55
55
|
|
|
56
56
|
const { planId } = await client.createPlan({
|
|
57
57
|
paymentToken: KNOWN_TOKENS["flow-testnet"].USDC,
|
|
@@ -76,7 +76,7 @@ console.log("IPFS receipt:", receipt.ipfsCid);
|
|
|
76
76
|
### 4. Schedule Recurring Payments (No Keeper Needed)
|
|
77
77
|
|
|
78
78
|
```typescript
|
|
79
|
-
import { FlowScheduler, CADENCE_HANDLERS } from "@
|
|
79
|
+
import { FlowScheduler, CADENCE_HANDLERS } from "@vera-pay/sdk";
|
|
80
80
|
|
|
81
81
|
const scheduler = new FlowScheduler({
|
|
82
82
|
network: "testnet",
|
|
@@ -254,7 +254,7 @@ storacha delegation create did:key:z6Mk... \
|
|
|
254
254
|
### Use in Code
|
|
255
255
|
|
|
256
256
|
```typescript
|
|
257
|
-
import { createStorachaAdapter } from "@
|
|
257
|
+
import { createStorachaAdapter } from "@vera-pay/sdk";
|
|
258
258
|
|
|
259
259
|
const ipfs = createStorachaAdapter({
|
|
260
260
|
key: "MgCaT7Se2QX9...", // from `storacha key create`
|
|
@@ -332,7 +332,7 @@ import {
|
|
|
332
332
|
// ABIs
|
|
333
333
|
VERA_PAY_ABI,
|
|
334
334
|
ERC20_ABI,
|
|
335
|
-
} from "@
|
|
335
|
+
} from "@vera-pay/sdk";
|
|
336
336
|
```
|
|
337
337
|
|
|
338
338
|
---
|