cdklabs.cdk-hyperledger-fabric-network


Namecdklabs.cdk-hyperledger-fabric-network JSON
Version 0.8.607 PyPI version JSON
download
home_pagehttps://github.com/cdklabs/cdk-hyperledger-fabric-network.git
SummaryCDK construct to deploy a Hyperledger Fabric network running on Amazon Managed Blockchain
upload_time2024-04-19 00:16:04
maintainerNone
docs_urlNone
authorAmazon Web Services
requires_python~=3.8
licenseMIT-0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Hyperledger Fabric on Amazon Managed Blockchain

[![license](https://img.shields.io/github/license/cdklabs/cdk-hyperledger-fabric-network?color=green)](https://opensource.org/licenses/MIT)
[![release](https://img.shields.io/github/v/release/cdklabs/cdk-hyperledger-fabric-network?color=green)](https://github.com/cdklabs/cdk-hyperledger-fabric-network/releases)
[![npm:version](https://img.shields.io/npm/v/@cdklabs/cdk-hyperledger-fabric-network?color=blue)](https://www.npmjs.com/package/@cdklabs/cdk-hyperledger-fabric-network)
[![PyPi:version](https://img.shields.io/pypi/v/cdklabs.cdk-hyperledger-fabric-network?color=blue)](https://pypi.org/project/cdklabs.cdk-hyperledger-fabric-network/)
[![Maven:version](https://img.shields.io/maven-central/v/io.github.cdklabs/cdk-hyperledger-fabric-network?color=blue&label=maven)](https://central.sonatype.dev/artifact/io.github.cdklabs/cdk-hyperledger-fabric-network/0.8.147)
[![NuGet:version](https://img.shields.io/nuget/v/Cdklabs.CdkHyperledgerFabricNetwork?color=blue)](https://www.nuget.org/packages/Cdklabs.CdkHyperledgerFabricNetwork)

This repository contains a CDK construct to deploy a Hyperledger Fabric network
running on Amazon Managed Blockchain. It builds out a member and its nodes, a VPC
and associated endpoint to access them, and a set of users enrolled on the network.

The following functionality is planned for future releases:

* Create channels on nodes
* Instantiate chaincode on nodes

## Installation

Note that this construct requires [AWS CDK v2](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install).

#### JavaScript

```bash
npm install --save @cdklabs/cdk-hyperledger-fabric-network
```

#### Python

```bash
pip3 install cdklabs.cdk-hyperledger-fabric-network
```

#### Java

Add the following to `pom.xml`:

```xml
<dependency>
  <groupId>io.github.cdklabs</groupId>
  <artifactId>cdk-hyperledger-fabric-network</artifactId>
</dependency>
```

#### .NET

```bash
dotnet add package Cdklabs.CdkHyperledgerFabricNetwork
```

## Usage

A minimally complete deployment is shown below. By default, a standard network
will be created running Hyperledger Fabric 1.4 with a single `bc.t3.small` node.

```python
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { HyperledgerFabricNetwork } from '@cdklabs/cdk-hyperledger-fabric-network';

class MyStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
    new HyperledgerFabricNetwork(this, 'Example', {
      networkName: 'MyNetwork',
      memberName: 'MyMember',
    });
  }
}
```

The equivalent Python code is as follows:

```python
from aws_cdk import Stack
from cdklabs.cdk_hyperledger_fabric_network import HyperledgerFabricNetwork

class MyStack(Stack):
    def __init__(self, scope, id, **kwargs):
        super().__init__(scope, id, **kwargs)
        HyperledgerFabricNetwork(
            self, 'Example',
            network_name='MyNetwork',
            member_name='MyMember',
        )
```

The following is a more complex instantiation illustrating some of the options available.

```python
new HyperledgerFabricNetwork(this, 'Example', {
  networkName: 'MyNetwork',
  networkDescription: 'This is my Hyperledger Fabric network',
  memberName: 'MyMember',
  networkDescription: 'This is my Hyperledger Fabric member',
  frameworkVersion: hyperledger.FrameworkVersion.VERSION_1_2,
  proposalDurationInHours: 48,
  thresholdPercentage: 75,
  nodes: [
    {
      availabilityZone: 'us-east-1a',
      instanceType: hyperledger.InstanceType.STANDARD5_LARGE,
    },
    {
      availabilityZone: 'us-east-1b',
      instanceType: hyperledger.InstanceType.STANDARD5_LARGE,
    },
  ],
  users: [
    { userId: 'AppUser1', affilitation: 'MyMember' },
    { userId: 'AppUser2', affilitation: 'MyMember.department1' },
  ],
});
```

See the [API Documentation](API.md) for details on all available input and output parameters.

## References

* [AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/home.html)
* [Amazon Managed Blockchain](https://aws.amazon.com/managed-blockchain/)
* [Hyperledger Fabric](https://hyperledger-fabric.readthedocs.io/)
* [Node Fabric SDK](https://hyperledger.github.io/fabric-sdk-node/release-1.4/index.html)
* [Fabric Chaincode Node](https://hyperledger.github.io/fabric-chaincode-node/)

## Contributing

Pull requests are welcomed. Please review the [Contributing Guidelines](CONTRIBUTING.md)
and the [Code of Conduct](CODE_OF_CONDUCT.md).

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## Authors

* Jud Neer (judneer@amazon.com)
* Vignesh Rajasingh (vrajasin@amazon.com)

## License

This project is licensed under the MIT-0 License. See the [LICENSE](LICENSE) file for details.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cdklabs/cdk-hyperledger-fabric-network.git",
    "name": "cdklabs.cdk-hyperledger-fabric-network",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Amazon Web Services",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/14/e1/804a8828139d7f5612635433a4a568d1e6b9db32b9d8d8443ae1ea869e0d/cdklabs.cdk-hyperledger-fabric-network-0.8.607.tar.gz",
    "platform": null,
    "description": "# Hyperledger Fabric on Amazon Managed Blockchain\n\n[![license](https://img.shields.io/github/license/cdklabs/cdk-hyperledger-fabric-network?color=green)](https://opensource.org/licenses/MIT)\n[![release](https://img.shields.io/github/v/release/cdklabs/cdk-hyperledger-fabric-network?color=green)](https://github.com/cdklabs/cdk-hyperledger-fabric-network/releases)\n[![npm:version](https://img.shields.io/npm/v/@cdklabs/cdk-hyperledger-fabric-network?color=blue)](https://www.npmjs.com/package/@cdklabs/cdk-hyperledger-fabric-network)\n[![PyPi:version](https://img.shields.io/pypi/v/cdklabs.cdk-hyperledger-fabric-network?color=blue)](https://pypi.org/project/cdklabs.cdk-hyperledger-fabric-network/)\n[![Maven:version](https://img.shields.io/maven-central/v/io.github.cdklabs/cdk-hyperledger-fabric-network?color=blue&label=maven)](https://central.sonatype.dev/artifact/io.github.cdklabs/cdk-hyperledger-fabric-network/0.8.147)\n[![NuGet:version](https://img.shields.io/nuget/v/Cdklabs.CdkHyperledgerFabricNetwork?color=blue)](https://www.nuget.org/packages/Cdklabs.CdkHyperledgerFabricNetwork)\n\nThis repository contains a CDK construct to deploy a Hyperledger Fabric network\nrunning on Amazon Managed Blockchain. It builds out a member and its nodes, a VPC\nand associated endpoint to access them, and a set of users enrolled on the network.\n\nThe following functionality is planned for future releases:\n\n* Create channels on nodes\n* Instantiate chaincode on nodes\n\n## Installation\n\nNote that this construct requires [AWS CDK v2](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install).\n\n#### JavaScript\n\n```bash\nnpm install --save @cdklabs/cdk-hyperledger-fabric-network\n```\n\n#### Python\n\n```bash\npip3 install cdklabs.cdk-hyperledger-fabric-network\n```\n\n#### Java\n\nAdd the following to `pom.xml`:\n\n```xml\n<dependency>\n  <groupId>io.github.cdklabs</groupId>\n  <artifactId>cdk-hyperledger-fabric-network</artifactId>\n</dependency>\n```\n\n#### .NET\n\n```bash\ndotnet add package Cdklabs.CdkHyperledgerFabricNetwork\n```\n\n## Usage\n\nA minimally complete deployment is shown below. By default, a standard network\nwill be created running Hyperledger Fabric 1.4 with a single `bc.t3.small` node.\n\n```python\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { Construct } from 'constructs';\nimport { HyperledgerFabricNetwork } from '@cdklabs/cdk-hyperledger-fabric-network';\n\nclass MyStack extends Stack {\n  constructor(scope: Construct, id: string, props?: StackProps) {\n    super(scope, id, props);\n    new HyperledgerFabricNetwork(this, 'Example', {\n      networkName: 'MyNetwork',\n      memberName: 'MyMember',\n    });\n  }\n}\n```\n\nThe equivalent Python code is as follows:\n\n```python\nfrom aws_cdk import Stack\nfrom cdklabs.cdk_hyperledger_fabric_network import HyperledgerFabricNetwork\n\nclass MyStack(Stack):\n    def __init__(self, scope, id, **kwargs):\n        super().__init__(scope, id, **kwargs)\n        HyperledgerFabricNetwork(\n            self, 'Example',\n            network_name='MyNetwork',\n            member_name='MyMember',\n        )\n```\n\nThe following is a more complex instantiation illustrating some of the options available.\n\n```python\nnew HyperledgerFabricNetwork(this, 'Example', {\n  networkName: 'MyNetwork',\n  networkDescription: 'This is my Hyperledger Fabric network',\n  memberName: 'MyMember',\n  networkDescription: 'This is my Hyperledger Fabric member',\n  frameworkVersion: hyperledger.FrameworkVersion.VERSION_1_2,\n  proposalDurationInHours: 48,\n  thresholdPercentage: 75,\n  nodes: [\n    {\n      availabilityZone: 'us-east-1a',\n      instanceType: hyperledger.InstanceType.STANDARD5_LARGE,\n    },\n    {\n      availabilityZone: 'us-east-1b',\n      instanceType: hyperledger.InstanceType.STANDARD5_LARGE,\n    },\n  ],\n  users: [\n    { userId: 'AppUser1', affilitation: 'MyMember' },\n    { userId: 'AppUser2', affilitation: 'MyMember.department1' },\n  ],\n});\n```\n\nSee the [API Documentation](API.md) for details on all available input and output parameters.\n\n## References\n\n* [AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/home.html)\n* [Amazon Managed Blockchain](https://aws.amazon.com/managed-blockchain/)\n* [Hyperledger Fabric](https://hyperledger-fabric.readthedocs.io/)\n* [Node Fabric SDK](https://hyperledger.github.io/fabric-sdk-node/release-1.4/index.html)\n* [Fabric Chaincode Node](https://hyperledger.github.io/fabric-chaincode-node/)\n\n## Contributing\n\nPull requests are welcomed. Please review the [Contributing Guidelines](CONTRIBUTING.md)\nand the [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## Authors\n\n* Jud Neer (judneer@amazon.com)\n* Vignesh Rajasingh (vrajasin@amazon.com)\n\n## License\n\nThis project is licensed under the MIT-0 License. See the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": "MIT-0",
    "summary": "CDK construct to deploy a Hyperledger Fabric network running on Amazon Managed Blockchain",
    "version": "0.8.607",
    "project_urls": {
        "Homepage": "https://github.com/cdklabs/cdk-hyperledger-fabric-network.git",
        "Source": "https://github.com/cdklabs/cdk-hyperledger-fabric-network.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ef9073f3149d9776e69839353c7113f5fe306e28034e9733ca5a6c6495c43e55",
                "md5": "2bd7bc1c994a8b7a2926a15154f1f9cc",
                "sha256": "23b9ed28ab5024af916827ce24e3f51841a6fa5e1f0aa7a3dd043c08e4513fa0"
            },
            "downloads": -1,
            "filename": "cdklabs.cdk_hyperledger_fabric_network-0.8.607-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2bd7bc1c994a8b7a2926a15154f1f9cc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.8",
            "size": 72087,
            "upload_time": "2024-04-19T00:15:58",
            "upload_time_iso_8601": "2024-04-19T00:15:58.571675Z",
            "url": "https://files.pythonhosted.org/packages/ef/90/73f3149d9776e69839353c7113f5fe306e28034e9733ca5a6c6495c43e55/cdklabs.cdk_hyperledger_fabric_network-0.8.607-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "14e1804a8828139d7f5612635433a4a568d1e6b9db32b9d8d8443ae1ea869e0d",
                "md5": "8de6954e4a54f25144b23dc7ff37d47f",
                "sha256": "5969553c3841f28ba4bddc70095596c93b3763e477598ba43a8df77ae46b3c86"
            },
            "downloads": -1,
            "filename": "cdklabs.cdk-hyperledger-fabric-network-0.8.607.tar.gz",
            "has_sig": false,
            "md5_digest": "8de6954e4a54f25144b23dc7ff37d47f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.8",
            "size": 73497,
            "upload_time": "2024-04-19T00:16:04",
            "upload_time_iso_8601": "2024-04-19T00:16:04.388048Z",
            "url": "https://files.pythonhosted.org/packages/14/e1/804a8828139d7f5612635433a4a568d1e6b9db32b9d8d8443ae1ea869e0d/cdklabs.cdk-hyperledger-fabric-network-0.8.607.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-19 00:16:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cdklabs",
    "github_project": "cdk-hyperledger-fabric-network",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cdklabs.cdk-hyperledger-fabric-network"
}
Amazon Web Services
Elapsed time: 0.27810s