Skip to content

Latest commit

 

History

History
97 lines (67 loc) · 2.88 KB

README.md

File metadata and controls

97 lines (67 loc) · 2.88 KB
Raw

iota payment module

How to Use

Still in development and testing. Unexpected errors and loss of funds may occur. Feedback is welcome!

This module can easily extend your nodejs or express app.

Docs

Install

$ npm install iota-payment

Usage

Create a .env file with your settings

Always start with a new unused seed!

MAX_PAYMENT_TIME is the time until created paymentes aren't checked anymore in minutes (4320 = 3 days to pay, transactions after that are ignored)

If you want to send payouts, without receiving iotas via payments first, send the iotas to the first address of the seed (index 0)

SEED='REPLACEWITHEIGHTYONETRYTESEED'
IOTANODE='https://nodes.thetangle.org:443'
FALLBACKNODE='https://node01.iotatoken.nl'
MAX_PAYMENT_TIME=4320

Add socket_origins to allow other websocket origins than 'http://localhost:* http://127.0.0.1:*'

socket_origins=http://localhost:* http://127.0.0.1:*

Add minPaymentIntervals to limit the payment (address) generation over the API in seconds; to allow only 1 every 10 seconds:

minPaymentIntervals=10

Add zmq to check payment confirmations with zmq. Optional add fast_but_risky to have a payment success in seconds if a valid transaction was sent, don't use it with large amounts because a payment will be accepted before confirmation and an attacker could send the iotas to another address

zmq_node='tcp://tanglebeat.com:5556'
zmq=true
fast_but_risky=true

You can add debug=basic or debug=full to get more logs for debugging

Examples

const paymentModule = require('iota-payment')
//create a payment
paymentModule.payment.createPayment({ value: 1, data: {name: 'Carlos'} })
  .then(payment => {
    console.log(payment)
  })
  .catch(e => {
    console.log(e)
  })

//Create an event handler which is called, when a payment was successfull
let onPaymentSuccess = function (payment) {
  //your code
  console.log(`Payment received from ${payment.data.name}:`, payment);
}
paymentModule.on('paymentSuccess', onPaymentSuccess);

Contribute

This module is only possible because of a large community of contributors. A heartfelt thank you to everyone for all of your efforts!

You can help us too:

Have a look at CONTRIBUTING.md.

License

The MIT License