forked from nmarley/dashpayments-for-woocommerce
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
103 lines (64 loc) · 4.94 KB
/
readme.txt
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
=== DashPayments for WooCommerce ===
Contributors: nmarley
Tags: dash, dash wordpress plugin, dash plugin, dash payments, accept dash, dash, pay-with-dash
Requires at least: 4.4
Tested up to: 4.4
Stable tag: release
License: MIT
License URI: https://opensource.org/licenses/MIT
Donate link: http://dash:XdBKajV4g2wnpnAvvnV9dxwypQMfFHYWtp
== Description ==
DashPayments for WooCommerce is a Wordpress plugin that enables WooCommerce merchants to accept Dash directly, without the need for a third-party payment processor.
= Benefits =
* Accept Dash payments directly to your Electrum-Dash wallet.
* No payment processors or fees.
* Recycles addresses from expired, unpaid orders
== Installation ==
1. Install WooCommerce and configure your store.
2. Install and activate "DashPayments for WooCommerce" just like any other Wordpress plugin.
3. Download and install Electrum-Dash wallet from here: https://www.dash.org/downloads/
4. Run the Electrum-Dash program and setup your wallet for the first time.
5. Find your Electrum-Dash wallet's Extended Public Key ("xpub") by navigating to:
Wallet -> Master Public Key
6. Within your site's Wordpress admin panel, navigate to:
WooCommerce -> Settings -> Checkout -> Dash
7. Paste your xpub key from step #5 into the proper field and press [Save changes]
8. If you see the message stating "Dash payment gateway is operational.", then your store is ready to accept payments in Dash.
9. It is **HIGHLY RECOMMEND** that you set up hard-cron for your WP/WooCommerce site and schedule it to run every minute.
10. We also highly caution against using shared hosting, such as HostGator. The benefits of using a VPN service and setting up your own virtual server are well worth the $5-10/month cost.
== Frequently Asked Questions ==
None yet, but I'll answer what I predict to be FAQs:
= Is this secure? =
Short answer, yes.
Because this plugin only accepts [BIP32 **public** keys](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki "BIP0032") to generate addresses, your Dash can never be stolen (because the private keys won't ever exist on your server). If private keys are entered, they are detected and marked as invalid.
Read the "external dependencies" question for the longer answer.
= Does this support InstantX transactions? =
We do fully intend do support InstantX transactions in the future, as that's one of the most attractive features available with Dash. However, at the moment, the priority is getting this into the hands of as many online businesses as possible who want to start accepting Dash. It will take a bit of time and effort to get InstantX receive support built into the plugin.
= Does this support Darksend? =
As long as the funds get sent to the customer address, yes. It aggregates payments from multiple transactions, and only marks an order as paid (or overpaid) once the address balance meets (or exceeds) the order total.
= Does this support refunds? =
Nope. The plugin has no access to spend any funds whatsoever. The site owner is responsible for any customer refunds. They will have to be sent from a wallet outside of the scope of this plugin. (*Ahem*, the same Electrum wallet used to setup the gateway?)
= Are there any external dependencies? =
Yes. One is mandatory and one is optional.
The *mandatory dependency* is an up-to-date Insight-API server, accessible over the network by your server. You can specify your own instance in the gateway settings, or use the default server, which is hosted by the author of this plugin. This is required in order to know if payment has been sent to the addresses given to your customers.
In order to remove this third-party dependencies, you can host your own version of Insight-API and use that URL. If you host it on the same server as WordPress, you can use http://localhost:<port>/ as the URL and use a firewall to prevent anyone else from accessing your Insight-API instance. This should reduce network latency (obviously) and will remove your dependency on a trusted third party.
The *optional dependency* is an exchange rate API server, which is currently served by me, the author of this plugin. **In order to disable this, simply denominate your store in Dash.**
In the future, this will either be delegated to something like coinmarketcap (not ideal), or an open-source webservice URL which can be specified by the admin, just like the Insight-API service described above.
== Screenshots ==
1. Checkout with option for Dash payment.
2. Order received screen, including QR code of Dash address and payment amount.
3. Dash Gateway settings screen.
== Remove plugin ==
1. Deactivate plugin through the 'Plugins' menu in WordPress
2. Delete plugin through the 'Plugins' menu in WordPress
== Changelog ==
= 0.0.5 =
* Use Insight-API provided by Dash.org
= 0.0.4 =
* Bugfix: Account for differences in sync-status output of Insight-API.
= 0.0.3 =
* Allow for older versions of PHP.
= 0.0.2 =
* bugfix: Warn if required PHP extensions not enabled.
= 0.0.1 =
* New