Skip to content

BeamFi/BeamFiProtocol

Repository files navigation

BeamFi Protocol

BeamFi Protocol is a Micro Payments Solution for transferring a continuous stream of money or values represented by the tokens in real-time without intermediaries.

Watch BeamFi Meeting App Demo with Zoom

Watch BeamFi Meeting App Demo

What problems does it solve?

  • Remove the intermediaries and their fees, putting the power back to the users.
  • Real-time utilization of streamed money increases the utility of capital and the economic efficiency of idle money.
  • Solve the long-term job problem - Why are workers still paid at the end of the month/job?
  • Bring fairness, as with lump-sum payment, one party always has an advantage.
  • Users will have full ownership of their payment data and how it can be used to provide analytics services or insights to them, by allowing 3rd party companies to read their data with their consent

Autonomous Streams

Getting Started Guide

See BeamFi Developer Documentation for getting started, architecture, API, integration with Web frontend, deployment and sample apps.
See BeamFi Pitch Deck for its vision.
See BeamFi Payment Protocol in Supernova Hackathorn 2022. Top 7 submissions in DeFi.

Folder Structure

backend/service - Motoko Actor Smart Contract where the canister entry point is.
backend/model - Motoko model types for Beam, BeamOut, Escrow and persistence store helper
backend/utils - Common utility modules
diagram - BeamFi architecture (Install Draw.io integration VSCode extension to view it)
scripts - CI / CD automation scripts

Architecture

BeamFi Protocol Architecture
BeamFi Protocol

BeamFi Zoom Integration Architecture
BeamFi Protocol

Roadmap

  • Backend - Implement basic BeamFi Protocol Streaming smart contracts
  • Backend - BeamFi protocol canister running independently, separated from Content Fly
  • Frontend - Design and implement BeamFi app, integrating with BeamFi Protocol
  • Frontend - Plug Wallet integration with BeamFi
  • Backend - Integrate Stablecoin XTC Cycles Token
  • Frontend/Backend - BeamFi Meeting App with Zoom integration
  • Frontend - BeamFi Meeting App approved in Zoom Marketplace
  • Backend - Research and implement a cost-effective way to stream using the IC new Timer API
  • Backend - Allow Beam start/stop/restart
  • Frontend - NFID integration with BeamFi
  • Test - Automated Smart Contract API tests
  • Doc - Developer Documentation and API Documentation
  • Backend - Bitcoin ckBTC support
  • Frontend - Native Bitcoin support
  • Frontend - Client SDK (TypeScript)
  • Frontend - Connect to different BeamFi Vaults, and switch between them
  • Backend - BeamFi Protocol 3.0 (Rate-based Continuous Streaming Beam)

License

See the License file for license rights and limitations (MIT).

Contributing

See CONTRIBUTING.md for details about how to contribute to this project.

Authors

Code & Architecture: Henry Chan, henry@beamfi.app, Twitter: @kinwo
Product & Vision: Sam McCallum, sam@beamfi.app

References