UNPKG

paid-services

Version:

Lightning Paid Services library

github.com/alexbosworth/paid-services

alexbosworth/paid-services

102 lines (64 loc) • 2.06 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# Lightning Network Paid Services Paid service APIs that use KeySend as an interface. ## Default Services ### ping This service delivers a pong message response ### schema This service responds with metadata about a service ### services This service delivers a list of available services ## Extended Services Other services can be configured and enabled using their relevant environment variables. ### `activity` Return high level information about node routing activity. To enable this service, specify activity to share. ``` # Share the fees earned PAID_SERVICES_ACTIVITY_FEES=1 # Share the forwarding total PAID_SERVICES_ACTIVITY_VOLUME=1 ``` ### `connect` Initiate a connection to a node to peer with them ``` # Enable connect service PAID_SERVICES_CONNECT=1 ``` ### `inbox` Deliver a short message via SMS or email. To enable this service, configure the environment for sending messages: ``` # Use Postmark email for your inbox PAID_SERVICES_INBOX_EMAIL_FROM="email to send from" PAID_SERVICES_INBOX_EMAIL_TO="email to send to" PAID_SERVICES_INBOX_POSTMARK_API_KEY="postmark API key" # Use Twilio SMS for your inbox PAID_SERVICES_INBOX_SMS_FROM_NUMBER="Number to send from" PAID_SERVICES_INBOX_SMS_TO_NUMBER="Number to send to" PAID_SERVICES_INBOX_TWILIO_ACCOUNT_SID="Twilio account id" PAID_SERVICES_INBOX_TWILIO_AUTH_TOKEN="Twilio account id" PAID_SERVICES_INBOX_PRICE="optional sats price to charge for inbox message" ``` ### `invoice` Request a signed BOLT 11 encoded payment request ``` # Enable invoice service PAID_SERVICES_INVOICE=1 ``` ### `network` Reference other nodes that offer paid services: ``` PAID_SERVICES_NETWORK_NODES="comma separated node public keys" ``` ### `profile` Return a short profile description of your node. To enable this service, set the profile of your node: ``` PAID_SERVICES_PROFILE_FOR_NODE="detail text about this node" PAID_SERVICES_PROFILE_URLS="URL\nOTHER_URL" (separate multiple with newlines) ``` ### `relay` Return a relay payment request ``` PAID_SERVICES_RELAY="1" ```