Lab 🧪 Setup 🧪 Tasks 🧪 FAQ 🧪 About

Multitenant Finite State Machines for Ethereum

An experiment in Deterministic Proxy design

Status

Currently in development. Done or in progress are:

• ✅ Developer setup and tasks documentation
• ✅ Developer environment configuration template
• ✅ Working Deterministic Proxy implementation
• ✅ Deployable examples
• ✅ Clear and complete inline NatSpec docs and in-method comments
• ✅ Separation of concerns into inheritance tree for easy comprehension and maintenance
• ✅ Shared domain model for contract structures, enums, events, & constants
• ✅ Domain model expressed in JS
• ✅ Domain model unit tests
• ✅ Script modules for reuse in both deployment and testing
• ✅ Contract unit tests
• ✅ CI build and test with Github Actions
• ✅ High level architecture documentation
• 👉 Project structure documentation
• 👉 API documentation
• 👉 Machine operation tests (multi-step operation of machine examples)
• 👉 Explore minimal clones for cheap deployments
• 👉 Javascript NPM package for interacting with Fismo
• 👉 "How to create and run FSMs on Fismo" doc

Developer Docs

• Setup - Get going quickly on your local system.
• Tasks - Build, test, analyse, and deploy.
• FAQ - Frequently asked questions.
• About - What is this project even about?

License

• License - BSD-3-Clause

• Copyright © 2021-2022 Futurescale, Inc.

• Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Futurescale, Inc., Fismo, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.