Difference between revisions of "smartCommerce Quickstart - M2"

From Moogento How-to Guides
Jump to navigation Jump to search
m
m
 
(17 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
{{idea|Most of this is included if you get the [https://moogento.com/installation Installation & Setup Service]}}
 
{{idea|Most of this is included if you get the [https://moogento.com/installation Installation & Setup Service]}}
  
−
'''smartCommerce for Magento 2''' has been designed for fast & easy setup - if you're already familiar with M2 extension install, you'll work it out by just diving in (we even built a setup Guide into the plugin). We'll go over the process here.
+
'''smartCommerce for Magento 2''' has been designed for fast & easy setup - if you're already familiar with M2 extension install, you'll work it out by just diving in (we even built a setup Guide into the plugin).
 +
 
 +
We'll go over the process in more detail here, so if you're not familiar with setting up a Magento plugin and/or are new to crypto payments, don't worry!
 +
 
 
*If you haven't installed it yet, follow the [[Installing_Magento_2_Extensions_:_Easy_Install_Guide|Easy Install Guide (M2)]] to get smartCommerce running.
 
*If you haven't installed it yet, follow the [[Installing_Magento_2_Extensions_:_Easy_Install_Guide|Easy Install Guide (M2)]] to get smartCommerce running.
 +
 +
 +
  
  
Line 11: Line 17:
 
==Crypto Basics==
 
==Crypto Basics==
 
===You're in charge===
 
===You're in charge===
−
Crypto is a new industry - security & safety guidelines change often. It's up to you to keep informed! Keep up-to-date with Smart [https://smartcash.cc here].
+
Crypto is a new industry - security & safety guidelines change often. It's up to you to keep informed! Keep up-to-date with Smart on the project page: [https://smartcash.cc https://smartcash.cc].
 
The code we provide is not encrypted, as is the Electrum wallet which you'll also need.
 
The code we provide is not encrypted, as is the Electrum wallet which you'll also need.
  
Line 25: Line 31:
 
===Your Wallet = Your Funds = Your Responsibility===
 
===Your Wallet = Your Funds = Your Responsibility===
 
As part of accepting SmartCash on your site, you're going to need a SmartCash Electrum wallet. Whoever you give access to use this wallet will have access to your funds - bear this in mind when setting this up.
 
As part of accepting SmartCash on your site, you're going to need a SmartCash Electrum wallet. Whoever you give access to use this wallet will have access to your funds - bear this in mind when setting this up.
 +
  
 
==Setup Electrum Wallet==
 
==Setup Electrum Wallet==
Line 31: Line 38:
 
It also makes it really easy for you to transfer out payments as Electrum supports 'sweep' style transfers, where it'll move funds from multiple addresses, in one go, from your wallet.
 
It also makes it really easy for you to transfer out payments as Electrum supports 'sweep' style transfers, where it'll move funds from multiple addresses, in one go, from your wallet.
  
−
===Download an Electrum client===
+
===1. Download the Smart Electrum wallet===
−
Get a wallet for your system [https://smartcash.cc/wallets/#electrum here].
+
Get the latest SmartCash Electrum wallet for your system on the project page: [https://smartcash.cc/wallets/#electrum https://smartcash.cc/wallets/#electrum].
  
 
Currently there are versions for Mac, Windows, and Linux.
 
Currently there are versions for Mac, Windows, and Linux.
Line 38: Line 45:
 
Install that on your local system.
 
Install that on your local system.
  
−
===Make a fresh Smart wallet===
+
===2. Make a fresh Smart wallet===
 +
 
 +
You should setup up a new wallet for your store, even if you already have a Smart wallet.
 +
 
 +
{{idea|Don't be tempted to use a previously-used wallet, you might end up giving away free sales : the plugin assumes a zero balance on all addresses}}
 +
 
 +
# Head to {{menu3|Electrum app|File|New/Restore}}
 +
# Name your wallet (eg. 'Magento Store Wallet')
 +
# Choose 'Standard Wallet' in the next step, as we're making a new wallet
 +
# Then 'Create a new seed'
 +
# It'll then give you 12 words. It's very important that you note these down:
 +
## Somewhere safe
 +
## Somewhere not easily accessible by other people
 +
## Not electronically
 +
## Where you won't lose them! Some people recommend splitting it into two or more parts and storing those in different locations
 +
## * If you lose access to these words, or forget them, you'll potentially lose access to the funds in your wallet in the future
 +
# You'll then need to re-enter the same words to access the wallet
 +
# Congratulations - you now have a working Smart Wallet!
 +
 
 +
{{idea|Don't forget that access to this wallet (and the 12 backup words) provides direct access to your funds}}
 +
 
 +
==Setup inside Magento==
 +
 
 +
# Check your smartCommerce plugin is running
 +
#:In your plugin config section, check there's an entry for SmartCash in the sidebar:
 +
#:{{menu3|Magento Admin sidebar|Moogento|Smartcash Config.}}
 +
#:
 +
#::[[File:magento-config.png|link=|800px]]
 +
#:
 +
# Copy across the MPK
 +
#:In your Electrum wallet, choose 'Get Info' and copy the entire Master Public Key.
 +
#:
 +
#::[[File:electrum-mpk.png|link=|800px]]
 +
#:
 +
#:In your Magento smartCommerce config page you'll see an entry for MPK - paste the MPK in here and save the config page.
 +
#:
 +
#::[[File:electrum-paste.png|link=|800px]]
 +
#:
 +
# Enable SmartCash as a Magento payment method
 +
#:
 +
#:In the Magento Payment Methods config page, enable SmartCash as a payment method.
 +
#:
 +
#::[[File:smart_payment_method.png|link=|800px]]
 +
#:
 +
# Check you're showing green ticks
 +
#:In the config page there are a couple core checks for the setup.
 +
#:
 +
#::[[File:smart-magento-wallet-green-ticks.png|link=|800px]]
 +
#:
 +
# Test!
 +
#:
 +
#:Try buying something in your store, and check that SmartCash is now an option in the checkout.
 +
#:
 +
#:If all is good - '''congratulations, you now accept Smart on your site'''!
 +
 
  
−
We recommend setting up a new wallet for your store, even if you already have a Smart wallet.
+
==Reports==
 +
We've built in an advanced reports system, linking with the Magento reports structure.
  
−
==Link with Magento==
+
Just head to Reports > Smartcash Settlement.
  
−
===Check your smartCommerce plugin is running===
+
::[[File:magento-smart-reports.png|link=|800px]]
−
In your config section, check there's an entry for SmartCash in the sidebar.
 
  
−
::[[File:magento-config.png|link=|400px]]
+
You'll be able to export a CSV or an XML file (suitable for eg Excel), and from there you'll have all the info you need to do your business accounting.
  
−
===Copy across the MPK===
+
==FAQ==
−
In your Electrum wallet, choose 'Get Info' and copy the entire Master Public Key.
+
===What's SmartCash?===
 +
It's a community-centric crypto project, designed for fast & cheap payments. Read more on the project website: [https://smartcash.cc smartcash.cc]
  
−
::[[File:electrum-mpk.png|link=|400px]]
+
===What's the difference between SmartCash and Smart?===
 +
SmartCash is the project name; Smart is the currency name.
  
−
In your Magento smartCommerce config page you'll see an entry for MPK - paste the MPK in here and save the config page.
+
ie. You'll be paid in Smart.
  
−
::[[File:electrum-paste.png|link=|400px]]
+
===How do I spend the Smart I've been paid?===
 +
You can either find other great stores (like yours!) that accept Smart, or transfer from your wallet to an exchange. Depending on the exchange, you can sell direct into fiat or into eg. bitcoin and then from there into fiat.
  
 +
===Can I change my wallet?===
 +
We use the unique Master Public Key (MPK) to determine your wallet, and also which address is given to your customer to send Smart to.
  
−
===Enable SmartCash as a Magento payment method===
+
Quick reminder:
  
−
In the Magento Payment Methods config page, enable SmartCash as a payment method.
+
{{idea|Don't be tempted to use a previously-used wallet, you might end up giving away free sales : the plugin assumes a zero balance on all addresses}}
  
 +
If you want to use a different wallet (to one that has already been set in the plugin config), no worries.
  
−
::[[File:smart_payment_method.png|link=|400px]]
+
Just:
  
 +
# Disable the plugin in the Magento payments page:
 +
#: ''[Sidebar - System] -> Stores - Configuration -> Sales - Payment Methods - SmartCash''
 +
# Clear the cache:
 +
#: ''[Sidebar - System] -> System - Cache Management -> (Select All) -> Refresh Cache / Submit''
 +
# Copy & paste the new MPK in the plugin config field
 +
# Clear the cache again
 +
# Re-enable the plugin in the Magento payment section
 +
# Log out then in
 +
# Double-check that the checkout is showing an address from your new wallet
  
−
===Check you're showing green ticks===
+
===I don't see some recent transactions in my wallet===
−
In the config page there are a couple core checks for the setup.  
+
Your Electrum wallet can deal with a near-infinite number of addresses.  
  
−
::[[File:smart-magento-wallet-green-ticks.png|link=|400px]]
+
That would take a long time to check :) so it only checks ahead a number of addresses (called the 'gap'), from the last address with some 'action' (ie. a transaction).
  
 +
If you have more addresses with no 'action' than you have set as your 'gap' then the wallet won't see them.
  
−
===Test!===
+
You can expand your 'gap' in your wallet Console section, eg. to 30:
  
−
Try buying something in your store, and check that SmartCash is now an option in the checkout.
+
<code>wallet.change_gap_limit(30)</code>
  
−
If all is good - '''congratulations, you now accept Smart on your site'''!
+
<code>wallet.storage.write()</code>
  
−
==FAQ==
+
To view/verify the current gap limit:
−
===What's SmartCash?===
+
 
−
It's a community-centric crypto project, designed for fast & cheap payments. Read more on the project website: [https://smartcash.cc smartcash.cc]
+
<code>wallet.gap_limit</code>
  
−
===What's the difference between SmartCash and Smart?===
+
::[[File:smartcash-electrum-gap.png|link=|800px]]
−
SmartCash is the project name; Smart is the currency name.
 
  
−
ie. You'll be paid in Smart.
 
  
 
[[Category:Extension Setup]]
 
[[Category:Extension Setup]]

Latest revision as of 20:11, 30 October 2018

smart-magento-integration.pngGet smartCommerce today

Aims & Preparation

Most of this is included if you get the Installation & Setup Service

smartCommerce for Magento 2 has been designed for fast & easy setup - if you're already familiar with M2 extension install, you'll work it out by just diving in (we even built a setup Guide into the plugin).

We'll go over the process in more detail here, so if you're not familiar with setting up a Magento plugin and/or are new to crypto payments, don't worry!




Crypto Basics

You're in charge

Crypto is a new industry - security & safety guidelines change often. It's up to you to keep informed! Keep up-to-date with Smart on the project page: https://smartcash.cc. The code we provide is not encrypted, as is the Electrum wallet which you'll also need.

Security

As everywhere - never give your private key to anyone. This is equivalent to giving away access to your funds. We will ask for the Master Public Key. You still shouldn't give this away to anyone, but it's safe to save to your website. You can read more about MPKs here.

Exchange Rates

Crypto values have (in)famously rocketed and plummeted the last few years. Sometimes this happens in the space of a few days. If you're getting paid in any crypto currency/token (not just Smart) then you should be clear that the fiat (eg. USD) value of those holdings may change (either direction). You might want to exchange out some (or all) of it on a regular basis.

You can get the latest SmartCash exchange rate here.

Your Wallet = Your Funds = Your Responsibility

As part of accepting SmartCash on your site, you're going to need a SmartCash Electrum wallet. Whoever you give access to use this wallet will have access to your funds - bear this in mind when setting this up.


Setup Electrum Wallet

You need a SmartCash Electrum wallet so that we can generate deposit addresses.

It also makes it really easy for you to transfer out payments as Electrum supports 'sweep' style transfers, where it'll move funds from multiple addresses, in one go, from your wallet.

1. Download the Smart Electrum wallet

Get the latest SmartCash Electrum wallet for your system on the project page: https://smartcash.cc/wallets/#electrum.

Currently there are versions for Mac, Windows, and Linux.

Install that on your local system.

2. Make a fresh Smart wallet

You should setup up a new wallet for your store, even if you already have a Smart wallet.

Don't be tempted to use a previously-used wallet, you might end up giving away free sales : the plugin assumes a zero balance on all addresses

  1. Head to Electrum appFileNew/Restore
  2. Name your wallet (eg. 'Magento Store Wallet')
  3. Choose 'Standard Wallet' in the next step, as we're making a new wallet
  4. Then 'Create a new seed'
  5. It'll then give you 12 words. It's very important that you note these down:
    1. Somewhere safe
    2. Somewhere not easily accessible by other people
    3. Not electronically
    4. Where you won't lose them! Some people recommend splitting it into two or more parts and storing those in different locations
    5. * If you lose access to these words, or forget them, you'll potentially lose access to the funds in your wallet in the future
  6. You'll then need to re-enter the same words to access the wallet
  7. Congratulations - you now have a working Smart Wallet!

Don't forget that access to this wallet (and the 12 backup words) provides direct access to your funds

Setup inside Magento

  1. Check your smartCommerce plugin is running
    In your plugin config section, check there's an entry for SmartCash in the sidebar:
    Magento Admin sidebarMoogentoSmartcash Config.
    magento-config.png
  2. Copy across the MPK
    In your Electrum wallet, choose 'Get Info' and copy the entire Master Public Key.
    electrum-mpk.png
    In your Magento smartCommerce config page you'll see an entry for MPK - paste the MPK in here and save the config page.
    electrum-paste.png
  3. Enable SmartCash as a Magento payment method
    In the Magento Payment Methods config page, enable SmartCash as a payment method.
    smart payment method.png
  4. Check you're showing green ticks
    In the config page there are a couple core checks for the setup.
    smart-magento-wallet-green-ticks.png
  5. Test!
    Try buying something in your store, and check that SmartCash is now an option in the checkout.
    If all is good - congratulations, you now accept Smart on your site!


Reports

We've built in an advanced reports system, linking with the Magento reports structure.

Just head to Reports > Smartcash Settlement.

magento-smart-reports.png

You'll be able to export a CSV or an XML file (suitable for eg Excel), and from there you'll have all the info you need to do your business accounting.

FAQ

What's SmartCash?

It's a community-centric crypto project, designed for fast & cheap payments. Read more on the project website: smartcash.cc

What's the difference between SmartCash and Smart?

SmartCash is the project name; Smart is the currency name.

ie. You'll be paid in Smart.

How do I spend the Smart I've been paid?

You can either find other great stores (like yours!) that accept Smart, or transfer from your wallet to an exchange. Depending on the exchange, you can sell direct into fiat or into eg. bitcoin and then from there into fiat.

Can I change my wallet?

We use the unique Master Public Key (MPK) to determine your wallet, and also which address is given to your customer to send Smart to.

Quick reminder:

Don't be tempted to use a previously-used wallet, you might end up giving away free sales : the plugin assumes a zero balance on all addresses

If you want to use a different wallet (to one that has already been set in the plugin config), no worries.

Just:

  1. Disable the plugin in the Magento payments page:
    [Sidebar - System] -> Stores - Configuration -> Sales - Payment Methods - SmartCash
  2. Clear the cache:
    [Sidebar - System] -> System - Cache Management -> (Select All) -> Refresh Cache / Submit
  3. Copy & paste the new MPK in the plugin config field
  4. Clear the cache again
  5. Re-enable the plugin in the Magento payment section
  6. Log out then in
  7. Double-check that the checkout is showing an address from your new wallet

I don't see some recent transactions in my wallet

Your Electrum wallet can deal with a near-infinite number of addresses.

That would take a long time to check :) so it only checks ahead a number of addresses (called the 'gap'), from the last address with some 'action' (ie. a transaction).

If you have more addresses with no 'action' than you have set as your 'gap' then the wallet won't see them.

You can expand your 'gap' in your wallet Console section, eg. to 30:

wallet.change_gap_limit(30)

wallet.storage.write()

To view/verify the current gap limit:

wallet.gap_limit

800px
Retrieved from "https://moogento.com/guides/index.php?title=smartCommerce_Quickstart_-_M2&oldid=2269"