=== VerusPay Verus Gateway ===

Contributors: veruspay, joliverwestbrook Donate link: https://veruspay.io/donate/ Tags: woocommerce, payment gateway, gateway, cryptocurrency, blockchain, verus, verus coin, vrsc Requires at least: 3.8 Tested up to: 5.1 Requires PHP: 7.0 Stable tag: 0.1.2 Requires WooCommerce at least: 2.1 Tested WooCommerce up to: 3.5.5 License: MIT License URI: https://opensource.org/licenses/MIT

* The MIT License (MIT)
* 
* Copyright (c) 2019 John Oliver Westbrook
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* 
* ====================

=== Description ===

Requires: WooCommerce 2.1+

• Build a WordPress plugin zip: Clone the source into a folder called "veruspay-woocommerce" or similar. Zip that folder and upload as a plugin within WordPress. NOTE: if you download a Zip from Github you will need to extract the folder within, then create a zip from that folder before installing.

This plugin extends WooCommerce, adding the ability to accept cryptocurrency payments in Verus Coin (VRSC) using either an on-store wallet daemon (best for VPS or dedicated hosting stores) or manually configured VRSC addresses (best for shared hosting stores).

When an order is submitted via the VerusPay gateway, the order will be placed "on-hold" while awaiting payment from the customer. The customer has a limited time wherein to send the payment and the store monitors the wallet/address to confirm payment received before releasing the order and redirecting the customer to the Thank You page.

VerusPay uses limited API functionality for Manual Mode, to communicate with the blockchain explorer in verifying payments and with the veruspay.io API to get up-to-date price data. These API's do not receive any private data either about the store owner, store, or customer. The only data sent to the block explorer API is the public/transparent blockchain transaction and address used. For VerusPay.io API price data, only the store-set currency is sent to retrieve the current fiat exchange rate for Verus Coin.

API's in use: 1 - https://veruspay.veruscoin.io 2 - https://explorer.veruscoin.io

=== More Details ===

• Learn about the Verus Coin official site for more information about the community project
• Join the Verus Coin Discord for support.
• More documentation coming in a next release.

=== Requirements ===

There are two modes in which you can run VerusPay: Live or Manual

Live Mode In Live Mode you connect directly with the RPC daemon of a Verus wallet on your e-commerce VPS or similar server. This is NOT intended for shared hosting plans, you must be on a VPS or similar where you have SSH access and the ability to run applications per your hosting providers terms.

Suggested Server Minimum: 2GB RAM, 1 CPU, CentOS or Ubuntu

Manual Mode Manual Mode is always a "fallback", even for Live Mode operation, but also allows shared hosting store owners to use VerusPay without the additional step of setting up and configuring a Verus wallet on their web store. You still need access to a Verus wallet you own however.

=== Plugin Installation ===

1. If you need help setting up WordPress, follow this guide for your OS: https://www.digitalocean.com/community/tutorials/how-to-install-wordpress-with-lamp-on-ubuntu-18-04
2. Be sure you're running WooCommerce 2.1+ in your store. THIS MUST BE INSTALLED, ACTIVATED, AND CONFIGURED FIRST.
3. Install the VerusPay Plugin into the Wordpress plugins folder (create a zip from a cloned folder of the repo), at Plugins > Add New > Upload
4. Activate the plugin through the Plugins menu in WordPress
5. Go to WooCommerce > Settings > Checkout or WooCommerce > Settings > Payments in newer versions, and select "VerusPay" to configure

=== Verus Wallet Installation ===

1. From the web server in an SSH session first get the dependencies with: sudo apt --yes install build-essential pkg-config libc6-dev m4 g++-multilib autoconf libtool ncurses-dev unzip git python python-zmq zlib1g-dev wget libcurl4-openssl-dev bsdmainutils automake curl

2. Next, get the latest version of Verus CLI for Linux here: https://github.com/VerusCoin/VerusCoin/releases/latest

3. Unzip the file in your server's home directory with: tar -xvf Verus-CLI-Linux-version.tar.gz

4. For faster install, create the VRSC hidden directory and download the latest Verus bootstrap. Create the directory with:

   mkdir -p .komodo/VRSC cd ~/.komodo/VRSC wget https://bootstrap.0x03.services/veruscoin/VRSC-bootstrap.tar.gz tar -xvf bootstrap.0x03.services/veruscoin/VRSC-bootstrap.tar.gz

5. Install the Zcash params, from within your home directory with: cd ~/verus-cli

   ./fetch-params

6. After this completes, you can start the daemon which will begin syncing and create a new Verus wallet for your store with: ./verus-cli/verusd -daemon

=== Configuration of VerusPay ===

1. Import Verus Transparent Addresses For either Live or Manual mode, you MUST input many Verus transparent addresses. The number you enter depends on the sale volume of your store and you'll want to keep an eye on it to see if you need to add more. It's important to use addresses from an OFFLINE wallet, not your same store wallet if you're running in Live Mode. To do so, from the offline/non-store computer where you have a wallet setup (I recommend setting up a new wallet for this purpose) use the script included with the plugin in the scripts folder, called get500t, and copy it into your "verus-cli" folder, then run it after giving it execute permission with: chmod +x get500t. It will generate a file in that same folder called "taddresses.txt" containing 500 new transparent Verus addresses for your wallet. Copy these, exactly as they are in the text file, and paste into the Store Addresses section of the VerusPay settings in WooCommerce, in the "Store VRSC Addresses" text field, then save your settings. If addresses are ever used, due to the store operating in Manual Mode, they will be moved from this text field to the Used Addresses field.
2. RPC Settings for Live Mode If you're operating in Live Mode, you'll need to enter the login information for the Verus daemon running on your web store. To get this information, SSH to your web store and in the home directory for the user with which you installed and are running the Verus daemon, go to the .komodo/VRSC folder and then open the file called VRSC.conf using a program like "nano". Within this file, copy the user, pass, host, and port info and paste it into the VerusPay RPC Settings fields for each and save your settings in WooCommerce.
3. Optional Settings There are many optional settings to play with, I recommend playing with and tweaking everything before using it in a live scenario.

=== Support === You can contact me via the Verus Coin official Discord at https://discord.gg/VRKMP2S

=== Frequently Asked Questions ===

What is the text domain for translations? The text domain is veruspay-verus-gateway.

How can I change the styling (CSS) of the checkout pages? CSS options are being added in a later release to the Admin section. For now, most themes come with a section where you can add your own CSS styling and you can add customizations this way.

Does this plugin work with a shared hosting plan or a host that does not have SSH access? Yes! But it will be "Manual Mode" only, meaning it is not directly connected or integrated with the blockchain and relies on transparent addresses you enter in the store settings (zs Sapling addresses are not allowed).

Can I "enforce" privacy Sapling payments? Yes, there is an option in the payment gateway settings within WooCommerce->Settings->Payments to enforce privacy "zs" payments. This works in Live Mode only.

== Screenshots ==

1. This is the main settings area for VerusPay within WooCommerce's Settings->Payments section. Each of the headings expand upon clicking.
2. The RPC Settings section is where the store owner enters the connection settings for Verus blockchain integration.
3. Store owners input VRSC transparent addresses in the "Store VRSC Addresses" text field which are used when the store is in manual mode, either by the store owner's choice or as a fallback if there is any issue in connecting with the blockchain.
4. The Message and Content Customizations section allows store owners to create custom messages to be used throughout the purchase process when a customer pays with Verus.
5. Store Options allow the store owner to define many of the attributes of the checkout and purchase process with regards to timeouts, privacy, and QR codes.
6. The Discount/Fee option allows a store owner to define either an additional fee or a discount which is applied to customers who checkout using Verus.
7. At checkout, this is what the Verus payment option looks like to the customer, although CSS may be applied by advanced users to slightly alter this.
8. After a customer proceeds to purchase, this is the screen they are presented with where they are able to pay and see payment receipt occur live.
9. After payment is detected on the blockchain, the purchase waits for the store-set minimum confirmations and delivers the digital product or completes the sale when it's reached.

=== Changelog ===

= 2019.02.28 - version 0.1.2 =

• Simplify code functions
• Remove cURL, phpexttools, easybitcoin
• Create wp_remote_post and get functions for all cURL requests
• Consolidate all blockchain integration functions into wc-veruspay-chaintools.php
• Rename all functions to unique names
• Edit text domain and slug to match as veruspay-verus-gateway
• Include uninstall script for clean uninstallation of plugin
• Improve readme file
• Rename screenshots

= 2019.02.25 - version 0.1.1-a =

• Fix bug with QR Invoice format
• Add hide function of QR Invoice if Sapling purchase (sapling not currently supported in Verus Mobile)

= 2019.02.24 - version 0.1.1 =

• Add Verus Mobile Invoice compatible QR codes for orders
• Add admin customization for memo and image url within Invoice QRs

= 2019.02.11 - version 0.1.0 =

• Initial Release Includes the Following Features:

• Verus Coin (VRSC) support
• Sapling zk-SNARK private payment support as an option to the customer or enforced by the store
• Verus blockchain integration in Live mode allows dynamic address generation and live status monitoring of payments for both transparent and private.
• Manual mode allows use of the plugin with a pool of addresses imported by the store owner.
• A script is included for exporting a list of transparent addresses to a text file to import into the store.
• Fallback to manual mode if Live mode fails
• Enforce Sapling option for store owner removes the option at checkout, all Verus payments must be Sapling.
• Message customization for store owners.
• VRSC Decimal definition for store owners.
• Price timeout allows the store owner to define for how many minutes a Verus / Fiat price will display before getting a new price at checkout.
• Order wait time allows the store owner to define how long an order will remain open before cancelled while waiting for the full payment amount to arrive from the customer at the VRSC address.
• Confirmations required allows the store owner to define how many blockchain confirmations are required before a payment is considered final and the customer's order is considered completed.
• QR Code size option in PX for the store owner
• Discount or Fee option for store owners allows a discount or fee % to be set for when a customer chooses to pay in Verus Coin (VRSC).
• Test mode to allow enabling the plugin only for logged in Admins

== Upgrade Notice ==

= 0.1.2 = Code improvements

= 0.1.1-a = Bug fixes

= 0.1.1 = Add QR Invoice functionality

graph LR
A[Square Rect] -- Link text --> B((Circle))
A --> C(Round Rect)
B --> D{Rhombus}
C --> D