Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

eip2021

1.0.1 • Public • Published

Payoutable Token

Build Status Coverage Status npm

This is the reference implementation of EIP-2021 Payoutable token. This implementation will change over time with the standard and is not stable at the moment.

Feedback is appreciated and can given at the discussion of the EIP.

Summary

An extension to the ERC-20 standard token that allows Token wallet owners to request payout from their wallet, by calling the smart contract and attaching a payout instruction string.

Abstract

Token wallet owners (or approved addresses) can order payout requests through blockchain. This is done by calling the orderPayoutFrom or orderPayoutFrom methods, which initiate the workflow for the token contract operator to either honor or reject the payout request. In this case, payout instructions are provided when submitting the request, which are used by the operator to determine the destination of the funds.

In general, it is not advisable to place explicit routing instructions for the payouts on a verbatim basis on the blockchain, and it is advised to use a private communication alternatives, such as private channels, encrypted storage or similar, to do so (external to the blockchain ledger). Another (less desirable) possibility is to place these instructions on the instructions field in encrypted form.

Sequence diagrams

Payout executed

The following diagram shows the sequence of the payout creation and execution.

Payoutable Token: Payout executed

Payout cancelled

The following diagram shows the sequence of the payout creation and cancellation.

Payoutable Token: Payout cancelled

Payout rejected

The following diagram shows the sequence of the payout creation and rejection.

Payoutable Token: Payout rejected

State diagram

Holdable Payoutable: State Diagram

Install

npm install eip2021

Usage

To write your custom contracts, import the contract and extend it through inheritance.

pragma solidity ^0.5.0;
 
import 'eip2021/contracts/Payoutable.sol';
 
contract MyPayoutable is Payoutable {
    // your custom code
}

You need an ethereum development framework for the above import statements to work! Check out these guides for Truffle, Embark or Buidler.

Payment information

Whenever a payout is ordered, payment information has to be provided with the necessary information for the off-chain transfer. EIP-2021 leaves the structure of this information up to the implementer, but recommends ISO-20022 as a starting point.

The unit tests use a JSON version of this standard, which can be seem below.

{
    "messageId": "Example Message ID",
    "payouts": [
        {
            "amount": 1.00,
            "bankAccountId": "caaa2bd3-dc42-436a-b70b-d1d7dac23741",
            "remittanceInformation": "Example Remittance Information"
        }
    ]
}

Amongst other things, if defines the transferred amount, an ID to a predefined bank account and remittance information. Additionally an ID is defined to properly mark the transfer.

Tests

To run the unit tests execute npm test.

Code coverage

To get the code coverage report execute npm run coverage

Install

npm i eip2021

DownloadsWeekly Downloads

1

Version

1.0.1

License

Apache-2.0

Unpacked Size

59.4 kB

Total Files

19

Last publish

Collaborators

  • avatar