https://github.com/hyperledger/firefly-sdk-nodejs

FireFly SDK for Node.js
https://github.com/hyperledger/firefly-sdk-nodejs

Last synced: 12 months ago
JSON representation

FireFly SDK for Node.js

• Host: GitHub
• URL: https://github.com/hyperledger/firefly-sdk-nodejs
• Owner: hyperledger
• License: apache-2.0
• Created: 2022-03-29T20:01:47.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-05-01T02:20:52.000Z (12 months ago)
• Last Synced: 2025-05-01T09:05:25.946Z (12 months ago)
• Language: TypeScript
• Size: 1 MB
• Stars: 15
• Watchers: 10
• Forks: 8
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# FireFly Node.js SDK

![version](https://img.shields.io/github/package-json/v/hyperledger/firefly-sdk-nodejs?label=firefly-sdk-nodejs)

[![FireFly Documentation](https://img.shields.io/static/v1?label=FireFly&message=documentation&color=informational)](https://hyperledger.github.io/firefly/latest)

![Hyperledger FireFly](./images/hyperledger_firefly_logo.png)

This is the client SDK for Node.js, allowing you to build your own applications on top of Hyperledger FireFly.

## Installation

```bash

npm install @hyperledger/firefly-sdk

```

## Usage

```typescript

import FireFly from '@hyperledger/firefly-sdk';

async function main() {

  const firefly = new FireFly({ host: 'http://localhost:5000' });

  await firefly.sendBroadcast({

    data: [

      {

        value: 'test-message',

      },

    ],

  });

}

if (require.main === module) {

  main().catch((err) => console.error(`Error: ${err}`));

}

```

(This example was taken from the [examples](examples) folder where you will find some other basic samples)

## Generated schemas

The types for FireFly requests and responses are generated from the OpenAPI schema for FireFly. If you have

the `firefly` repository cloned in a folder parallel to this one, you can run the following to re-generate

the TypeScript interfaces from the latest FireFly definitions:

```bash

npm run schema

```

## Git repositories

There are multiple Git repos making up the Hyperledger FireFly project. Some others

that may be helpful to reference:

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

- Command Line Interface (CLI) - https://github.com/hyperledger/firefly-cli

- FireFly Sandbox - https://github.com/hyperledger/firefly-sandbox

## Contributing

Interested in contributing to the community?

Check out our [Contributor Guide](https://hyperledger.github.io/firefly/latest/contributors/index), and welcome!

Please adhere to this project's [Code of Conduct](CODE_OF_CONDUCT.md).

## License

Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file.