https://github.com/hyperledger/firefly-tezosconnect

Firefly Tezos Connect
https://github.com/hyperledger/firefly-tezosconnect

Last synced: 10 months ago
JSON representation

Firefly Tezos Connect

• Host: GitHub
• URL: https://github.com/hyperledger/firefly-tezosconnect
• Owner: hyperledger
• License: apache-2.0
• Created: 2023-09-14T20:41:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-07-07T10:05:35.000Z (10 months ago)
• Last Synced: 2025-07-11T04:32:26.213Z (10 months ago)
• Language: Go
• Homepage: https://github.com/hyperledger/firefly-tezosconnect
• Size: 504 KB
• Stars: 6
• Watchers: 10
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![build](https://github.com/hyperledger/firefly-tezosconnect/actions/workflows/go.yml/badge.svg?branch=main&event=push)](https://github.com/hyperledger/firefly-tezosconnect/actions/workflows/go.yml?branch=main&event=push)

[![codecov](https://codecov.io/gh/hyperledger/firefly-tezosconnect/branch/main/graph/badge.svg)](https://codecov.io/gh/hyperledger/firefly-tezosconnect)

[![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger/firefly-tezosconnect)](https://goreportcard.com/report/github.com/hyperledger/firefly-tezosconnect)

[![Hits-of-Code](https://hitsofcode.com/github/hyperledger/firefly-tezosconnect?branch=main)](https://hitsofcode.com/view/github/hyperledger/firefly-tezosconnect?branch=main)

[![Go Reference](https://pkg.go.dev/badge/github.com/hyperledger/firefly-tezosconnect.svg)](https://pkg.go.dev/github.com/hyperledger/firefly-tezosconnect)

[![License](https://img.shields.io/badge/apache-2.0-blue.svg)](https://github.com/hyperledger/firefly-tezosconnect/blob/main/LICENSE)

[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hyperledger/firefly-tezosconnect/badge)](https://scorecard.dev/viewer/?uri=github.com/hyperledger/firefly-tezosconnect)

# Hyperledger FireFly Tezos Connector

This repo provides a reference implementation of the FireFly Connector API (FFCAPI)

for Tezos blockchain.

See the [Hyperledger Firefly Documentation](https://hyperledger.github.io/firefly/latest/overview/public_vs_permissioned/#firefly-architecture-for-public-chains)

and the [FireFly Transaction Manager](https://github.com/hyperledger/firefly-transaction-manager) repository for

more information.

# License

Apache 2.0

## Transaction signing

Tezosconnect leverages remote transaction signing through a powerful 'signatory' service, offering compatibility with multiple key management solutions. With the flexibility to use AWS KMS, Azure KMS, GCP KMS, Yubi HSM, etc. for transaction signing, you can secure your blockchain transactions efficiently and conveniently.

More info at: https://signatory.io/

## Configuration

For a full list of configuration options see [config.md](./config.md)

## Example configuration

```yaml

connector:

  blockchain:

    # other public RPCs can be found: https://docs.tezos.com/architecture/rpc#public-and-private-rpc-nodes

    rpc: https://ghostnet.ecadinfra.com

    network: ghostnet

    signatory: http://localhost:6732

```

## Blockchain node compatibility

For Tezos connector to function properly, you should check the blockchain node supports the following RPC Methods:

### Chains

- `GET /chains//blocks//hash`

- `GET /chains//blocks//operations/`

- `GET /chains//blocks//operations//`

- `POST /chains//blocks//helpers/forge/operations`

- `POST /chains//blocks//helpers/scripts/simulate_operation`

- `POST /chains//blocks//helpers/scripts/run_operation`

### Block monitoring

- `GET /monitor/heads/`

### Injection

- `POST /injection/operation`