-
Notifications
You must be signed in to change notification settings - Fork 20
/
woocommerce-gateway-lightning.php
executable file
·277 lines (236 loc) · 10.9 KB
/
woocommerce-gateway-lightning.php
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?php
/*
Plugin Name: WooCommerce Lightning Gateway
Plugin URI: https://github.com/ElementsProject/woocommerce-gateway-lightning
Description: Enable your WooCommerce store to accept Bitcoin Lightning payments.
Author: Blockstream
Author URI: https://blockstream.com
Version: 0.2.7
GitHub Plugin URI: https://github.com/ElementsProject/woocommerce-gateway-lightning
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
register_activation_hook( __FILE__, function(){
if (!extension_loaded('gd') || !extension_loaded('curl')) {
die('The php-curl and php-gd extensions are required. Please contact your hosting provider for additional help.');
}
});
require_once 'vendor/autoload.php';
define('LIGHTNING_HOOK_KEY', hash_hmac('sha256', 'lightning-hook-token', AUTH_KEY));
define('LIGHTNING_LONGPOLL_TIMEOUT', min(120, max(5, ini_get('max_execution_time') * 0.8)));
if (!function_exists('init_wc_lightning')) {
function init_wc_lightning() {
if (!class_exists('WC_Payment_Gateway')) return;
class WC_Gateway_Lightning extends WC_Payment_Gateway {
public function __construct() {
$this->id = 'lightning';
$this->order_button_text = __('Proceed to Lightning Payment', 'woocommerce');
$this->method_title = __('Lightning', 'woocommerce');
$this->method_description = __('Lightning Network Payment');
//$this->icon = plugin_dir_url(__FILE__).'assets/img/icon.png';
$this->supports = array();
// Load the settings.
$this->init_form_fields();
$this->init_settings();
// Define user set variables.
$this->title = $this->get_option('title');
$this->description = $this->get_option('description');
// Lightning Charge REST client
$this->charge = new LightningChargeClient($this->get_option('charge_url', 'http://localhost:9112'), $this->get_option('charge_token'));
add_action('woocommerce_payment_gateways', array($this, 'register_gateway'));
add_action('woocommerce_update_options_payment_gateways_lightning', array($this, 'process_admin_options'));
add_action('woocommerce_api_wc_gateway_lightning', array($this, 'webhook_callback'));
add_action('woocommerce_receipt_lightning', array($this, 'show_payment_info'));
add_action('woocommerce_thankyou_lightning', array($this, 'show_payment_info'));
add_action('wp_ajax_ln_wait_invoice', array($this, 'wait_invoice'));
add_action('wp_ajax_nopriv_ln_wait_invoice', array($this, 'wait_invoice'));
}
/**
* Initialise Gateway Settings Form Fields.
*/
public function init_form_fields() {
$this->form_fields = array(
'enabled' => array(
'title' => __( 'Enable/Disable', 'woocommerce-gateway-lightning' ),
'label' => __( 'Enable Lightning payments', 'woocommerce-gateway-lightning' ),
'type' => 'checkbox',
'description' => '',
'default' => 'no',
),
'title' => array(
'title' => __('Title', 'lightning'),
'type' => 'text',
'description' => __('Controls the name of this payment method as displayed to the customer during checkout.', 'lightning'),
'default' => __('Bitcoin Lightning', 'lightning'),
'desc_tip' => true,
),
'charge_url' => array (
'title' => __('Lightning Charge server', 'lightning'),
'type' => 'text',
'description' => __('URL of the Lightning Charge REST server to connect to.', 'lightning'),
'default' => __('http://localhost:9112', 'lightning'),
'desc_tip' => true,
),
'charge_token' => array (
'title' => __('Lightning Charge API token', 'lightning'),
'type' => 'text',
'description' => __('API access token configured in the Lightning Charge server.', 'lightning'),
'desc_tip' => true,
),
'description' => array(
'title' => __('Customer Message', 'lightning'),
'type' => 'textarea',
'description' => __('Message to explain how the customer will be paying for the purchase.', 'lightning'),
'default' => 'You will pay using the Lightning Network.',
'desc_tip' => true,
),
'invoice_expiry' => array(
'title' => __('Invoice Expiry', 'lightning'),
'type' => 'text',
'description' => __('Time til an invoice expires. Examples: 2w (2 weeks), 1m (1 month), 3h (3 hours), 3600s (3600 seconds). Defaults to 2h.', 'lightning'),
'default' => '2h',
'desc_tip' => true,
),
);
}
/**
* Process the payment and return the result.
* @param int $order_id
* @return array
*/
public function process_payment( $order_id ) {
$order = wc_get_order($order_id);
$invoice = $order->get_meta('_lightning_invoice');
if (!$invoice) {
$invoice = $this->charge->invoice([
'currency' => $order->get_currency(),
'amount' => $order->get_total(),
'description' => self::make_desc($order),
'expiry' => $this->get_option('invoice_expiry', '2h'),
'metadata' => [ 'source' => 'woocommerce-gateway', 'order_id' => $order->get_id(), 'url' => get_home_url() ],
'webhook' => self::get_webhook_url($order->get_id())
]);
$this->update_invoice($order, $invoice);
$order->add_order_note(sprintf(__('Lightning Charge invoice created, id=%s, rhash=%s.', 'lightning'), $invoice->id, $invoice->rhash));
}
return array(
'result' => 'success',
'redirect' => $order->get_checkout_payment_url(true)
);
}
/**
* Process webhook callbacks.
*/
public function webhook_callback() {
if (!self::verify_token($_GET['order'], $_GET['token'])) wp_die('invalid token');
$order = wc_get_order($_GET['order']);
$invoice = json_decode(file_get_contents("php://input"));
if (!$invoice) {
status_header(400);
wp_die('cannot decode request body invoice');
}
$order->add_order_note(__('Lightning webhook notification received.', 'lightning'));
$this->update_invoice($order, $invoice);
}
/**
* JSON endpoint for long polling payment updates.
*/
public function wait_invoice() {
$paid_inv = $this->charge->wait($_POST['invoice_id'], LIGHTNING_LONGPOLL_TIMEOUT);
if ($paid_inv) {
$order = wc_get_order($paid_inv->metadata->order_id);
$this->update_invoice($order, $paid_inv);
wp_send_json(true);
} else {
status_header($paid_inv === false ? 410 : 402);
wp_send_json(false);
}
}
/**
* Hooks into the checkout page to display Lightning-related payment info.
*/
public function show_payment_info($order_id) {
global $wp;
$order = wc_get_order($order_id);
if (!empty($wp->query_vars['order-received']) && $order->needs_payment()) {
// thankyou page requested, but order is still unpaid
wp_redirect($order->get_checkout_payment_url(true));
exit;
}
$invoice = $order->get_meta('_lightning_invoice');
if ($invoice->status == 'unpaid') {
$invoice = $this->charge->fetch($invoice->id);
$this->update_invoice($order, $invoice);
}
if ($order->has_status('cancelled')) {
// invoice expired, reload page to display expiry message
wp_redirect($order->get_checkout_payment_url(true));
exit;
}
if ($order->needs_payment()) {
$qr_uri = self::get_qr_uri($invoice);
require __DIR__.'/templates/payment.php';
} elseif ($order->has_status(array('processing', 'completed'))) {
require __DIR__.'/templates/completed.php';
}
}
/**
* Register as a WooCommerce gateway.
*/
public function register_gateway($methods) {
$methods[] = $this;
return $methods;
}
protected function update_invoice($order, $invoice) {
$order->update_meta_data('_lightning_invoice', $invoice);
$order->update_meta_data('lightning_id', $invoice->id);
$order->update_meta_data('lightning_rhash', $invoice->rhash);
$order->update_meta_data('lightning_msatoshi', $invoice->msatoshi);
if ($invoice->status === 'paid') $order->update_meta_data('lightning_msatoshi_received', $invoice->msatoshi_received);
$order->save_meta_data();
if ($invoice->status == 'paid' && $order->needs_payment()) {
$order->payment_complete($invoice->id);
} else if ($invoice->status == 'expired' && $order->has_status(array('pending', 'on-hold'))) {
$order->update_status('cancelled', 'Lightning invoice expired');
}
}
protected static function make_token($order_id) {
return hash_hmac('sha256', $order_id, LIGHTNING_HOOK_KEY);
}
protected static function verify_token($order_id, $token) {
return self::make_token($order_id) === $token;
}
protected static function get_webhook_url($order_id) {
return add_query_arg(array('order' => $order_id, 'token' => self::make_token($order_id)),
WC()->api_request_url('WC_Gateway_Lightning'));
}
protected static function get_qr_uri($invoice) {
$renderer = new \BaconQrCode\Renderer\Image\Png;
$renderer->setWidth(180);
$renderer->setHeight(180);
$renderer->setMargin(0);
$writer = new \BaconQrCode\Writer($renderer);
$image = $writer->writeString(strtoupper('lightning:' . $invoice->payreq));
return 'data:image/png;base64,' . base64_encode($image);
}
protected static function make_desc($order) {
$total = $order->get_total() . ' ' .$order->get_currency();
$desc = get_bloginfo('name') . ': ' . $total . ' for ';
$products = $order->get_items();
for ($n=0; strlen($desc) < 100 && count($products); $n++) {
$product = array_shift($products);
if (count($products)) $desc .= $product['name'] . ' x ' . $product['qty'] . ', ';
else $desc = ($n ? substr($desc, 0, -2) . ' and ' : $desc) . $product['name'].' x '.$product['qty'];
}
if (count($products)) $desc = substr($desc, 0, -2) . ' and ' . count($products) . ' more items';
return $desc;
}
protected static function format_msat($msat) {
return rtrim(rtrim(number_format($msat/100000000, 8), '0'), '.') . ' mBTC';
}
}
new WC_Gateway_Lightning();
}
add_action('plugins_loaded', 'init_wc_lightning');
}