Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/machinomy/machinomy
Node.js library for micropayments in Ether and ERC20 tokens over HTTP
https://github.com/machinomy/machinomy
ethereum javascript micropayments state-channels
Last synced: about 1 month ago
JSON representation
Node.js library for micropayments in Ether and ERC20 tokens over HTTP
- Host: GitHub
- URL: https://github.com/machinomy/machinomy
- Owner: machinomy
- Archived: true
- Created: 2016-11-02T14:32:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-06T22:56:21.000Z (over 5 years ago)
- Last Synced: 2024-05-23T03:42:47.082Z (7 months ago)
- Topics: ethereum, javascript, micropayments, state-channels
- Language: TypeScript
- Homepage: http://machinomy.com
- Size: 2.57 MB
- Stars: 165
- Watchers: 15
- Forks: 40
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-layer-2 - GitHub
README
# Machinomy Monorepo [![Build Status][travis-img]][travis] [![Coverage Status][codecov-img]][codecov] [](https://greenkeeper.io/) [![Chat][gitter-img]][gitter]
[travis]: https://travis-ci.org/machinomy/machinomy
[travis-img]: https://travis-ci.org/machinomy/machinomy.svg?branch=master
[codecov]: https://codecov.io/gh/machinomy/machinomy
[codecov-img]: https://codecov.io/gh/machinomy/machinomy/branch/master/graph/badge.svg
[gitter]: https://gitter.im/machinomy/machinomy
[gitter-img]: https://img.shields.io/gitter/room/machinomy/machinomy.js.svg
Machinomy Lerna Monorepo repository.
Available sub-projects:
- [Machinomy](packages/machinomy) is a Node.js library for micropayments in Ether over HTTP. It allows you to send and receive a minuscule amount of money instantly.
- [Contracts](packages/contracts) is a TypeScript interface for Ethereum contracts managed by [Truffle](https://github.com/trufflesuite/truffle) used by [Machinomy](packages/machinomy).
- [Examples](packages/examples) is [Machinomy](packages/machinomy) examples.
- [Playground](packages/playground) contains code of playground.machinomy.com
- [cli](packages/cli) is Machinomy Command Line Interface.
- [logger](packages/logger) is Machinomy Logger. Works in browser and Node.
- [wraptso](packages/wraptso) is Machinomy Wrapper for Truffle Contract.
Web site: [machinomy.com](http://machinomy.com).
Twitter: [@machinomy](http://twitter.com/machinomy).
Support/Discussion: [Gitter](https://gitter.im/machinomy/machinomy).
FAQ: [GitHub Wiki Page](https://github.com/machinomy/machinomy/wiki/Frequently-Asked-Questions).
## Installation
Using [yarn](https://yarnpkg.com/lang/en/) and Node.js **v9** is mandatory (**don't use npm!**)
$ yarn add machinomy
The library supports mainnet, Ropsten, and [Rinkeby](https://www.rinkeby.io/) networks.
## Tinkering
It takes two to tango: a seller and a buyer. Seller is `packages/examples/src/server.ts` script. Build it or run through node-ts.
```
$ git clone https://github.com/machinomy/machinomy
$ cd machinomy && yarn install && yarn bootstrap && yarn build
$ node packages/examples/src/server.js
```
And then run client script:
```
$ node packages/examples/src/client.js
```
## Usage
### Buy
Using TypeScript
```typescript
import Machinomy from 'machinomy'
const uri = 'http://localhost:3000/content'
const machinomy = new Machinomy(SENDER_ACCOUNT, web3)
const contents = await machinomy.buy({ receiver: RECEIVER_ACCOUNT, price: 100, gateway: 'http://localhost:3001/accept' })
console.log(contents)
```
### Sell
The process is more convoluted than buying. Better consult [packages/examples/src/server.ts](packages/examples/src/server.ts) file.
### Sending payments through channels
```
$ git clone https://github.com/machinomy/machinomy
$ cd machinomy && yarn install && yarn bootstrap && yarn build && cd packages/examples
$ yarn run sender && yarn run receiver
```
Look at [sender.ts](packages/examples/src/sender.ts) and [receiver.ts](packages/examples/src/receiver.ts) for more information.
## Documentation
For more advanced documentation go to [doc/](doc/) folder.
## Contributing
**Developers:** Machinomy is for you. Feel free to use it, break it, fork it, and make the world better. The code is standard TypeScript, no special skills required:
$ yarn install && yarn bootstrap
Using [yarn](https://yarnpkg.com/lang/en/) is mandatory (**don't use npm!**)
Apply migrations (eg. for PostgreSQL, refer [packages/machinomy/database.json](packages/machinomy/database.json)):
$ PGUSER=user PGPASSWORD=pass PGHOSTADDR=localhost PGDATABASE=dbname yarn migrate
**Non-Developers:** You are lovely. As a starter, help us spread the word! Tell a friend right now.
If not enough, developers need flesh-world guidance. It starts with proper documentation and a pinch of fantasy.
Really anything, whether it is a short post on a use case of IoT micropayments, addition to the documentation (code comments, yay!),
or an elaborate analysis of machine economy implications. Do not hesitate to share any idea with us on [Gitter](https://gitter.im/machinomy/machinomy).
## License
Licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).