/dovetail

Primary LanguageShellBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Project Dovetail™ is an Open Source application for blockchain smart contracts

Documentation Status :

Dovetail™ | Architecture | Blockchains smart contracts | Contributing | License


Developing blockchain solutions with today’s technology is challenging, given the lack of tooling and standardization. Project Dovetail™ by TIBCO LABS™ addresses these issues by providing a graphical interface for modeling smart contracts, making them easier to write, visualize, test, and audit, all without deep programming experience. Logic is abstracted from low-level code, and contracts can be deployed into different blockchain stacks with little or no change. On-chain and off-chain computation can become more seamless, time to market is improved, and the risk of technology lock-in is reduced. Project Dovetail makes your smart contracts smarter.

What are Smart Contracts

There are many definitions and descriptions of smart contracts, as each blockchain framework tends to implement this capability in its own way (if it does implement this feature at all). However, generally speaking, smart contracts (at least from an enterprise / permissioned perspective) may be thought of as application or business logic (defined in code) that runs within the context of a blockchain network itself. The idea is to automate the processing of blockchain transactions across the network, use the logic to determine if a transaction will get written to the ledger, and to maintain accuracy, compliance, and trust. In essence, smart contracts represent a method for controlling how changes are made to the underlying blockchain, in a non-centralized and (potentially) untrustworthy environment. Supply chain transaction tracking, healthcare revenue cycle management, consumer contract execution, and government interactions are all areas in which smart contracts (business logic) may be applied. Remember, however, that "smart contracts" are not necessarily "smart" (depends on the code) nor "contracts" (as they may not be viewed as legal contracts). Thus, the term can be a bit misleading :)

Project Dovetail

Project Dovetail™ is a framework that allows for the end to end design, development, testing, and deployment of blockchain smart contracts. Project Dovetail™ allows you to develop smart contracts based on a series of models, helping to:

  • Increase security since the modeling abstraction layer will allow for reusable and tested code derived from the model.
  • Simplify development via an extendable abstraction layer (flow model)
  • Decouple your code from the underlying blockchain technology
  • Reduce the amount of code needed
  • Increase visibility and audit-ability
  • Allow customizable modeling for your industry
  • Expose a better UI for the design of smart contracts

Dovetail Core

Dovetail is based on TIBCO FLOGO™, an event-driven app framework used to develop apps for the cloud & IoT edge. It can also be thought of as a lightweight app kernel used by open source & commercial solutions like Dovetail here. The trigger used is based on the cli to generate or transpile your smart contract logic into blockchain technologies languages : R3 Corda, HyperLedger Fabric...

Dovetail Core provides the following key benefits:

Action chaining enables communication between one or more capabilities in a single, sub 10MB binary!
🏗 Common contribution model build activities and triggers that can be leveraged by all capabilities
🔨 Extensible easily extend the capabilities available by building your own action using the common interfaces

Dovetail Core Contribution Model

Dovetail™ Core exposes three principal contribution interfaces that enable developers to build common capabilities and functionality. These contribution interfaces include:

  • Connector Interface a common interface for importing predefined schemas into Dovetail, Hyperledger Composer Connector is an example.
  • Trigger Interface a common interface for building event-consumers that dispatch events to one or more actions. The Smart Contract TXN Trigger is an example of a trigger.
  • Activity Interface a common interface for exposing common application logic in a reusable manner. Think of this as a function, such as write to ledger, publish events, etc that can be used by all Dovetail apps.

Repos

Project Dovetail consists of the following sub-projects available as separate repos:

Dovetail Flows

Dovetail Flows provides smart contract logic design capabilities and includes the following key highlights.

🌈 Painless development Visual modeler with step-back debugging capabilities & elegant DSL
⚙️ Ultra-light process engine for conditional flow control

Getting Started

We've made getting started with Dovetail Flows as easy as possible. The current set of tooling is designed for:

  • Smart contract developers

For step by step instructions on how to get started please go to the documentation page

Zero-code Developers

If your background is in or you prefer to develop your smart contracts using zero-coding environments, then read on, because we’ve got something special for you.

Flows Web UI is available via Dovetail releases page.

To report any issues with the Issue tracker on this project.

Dovetail Documentation

Dovetail documentation can be found on the documentation page and the source code in the github page.

In order to regenerate the docs you need to run:

> git clone https://github.com/TIBCOSoftware/dovetail
> cd dovetail
> docker build -t dovetail-docs . --build-arg git_user_email=<your git email> --build-arg git_user_name=<your git name>
> docker run -it dovetail-docs
  • (Note that you will be asked to enter your github credentials and will need write access to the github repo)

Contributing

Want to contribute to Project Dovetail? We've made it easy, all you need to do is fork the repository you intend to contribute to, make your changes and create a Pull Request! Once the pull request has been created, you'll be prompted to sign the CLA (Contributor License Agreement) online.

Not sure where to start? No problem, here are a few suggestions:

  • dovetail-contrib: This repository contains all of the contributions, such as activities, triggers, etc. Perhaps there is something missing? Create a new activity or trigger or fix a bug in an existing activity or trigger.
  • Browse all of the Project Dovetail repositories and look for issues tagged kind/help-wanted or good first issue

If you have any questions, feel free to post an issue and tag it as a question or email tibcolabs@tibco.com.

For additional details, refer to the Contribution Guidelines.

License

The top level flogo repo, consisting of flow samples & documentation, is licensed licensed under a BSD-style license. Refer to LICENSE for license text.

Dovetail source code in dovetail-cli, dovetail-contrib, dovetail-java-lib are all licensed under a BSD-style license, refer to LICENSE