Skip to content

Commit 314cb03

Browse files
authored
rename fabric token sdk to panurus (#1828)
Signed-off-by: Angelo De Caro <adc@zurich.ibm.com>
1 parent 0f097bf commit 314cb03

1,265 files changed

Lines changed: 4085 additions & 4179 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ body:
1111
Before submitting, please:
1212
1. **Search existing issues** to see if your issue has already been reported.
1313
2. **Consult the Resources**:
14-
- [Documentation Overview](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/README.md)
15-
- [Development Guidelines](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/development/development.md)
16-
- [Testing Guide](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/development/testing.md)
17-
3. **Join [Hyperledger Discord](https://discord.gg/hyperledger)** and ask in the `#fabric-token-sdk` channel if you're unsure.
14+
- [Documentation Overview](https://github.com/LFDT-Panurus/panurus/blob/main/docs/README.md)
15+
- [Development Guidelines](https://github.com/LFDT-Panurus/panurus/blob/main/docs/development/development.md)
16+
- [Testing Guide](https://github.com/LFDT-Panurus/panurus/blob/main/docs/development/testing.md)
17+
3. **Join [Hyperledger Discord](https://discord.gg/hyperledger)** and ask in the `#panurus` channel if you're unsure.
1818
1919
---
2020
@@ -66,7 +66,7 @@ body:
6666
- type: input
6767
id: sdk-version
6868
attributes:
69-
label: 📦 Fabric Token SDK Version
69+
label: 📦 Panurus Version
7070
description: Which version or commit hash are you using?
7171
placeholder: e.g. v1.0.0 or 5a3f2b1
7272
validations:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ blank_issues_enabled: true
22
contact_links:
33
- name: Hyperledger Discord
44
url: https://discord.gg/hyperledger
5-
about: Join the #fabric-token-sdk channel for real-time discussion.
5+
about: Join the #panurus channel for real-time discussion.
66
- name: Documentation
7-
url: https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/README.md
7+
url: https://github.com/LFDT-Panurus/panurus/blob/main/docs/README.md
88
about: Read the official documentation.

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ body:
1010
Before submitting:
1111
* **Search existing issues** and discussions to see if something similar has been discussed previously.
1212
* **Consult the Resources**:
13-
- [Documentation Overview](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/README.md)
14-
- [Development Guidelines](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/development/development.md)
15-
- [Testing Guide](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/development/testing.md)
13+
- [Documentation Overview](https://github.com/LFDT-Panurus/panurus/blob/main/docs/README.md)
14+
- [Development Guidelines](https://github.com/LFDT-Panurus/panurus/blob/main/docs/development/development.md)
15+
- [Testing Guide](https://github.com/LFDT-Panurus/panurus/blob/main/docs/development/testing.md)
1616
* **Consider opening a GitHub discussion** first to gather feedback and reach consensus.
1717
* If this is a major architectural change, please provide as much detail as possible.
1818

.github/ISSUE_TEMPLATE/good_first_issue.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ body:
1919
label: 🆕🐥 Newcomer Friendly
2020
description: Who is this issue for?
2121
value: |
22-
This **[Good First Issue](https://github.com/hyperledger-labs/fabric-token-sdk/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22)** is a guided, well-scoped task intended for new human contributors to the Fabric Token SDK.
22+
This **[Good First Issue](https://github.com/LFDT-Panurus/panurus/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22)** is a guided, well-scoped task intended for new human contributors to Panurus.
2323
2424
#### What you’ll do
2525
- ✅ Understand the project structure
@@ -83,8 +83,8 @@ body:
8383
label: 📋 Setup Guide
8484
description: Quick links for setting up the environment.
8585
value: |
86-
#### Setup the Fabric Token SDK
87-
- [ ] **Fork & Clone**: Follow the [Contributing Guide](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/CONTRIBUTING.md)
86+
#### Setup Panurus
87+
- [ ] **Fork & Clone**: Follow the [Contributing Guide](https://github.com/LFDT-Panurus/panurus/blob/main/CONTRIBUTING.md)
8888
- [ ] **Install Tools**: Run `make install-tools`
8989
validations:
9090
required: true
@@ -122,13 +122,13 @@ body:
122122
value: |
123123
If you get stuck, don't hesitate to ask!
124124
- Comment on this issue.
125-
- Join us on **Discord**: [#fabric-token-sdk](https://discord.gg/hyperledger)
125+
- Join us on **Discord**: [#panurus](https://discord.gg/hyperledger)
126126
127127
- type: markdown
128128
attributes:
129129
value: |
130130
---
131131
### 📚 Useful Resources
132-
- [Documentation Overview](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/README.md)
133-
- [Development Guidelines](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/development/development.md)
134-
- [Testing Guide](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/development/testing.md)
132+
- [Documentation Overview](https://github.com/LFDT-Panurus/panurus/blob/main/docs/README.md)
133+
- [Development Guidelines](https://github.com/LFDT-Panurus/panurus/blob/main/docs/development/development.md)
134+
- [Testing Guide](https://github.com/LFDT-Panurus/panurus/blob/main/docs/development/testing.md)

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Fabric Token SDK
1+
# Panurus
22

33
> **Performance Tip**: Use `Ctrl+F` to jump to sections using anchor links (e.g., `#building-and-running`)
44

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Fabric Token SDK
1+
# Contributing to Panurus
22

3-
We welcome contributions to the Fabric Token SDK!
3+
We welcome contributions to Panurus!
44

55
Note that we follow the [LFDT Charter](https://www.lfdecentralizedtrust.org/about/charter).
66
All new inbound code contributions to the project shall be made under the Apache License, Version 2.0.
@@ -26,9 +26,9 @@ Please note that we have a [Code of Conduct](CODE_OF_CONDUCT.md). Please follow
2626
We maintain a set of issues labeled "good first issue" to help new contributors find approachable tasks and get started quickly.
2727
If you're contributing for the first time, please consider picking one of these issues:
2828

29-
- Browse the current list here: https://github.com/hyperledger-labs/fabric-token-sdk/issues?q=is%3Aissue+state%3Aopen+label%3A%22good+first+issue%22
29+
- Browse the current list here: https://github.com/LFDT-Panurus/panurus/issues?q=is%3Aissue+state%3Aopen+label%3A%22good+first+issue%22
3030
- Leave a comment on the issue saying you'd like to work on it and ask to be assigned.
31-
- If you need clarification or guidance, ask on our Discord channel (`#fabric-token-sdk`) or comment on the issue — maintainers and community members are happy to help.
31+
- If you need clarification or guidance, ask on our Discord channel (`#panurus`) or comment on the issue — maintainers and community members are happy to help.
3232
- Keep your first PR small and focused. Follow the project guidelines: run tests, sign your commits (`-s`), and rebase to keep a linear history.
3333

3434
## Detailed Development Guidelines
@@ -41,8 +41,8 @@ Please refer to the [Development Guidelines](docs/development/development.md) fo
4141

4242
## Reporting Issues
4343

44-
If you find a bug or have a feature request, please search the [Issues](https://github.com/hyperledger-labs/fabric-token-sdk/issues) to see if it has already been reported. If not, please open a new issue.
44+
If you find a bug or have a feature request, please search the [Issues](https://github.com/LFDT-Panurus/panurus/issues) to see if it has already been reported. If not, please open a new issue.
4545

4646
## Community
4747

48-
Join us on [Discord](https://discord.gg/hyperledger) in the `#fabric-token-sdk` channel.
48+
Join us on [Discord](https://discord.gg/hyperledger) in the `#panurus` channel.

DEVELOPMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ To maintain clarity and traceability across contributions, all pull requests mus
7878

7979
- **Description**: Every pull request must include a meaningful description outlining the purpose and scope of the change.
8080
- **Labels**: Assign appropriate labels to help with categorization and prioritization.
81-
- **Project Assignment**: The pull request must be added to the **Fabric Token SDK** project with an appropriate status (e.g., “To Do”, “In Progress”, “In Review”, etc.).
81+
- **Project Assignment**: The pull request must be added to the **Panurus** project with an appropriate status (e.g., “To Do”, “In Progress”, “In Review”, etc.).
8282
- **Associated Issue**: A GitHub Issue must be linked to the pull request.
8383
This should be done via the Development section of the GitHub PR interface (not just mentioned in the description).
8484
This ensures the PR is formally connected to the issue for proper project tracking and status updates.

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ FABRIC_TWO_DIGIT_VERSION = $(shell echo $(FABRIC_VERSION) | cut -d '.' -f 1,2)
66
FABRIC_X_TOOLS_VERSION ?= v0.0.17
77
FABRIC_X_COMMITTER_VERSION ?= 1.0.0
88

9-
# need to install fabric binaries outside of fts tree for now (due to chaincode packaging issues)
9+
# need to install fabric binaries outside of panuru's tree for now (due to chaincode packaging issues)
1010
FABRIC_BINARY_BASE=$(PWD)/../fabric
1111
FAB_BINS ?= $(FABRIC_BINARY_BASE)/bin
1212

@@ -166,12 +166,12 @@ clean-fabric-peer-images:
166166
.PHONY: tokengen
167167
# install tokengen tool (must build without cgo; see #1445)
168168
tokengen:
169-
@cd ./cmd/tokengen/; CGO_ENABLED=0 go install github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen
169+
@cd ./cmd/tokengen/; CGO_ENABLED=0 go install github.com/LFDT-Panurus/panurus/cmd/tokengen
170170

171171
.PHONY: artifactgen
172172
# install artifactgen tool (must build without cgo; see #1445)
173173
artifactgen:
174-
@cd ./cmd/artifactgen/; CGO_ENABLED=0 go install github.com/hyperledger-labs/fabric-token-sdk/cmd/artifactgen
174+
@cd ./cmd/artifactgen/; CGO_ENABLED=0 go install github.com/LFDT-Panurus/panurus/cmd/artifactgen
175175

176176
.PHONY: traceinspector
177177
# install traceinspector tool

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
# Fabric Token SDK
1+
# Panurus
22
[![License](https://img.shields.io/badge/license-Apache%202-blue)](LICENSE)
3-
[![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger-labs/fabric-token-sdk)](https://goreportcard.com/badge/github.com/hyperledger-labs/fabric-token-sdk)
4-
[![Tests](https://github.com/hyperledger-labs/fabric-token-sdk/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/hyperledger-labs/fabric-token-sdk/actions/workflows/tests.yml)
5-
[![CodeQL](https://github.com/hyperledger-labs/fabric-token-sdk/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/hyperledger-labs/fabric-token-sdk/actions/workflows/codeql-analysis.yml)
6-
[![Coverage Status](https://coveralls.io/repos/github/hyperledger-labs/fabric-token-sdk/badge.svg?branch=main)](https://coveralls.io/github/hyperledger-labs/fabric-token-sdk?branch=main)
3+
[![Go Report Card](https://goreportcard.com/badge/github.com/LFDT-Panurus/panurus)](https://goreportcard.com/badge/github.com/LFDT-Panurus/panurus)
4+
[![Tests](https://github.com/LFDT-Panurus/panurus/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/LFDT-Panurus/panurus/actions/workflows/tests.yml)
5+
[![CodeQL](https://github.com/LFDT-Panurus/panurus/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/LFDT-Panurus/panurus/actions/workflows/codeql-analysis.yml)
6+
[![Coverage Status](https://coveralls.io/repos/github/LFDT-Panurus/panurus/badge.svg?branch=main)](https://coveralls.io/github/LFDT-Panurus/panurus?branch=main)
77

8-
The `Fabric Token SDK` provides a collection of APIs and services that streamline development for token-based distributed applications.
8+
`Panurs` provides a collection of APIs and services that streamline development for token-based distributed applications.
99

1010
# Disclaimer
1111

12-
`Fabric Token SDK` has not been audited and is provided as-is, use at your own risk.
12+
`Panurus` has not been audited and is provided as-is, use at your own risk.
1313
The project will be subject to rapid changes to complete the open-sourcing process, and the list of features.
1414

1515
# Useful Links
1616

17-
- [`Documentation`](docs/README.md): The entry point for the Fabric Token SDK documentation.
18-
- [`Code Wiki`](https://codewiki.google/github.com/hyperledger-labs/fabric-token-sdk): AI-powered documentation, architecture overviews, and interactive exploration of the Fabric Token SDK codebase.
17+
- [`Documentation`](docs/README.md): The entry point for Panurus documentation.
18+
- [`Code Wiki`](https://codewiki.google/github.com/LFDT-Panurus/panurus): AI-powered documentation, architecture overviews, and interactive exploration of Panurus codebase.
1919
- [`Development`](docs/development/development.md): All about the development guidelines.
2020
- [`Contributing`](CONTRIBUTING.md): How to contribute to the project.
21-
- [`Fabric Samples`](https://github.com/hyperledger/fabric-samples/tree/main/token-sdk) Token SDK sample application is the
21+
- [`Fabric Samples`](https://github.com/hyperledger/fabric-samples/tree/main/token-sdk) Panurus sample application is the
2222
quickest way to get a full network running with a REST API to issue, transfer and redeem tokens right away.
2323
- [`Benchmarks`](./docs/drivers/benchmark/benchmark.md): Benchmark guidelines and reports.
24-
- `Feedback`: Your help is the key to the success of the Fabric Token SDK.
25-
- Submit your issues [`here`][`fabric-token-sdk` Issues].
24+
- `Feedback`: Your help is the key to the success of Panurus.
25+
- Submit your issues [`here`][`panurus` Issues].
2626
- Found a bug? Need help to fix an issue? You have a great idea for a new feature? Talk to us! You can reach us on
27-
[Discord](https://discord.gg/hyperledger) in #fabric-token-sdk.
27+
[Discord](https://discord.gg/hyperledger) in #panurus.
2828

29-
- [`Fabric Smart Client`](https://github.com/hyperledger-labs/fabric-smart-client): The Token SDK leverages the
29+
- [`Fabric Smart Client`](https://github.com/hyperledger-labs/fabric-smart-client): Panurus leverages the
3030
`Fabric Smart Client` for transaction orchestration, storing tokens and wallets, and more. Check it out.
3131

3232
# Additional Resources
@@ -35,9 +35,9 @@ The project will be subject to rapid changes to complete the open-sourcing proce
3535
Tokenizing the physical world is a hot blockchain topic in the industry, especially as it relates to the
3636
trade of tokens as a basis of new forms of commerce. In this Hyperledger Foundation member webinar,
3737
the IBM Research team describes in this webinar what tokenization use cases are possible with Hyperledger Fabric today,
38-
and what enhancements are in the works (aka Fabric Token SDK).
38+
and what enhancements are in the works (aka Panurus).
3939
- (October 12, 2023) [How to create a currency management app and deploy it to a Hyperledger Fabric network](https://www.youtube.com/watch?v=PX9SDva97vQ):
40-
In this comprehensive guide, we'll walk you through two essential aspects of the Fabric Token-SDK. Firstly, you'll learn how to develop a straightforward token application to manage a currency. You'll grasp the fundamentals of creating tokens, and implementing transaction logic using the Fabric Token-SDK. Once you've mastered the application development, we'll then show you how to effortlessly deploy it in your existing Fabric network, ensuring a seamless integration with your blockchain infrastructure. By the end of this tutorial, you'll be equipped with the skills to expand your blockchain capabilities and unleash the true potential of decentralized currency management. (Refers to [Fabric Samples](https://github.com/hyperledger/fabric-samples/tree/main/token-sdk))
40+
In this comprehensive guide, we'll walk you through two essential aspects of Panurus. Firstly, you'll learn how to develop a straightforward token application to manage a currency. You'll grasp the fundamentals of creating tokens, and implementing transaction logic using Panurus. Once you've mastered the application development, we'll then show you how to effortlessly deploy it in your existing Fabric network, ensuring a seamless integration with your blockchain infrastructure. By the end of this tutorial, you'll be equipped with the skills to expand your blockchain capabilities and unleash the true potential of decentralized currency management. (Refers to [Fabric Samples](https://github.com/hyperledger/fabric-samples/tree/main/token-sdk))
4141

4242
# Motivation
4343

@@ -53,9 +53,9 @@ While blockchain is often associated with cryptocurrencies, its potential extend
5353

5454
Developing applications that leverage tokens on Hyperledger Fabric can be complex. Fabric lacked a built-in SDK for creating and managing tokens, forcing developers to build solutions from scratch. This not only led to wasted effort with duplicated code, but also exposed applications to potential security vulnerabilities.
5555

56-
**Introducing the Fabric Token SDK: Streamlining Tokenized Development (and Beyond)**
56+
**Introducing Panurus: Streamlining Tokenized Development (and Beyond)**
5757

58-
The Fabric Token SDK has evolved beyond its initial focus on Hyperledger Fabric. It now empowers developers with the following capabilities across various platforms, including permissioned blockchains like Fabric:
58+
Panurus has evolved beyond its initial focus on Hyperledger Fabric. It now empowers developers with the following capabilities across various platforms, including permissioned blockchains like Fabric:
5959

6060
* **Tokenization Made Easy:** Create tokens representing any type of asset, be it physical or digital.
6161
* **Privacy by Design:** Select the appropriate privacy level for your specific use case, without modifying your application logic.
@@ -65,11 +65,11 @@ The Fabric Token SDK has evolved beyond its initial focus on Hyperledger Fabric.
6565
* **Interoperability:** Connect with token systems on other blockchain networks, fostering broader ecosystems.
6666
* **Seamless Integration:** Add a token layer to existing applications, regardless of platform, with minimal effort.
6767

68-
With a robust Fabric Token SDK, developing secure and efficient enterprise-grade tokenized applications becomes a reality, offering flexibility for developers to choose the platform that best suits their needs.
68+
With Panurus, developing secure and efficient enterprise-grade tokenized applications becomes a reality, offering flexibility for developers to choose the platform that best suits their needs.
6969

7070
# License
7171

7272
This project is licensed under the Apache 2 License - see the [`LICENSE`](LICENSE) file for details
7373

74-
[`fabric-token-sdk` Issues]: https://github.com/hyperledger-labs/fabric-token-sdk/issues
75-
[#fabric-token-sdk in Discord]: https://discord.gg/hyperledger
74+
[`Panurus` Issues]: https://github.com/LFDT-Panurus/panurus/issues
75+
[#panurus in Discord]: https://discord.gg/hyperledger

buf.gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ plugins:
33
- local: protoc-gen-go
44
out: .
55
opt:
6-
- module=github.com/hyperledger-labs/fabric-token-sdk
6+
- module=github.com/LFDT-Panurus/panurus

0 commit comments

Comments
 (0)