matter-labs-archive / PlasmaManager

Manages interaction with a block producer and the smart-contract

The Matter Plasma Implementation

Contract • TX & Block RLP • API • JS Lib • Swift Lib • Block Explorer • Web App • iOS App

PlasmaManager

PlasmaManager is your toolbelt for any kind of interactions with More Viable Plasma by Matter.

• Features
• Design Decisions
• Communication
• Transaction Structure
  • Input
  • Output
  • Transaction
  • Signed Transaction
• Block Structure
  • Block
  • Block Header
• Credits
  • Security Disclosure
• Donations
• License

---

• Usage Doc
  • UTXO
    • [UTXO structure](UTXO structure)
    • Get UTXOs list for Ethereum address
  • Transaction
    • Form input
    • Form output
    • Form transaction, sign it and serialize
  • Send transaction in Plasma
    • Send raw transaction
  • Blocks
    • Get last written Block and its number
    • Get block hash from storage and from Plasma Contract
    • Parse Block by its number
    • Get transactions list from Block and add some checks for it
  • Send transaction in Plasma
    • Send raw serialized transaction
  • Send transaction to Plasma Contract
    • Put deposit
    • Withdraw for chosen block number and serialized transaction

Features

• Based on More Viable Plasma Implementation by The Matter Team
• RLP encoding and decoding based on NPM Plasma Module
• Manages interaction with a block producer and the smart-contract
• Comprehensive Test Coverage
• Complete Documentation

Design Decisions

• Functionality was focused on serializing and signing transactions locally
• Sending raw transactions to The Matter Plasma network using REST API
• Sending raw transactions to Plasma Contract using web3.js
• RLP structure is similar to the one described in JS TX & Block RLP NPM module

Communication

When using this lib, please make references to this repo and give your start! :) Nothing makes developers happier than seeing someone else use our work and go wild with it.

If you are using PlasmaManager in your project or know of an project that uses it, please add it to this list.

• If you need help, use Stack Overflow and tag PlasmaManager.
• If you need to find or understand an API, check our documentation.
• If you'd like to see PlasmaManager best practices, check Projects using this library.
• If you found a bug, open an issue.
• If you have a feature request, open an issue.
• If you want to contribute, submit a pull request.

Credits

Alex Vlasov, @shamatar, [e-mail]

Security Disclosure

If you believe you have identified a security vulnerability with PlasmaSwiftLib, you should report it as soon as possible via email to Alex Vlasov [e-mail]. Please do not post it to a public issue tracker.

Donations

The Matters are charged with open-sorсe and do not require money for using their PlasmaManager. We want to continue to do everything we can to move the needle forward. If you use any of our libraries for work, see if your employers would be interested in donating. Any amount you can donate today to help us reach our goal would be greatly appreciated.

Our Ether wallet address: 0xe22b8979739d724343bd002f9f432f5990879901

License

PlasmaManager is available under the Apache License 2.0 license. See the LICENSE for details.