Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cactus-plugin-persistence-fabric): add new persistence plugin for fabric ledger #2330

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
309 changes: 154 additions & 155 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -1,157 +1,156 @@
{
"version": "0.1",
"language": "en",
"minWordLength": 4,
"allowCompoundWords": true,
"words": [
"adminpw",
"Albertirsa",
"ALLFORTX",
"ANYFORTX",
"APIV",
"approveformyorg",
"Authz",
"authzn",
"AWSSM",
"Besu",
"Bools",
"brioux",
"cactusf",
"cafile",
"caio",
"cccs",
"ccid",
"celo",
"cids",
"clsx",
"commenceack",
"configtx",
"Corda",
"Cordapp",
"couchdb",
"COUCHDBADDRESS",
"COUCHDBCONFIG",
"data",
"dclm",
"DHTAPI",
"DockerOde",
"ealen",
"ecparams",
"embeddable",
"Errorf",
"escc",
"execa",
"faio",
"fidm",
"flowdb",
"fsouza",
"GETHKEYCHAINPASSWORD",
"ghcr",
"gopath",
"goquorum",
"grpc",
"grpcs",
"grpcwebtext",
"guks",
"hada",
"hashicorp",
"Healthcheck",
"htlc",
"Htlc",
"HTLC",
"HyperLedger",
"ipaddress",
"ipfs",
"Iroha",
"Irohad",
"isready",
"jboss",
"JORDI",
"jsrsa",
"jsrsasign",
"Keychain",
"Keycloak",
"KEYUTIL",
"KJUR",
"Knetic",
"LEDGERBLOCKACK",
"leveldb",
"lmify",
"LOCALMSPID",
"miekg",
"mitchellh",
"MSPCONFIGPATH",
"MSPID",
"MSPIDSCOPEALLFORTX",
"MSPIDSCOPEANYFORTX",
"Mtls",
"myapp",
"mychannel",
"myroot",
"mysecretpassword",
"myvolume",
"Nerc",
"NETWORKSCOPEALLFORTX",
"NETWORKSCOPEANYFORTX",
"NODETXPOOLACK",
"notok",
"Odap",
"Oidc",
"oneofs",
"onsi",
"OpenAPI",
"openethereum",
"organisation",
"Orgs",
"parameterizable",
"Postgres",
"proto",
"protobuf",
"protoc",
"protos",
"qscc",
"recoverupdateackmessage",
"RUSTC",
"Rwset",
"sbjpubkey",
"Secp",
"shrn",
"Smonitor",
"socketio",
"SPDX",
"Splug",
"Sprintf",
"stretchr",
"supervisorctl",
"supervisord",
"svcs",
"sykesm",
"tezos",
"TEZOS",
"thream",
"tlsca",
"tlscacerts",
"txid",
"txqueue",
"Uisrs",
"undici",
"Unmarshal",
"uuidv",
"vscc",
"wasm",
"Xdai"
],
"dictionaries": [
"typescript,node,npm,go,rust"
],
"ignorePaths": [
"**/node_modules/**",
"**/build/**",
"**/src/main/typescript/generated/**",
"packages/cactus-plugin-verifier-cc/**",
"packages/cactus-cmd-socketio-server/**",
"packages/cactus-plugin-ledger-connector-sawtooth-socketio/**",
"packages/cactus-plugin-ledger-connector-go-ethereum-socketio/**",
"packages/cactus-plugin-ledger-connector-*-socketio/**"
]
"version": "0.1",
"language": "en",
"minWordLength": 4,
"allowCompoundWords": true,
"words": [
"adminpw",
"Albertirsa",
"ALLFORTX",
"ANYFORTX",
"APIV",
"approveformyorg",
"Authz",
"authzn",
"AWSSM",
"Besu",
"Bools",
"brioux",
"cactusf",
"cafile",
"caio",
"cccs",
"ccid",
"celo",
"cids",
"clsx",
"commenceack",
"configtx",
"Corda",
"Cordapp",
"couchdb",
"COUCHDBADDRESS",
"COUCHDBCONFIG",
"data",
"dclm",
"DHTAPI",
"DockerOde",
"ealen",
"ecparams",
"embeddable",
"Errorf",
"escc",
"execa",
"faio",
"fidm",
"flowdb",
"fsouza",
"GETHKEYCHAINPASSWORD",
"ghcr",
"gopath",
"goquorum",
"grpc",
"grpcs",
"grpcwebtext",
"guks",
"hada",
"hashicorp",
"Healthcheck",
"htlc",
"Htlc",
"HTLC",
"HyperLedger",
"ipaddress",
"ipfs",
"Iroha",
"Irohad",
"isready",
"jboss",
"JORDI",
"jsrsa",
"jsrsasign",
"Keychain",
"Keycloak",
"KEYUTIL",
"KJUR",
"Knetic",
"LEDGERBLOCKACK",
"leveldb",
"lmify",
"LOCALMSPID",
"miekg",
"mitchellh",
"MSPCONFIGPATH",
"MSPID",
"MSPIDSCOPEALLFORTX",
"MSPIDSCOPEANYFORTX",
"Mtls",
"myapp",
"mychannel",
"myroot",
"mysecretpassword",
"myvolume",
"Nerc",
"NETWORKSCOPEALLFORTX",
"NETWORKSCOPEANYFORTX",
"NODETXPOOLACK",
"notok",
"Odap",
"Oidc",
"oneofs",
"onsi",
"OpenAPI",
"openethereum",
"organisation",
"Orgs",
"parameterizable",
"Postgres",
"proto",
"protobuf",
"protoc",
"protos",
"qscc",
"recoverupdateackmessage",
"RUSTC",
"Rwset",
"sbjpubkey",
"Secp",
"shrn",
"Smonitor",
"socketio",
"SPDX",
"Splug",
"Sprintf",
"stretchr",
"supervisorctl",
"supervisord",
"svcs",
"sykesm",
"tezos",
"TEZOS",
"thream",
"tlsca",
"tlscacerts",
"txid",
"txqueue",
"Uisrs",
"undici",
"Unmarshal",
"uuidv",
"vscc",
"wasm",
"Xdai",
"ossp"
],
"dictionaries": ["typescript,node,npm,go,rust"],
"ignorePaths": [
"**/node_modules/**",
"**/build/**",
"**/src/main/typescript/generated/**",
"packages/cactus-plugin-verifier-cc/**",
"packages/cactus-cmd-socketio-server/**",
"packages/cactus-plugin-ledger-connector-sawtooth-socketio/**",
"packages/cactus-plugin-ledger-connector-go-ethereum-socketio/**",
"packages/cactus-plugin-ledger-connector-*-socketio/**"
]
}
2 changes: 1 addition & 1 deletion packages/cactus-cmd-api-server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"bluebird": "3.7.2",
"body-parser": "1.19.0",
"compression": "1.7.4",
"convict": "6.2.4",
"convict": "6.2.3",
"convict-format-with-validator": "6.2.0",
"cors": "2.8.5",
"express": "4.17.1",
Expand Down
61 changes: 61 additions & 0 deletions packages/cactus-cmd-gui-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# `@hyperledger/cactus-cmd-gui-app`

This component allows viewing ledger data in Supabase or other postgreSQL compatible database. The data is fed to supabase by persistence plugins for each ledgers.

## Summary

- [`@hyperledger/cactus-cmd-gui-app`](#hyperledgercactus-cmd-gui-app)
- [Summary](#summary)
- [Remarks](#remarks)
- [Getting Started](#getting-started)
- [Prerequisites using yarn](#prerequisites-using-yarn)
- [Alternative Prerequisites using npm](#alternative-prerequisites-using-npm)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgments](#acknowledgments)

## Remarks

- Plugin requires running Supabase or other database and persistence plugins in order to properly view ledger data.
- Currently, fabric and ethereum based ledgers are supported.

## Getting Started

Clone the git repository on your local machine. Follow these instructions that will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites using yarn

In the root of the project, execute the command to install and build the dependencies. It will also build this GUI front-end component:

```sh
yarn run build
```
### Alternative Prerequisites using npm

In the root of the project, execute the command to install and build the dependencies. It will also build this GUI front-end component:

```sh
npm install
```

### Usage
- Run Supabase instance (see documentation for detailed instructions). For development purposes, you can use our image located in `tools/docker/supabase-all-in-one`.
- Run one or more persistence plugins:
- [Ethereum](../cactus-plugin-persistence-ethereum)
- [Fabric] (../cactus-plugin-persistence-fabric)
- Edit [Supabase configuration file](./src/supabase-client.tsx), set correct supabase API URL and service_role key.
- Execute `yarn run start` or `npm start` in this package directory.
- The running application address: http://localhost:3001/ (can be changed in [Vite configuration](./vite.config.ts))

## Contributing

We welcome contributions to Hyperledger Cactus in many forms, and there’s always plenty to do!

Please review [CONTIRBUTING.md](../../CONTRIBUTING.md) to get started.

## License

This distribution is published under the Apache License Version 2.0 found in the [LICENSE](../../LICENSE) file.

## Acknowledgments
Loading