repository·main·Indexed 20 days ago
https://github.com/hyperledger-firefly/fireflyAn open-source Supernode stack providing APIs and orchestration for enterprise-grade Web3 applications. It handles blockchain connectivity, digital assets, and private data flows through a pluggable microservices architecture. The core system, written in Go, includes an API server, orchestrator, and specialized components like the FireFly Transaction Manager (FFTM) for blockchain connector development.
Hyperledger FireFly is an open source Supernode designed as a complete stack for enterprises to build and scale secure Web3 applications. It acts as a 'toolbox' that connects existing applications or back-office systems to the Web3 ecosystem.
It provides two primary sets of capabilities:
The FireFly ecosystem is distributed across several specialized repositories. The core repository (where you are now) is written in Go and hosts the API Server and central orchestration engine.
Other key components include:
evmconnect (FFCAPI reference) and ethconnect (for Hyperledger Besu / Quorum).fabconnect (Hyperledger Fabric), tezosconnect (Tezos), cardano (Cardano), and cordaconnect (Corda).Hyperledger FireFly provides an abstraction layer for managing digital assets, decoupling application logic from specific blockchain implementations and token standards. This allows developers to build interoperable systems that work across multiple blockchains and token types (fungible, non-fungible, or hybrid) using a consistent API.
Key capabilities include:
Hyperledger FireFly uses a plugin-based architecture with a microservice runtime footprint. Because of this modular design, the project is distributed across several specialized repositories. For developers looking to get started quickly, the CLI is the recommended entry point to orchestrate the various components.
Key repositories include:
ethconnect for Ethereum, cordaconnect for Corda, fabconnect for Hyperledger Fabric).dataexchange-https for HTTP data exchange.tokens-erc1155 for ERC1155 token connector reference implementation.The FireFly codebase is organized into several key directories that define its functionality and entry points:
internal: Contains the core Golang implementation code.pkg: Contains interfaces intended for use by external projects (e.g., when building extensions or integrations).cmd: Contains the command line entry points for the application.smart_contracts: Contains the smart contract code used for FireFly's on-chain logic.FireFly allows you to interact with smart contracts deployed on various blockchain platforms using a unified RESTful API and WebSocket-based event listening. This abstraction provides a consistent developer experience regardless of the underlying blockchain (e.g., Ethereum, Fabric, Corda).
Key capabilities include:
/invoke for state-changing transactions and /query for read-only state requests.A FireFly stack is a collection of Supernodes with networking and configuration designed to work together on a single development machine.
Key characteristics:
The FireFly Interface (FFI) is a blockchain-agnostic JSON format used to describe smart contracts. It allows FireFly to understand contract capabilities, perform API request validation, generate OpenAPI specifications, and prepare blockchain-specific requests.
Contract interfaces are scoped to a namespace. Within a single namespace, every contract must have a unique combination of name and version.
Hyperledger FireFly is an open-source API Orchestration and Data layer designed to act as a gateway to Web3 technologies. Instead of being a blockchain implementation itself, it functions as a Supernode that sits between your application and the underlying decentralized infrastructure.
FireFly integrates with various decentralized technologies, including:
Unlike Ethereum which uses an Application Binary Interface (ABI), Hyperledger Fabric uses a generic chaincode interface that leaves encoding/decoding to the developer.
To enable FireFly to interact with Fabric chaincode (submitting transactions, querying state, and listening for events), you must provide a FireFly Interface (FFI) document. This is a hand-crafted JSON document that defines:
params, and returns for each chaincode function.Key Requirements:
params section of a method, the sequence of properties in the JSON must exactly match the order of the input parameters in the chaincode's function signature.array of object) for automatic decoding.events section, you typically only need to specify the name. If the payload is JSON, FireFly decodes it; otherwise, it returns base64 encoded bytes.{
"namespace": "default",
"name": "asset_transfer",
"description": "Spec interface for the asset-transfer-basic golang chaincode",
"version": "1.0",
"methods": [
{
"name": "GetAllAssets",
"pathname": "",
"description": "",
"params": [],
"returns": [
{
"name": "",
"schema": {
"type": "array",
"details": {
"type": "object",
"properties": {
"type": "string"
}
}
}
}
]
},
{
"name": "CreateAsset",
"pathname": "",
"description": "",
"params": [
{ "name": "id", "schema": { "type": "string" } },
{ "name": "color", "schema": { "type": "string" } },
{ "name": "size", "schema": { "type": "string" } },
{ "name": "owner", "schema": { "type": "string" } },
{ "name": "value", "schema": { "type": "string" } }
],
"returns": []
}
],
"events": [
{ "name": "AssetCreated" }
]
}