https://github.com/kybernetwork/widget-woocommerce

https://github.com/kybernetwork/widget-woocommerce

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kybernetwork/widget-woocommerce
• Owner: KyberNetwork
• License: mit
• Created: 2018-08-31T01:52:39.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-24T03:51:16.000Z (over 5 years ago)
• Last Synced: 2024-04-16T08:30:59.363Z (9 months ago)
• Language: PHP
• Size: 15.4 MB
• Stars: 7
• Watchers: 6
• Forks: 92
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Kyber Widget WooCommerce





  





  





  





  





# Introduction

Kyber Payment Gateway for WooCommerce 

![screenshot](https://github.com/KyberNetwork/widget-woocommerce/blob/master/assets/images/screenshot-2.png)

# Requirements

- PHP version 7.2+

- WordPress 4.0+

- WooCommerce 3.0+

# Installation

## Install from source code

1. Clone code repo to your /wp-content/plugins/

```shell

git clone https://github.com/KyberNetwork/widget-woocommerce

```

2. Install required components

```shell

composer install

```

3. Activate plugin

## Install from zip file

1. Download the plugin [zip file](https://github.com/KyberNetwork/widget-woocommerce/releases)

2. Unzip to your wordpress folder /wp-content/plugins

3. Activate plugin /wp-admin/plugins.php

# Usage

After activate, you will find plugin settings under WordPress Dashboard/WooCommerce/Payment. Enable payment gateway will add an option to pay by tokens to your checkout page.

# Config

Plugin settings include:

- **Title**

  Title will be display as a payment option for user in checkout pages.

- **Description**

  Description will be display under the payment option, describe what payment gateway is for.

- **Receive Address**

  This is the wallet address where you want to receive the payment. This address is required, without this address payment will not be processed.

- **Receive Token Symbol**

  This is token symbol (currency) which you want to receive from payment. This token is only in list accept to swap by [Kyber Network](https://kyber.network/swap/eth_knc).

- **Network**

  This is Ethereum network where you want the payment gateway runs on. There are 2 options, Ropsten for test and Mainnet for your production.

- **Mode**

  This is mode for display the [Kyber Widget](https://developer.kyber.network/docs/WidgetOverview). There are 3 options available.

- **Network node endpoint**

  This options is for tracking tx status

- **Block Confirmation**

  Number of block confirmation for confirm tx as success

- **Commission ID**

  Registered ETH address that is part of the [fee sharing program](https://developer.kyber.network/docs/FeeSharingGuide)

## Transaction Monitoring:

- In order to check if the payment is success, we use [widget-monitor-php](https://github.com/KyberNetwork/widget-monitor-php) to monitor transaction, you can find details information [here](./tx_monitor.md)

## Sample Walkthrough

You can find a sample walkthough on how to use the plugin (with screenshot) [here](./Sample.md)

## Developer documentation and contribution guidelines

If you are a developer and want to contribute to the repository, please check out the [developer docs](./Developer.md) and [contribution guidelines](./CONTRIBUTING.md)

  

## License

[The MIT License (MIT)](LICENSE)