Code Monkey home page Code Monkey logo

splitter's Introduction

Splitter

This project aims to provide a easy way to split payments between recipients on the ethereum network

Usage

Recipient management

The recipients are basically addresses that receives any payment that a user sends, the recipients receive proportionally to the amount of percentage registered.

const splitter = new web3.eth.Contract(splitterAbi, splitterAddress)

// Adding a recipient
await splitter.methods.addRecipient([recipientAccount, percentage]).send({ from: account })

// Getting recipients
await splitter.methods.getRecipients().call()

// Removing recipients
await splitter.methods.removeAllRecipients().send({ from: account })

Splitting payments

Having the recipients settled, any payment sent to the contract will be splitted between the recipients and will be available for withdraw. You can pay the gas to send all recipients balances at once. If wanted, each owner can pull his own funds from the contract. You also can see the balance stored for any account.

const splitter = new web3.eth.Contract(splitterAbi, splitterAddress)

// Transfer to recipients accounts
await splitter.methods.transfer().send({ from: account })

// Reading balance
await splitter.methods.balanceOf(account).call()

// Withdraw own balance
await splitter.methods.withdraw(amount).send({ from: account })

Scripts

npm run compile

Compiles the contracts on the /build directory.

npm run lint

Show code errors based on .eslintrc.json and .solhintrc.json.

Run npm run lint:fix for fixing errors on javascript code

npm run test

Tests the contracts using the files at /test directory.

splitter's People

Contributors

dependabot[bot] avatar ggviana avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.