# Ethereum on Amazon Managed Blockchain
[![license](https://img.shields.io/github/license/cdklabs/cdk-ethereum-node?color=green)](https://opensource.org/licenses/MIT)
[![release](https://img.shields.io/github/v/release/cdklabs/cdk-ethereum-node?color=green)](https://github.com/cdklabs/cdk-ethereum-node/releases)
[![npm:version](https://img.shields.io/npm/v/@cdklabs/cdk-ethereum-node?color=blue)](https://www.npmjs.com/package/@cdklabs/cdk-ethereum-node)
[![PyPi:version](https://img.shields.io/pypi/v/cdklabs.cdk-ethereum-node?color=blue)](https://pypi.org/project/cdklabs.cdk-ethereum-node/)
[![Maven:version](https://img.shields.io/maven-central/v/io.github.cdklabs/cdk-ethereum-node?color=blue&label=maven)](https://central.sonatype.dev/artifact/io.github.cdklabs/cdk-ethereum-node/0.0.61)
[![NuGet:version](https://img.shields.io/nuget/v/Cdklabs.CdkEthereumNode?color=blue)](https://www.nuget.org/packages/Cdklabs.CdkEthereumNode)
This repository contains a CDK construct to deploy an Ethereum node running
on Amazon Managed Blockchain. The following networks are supported:
* Mainnet (default)
* Testnet: Goerli
* Testnet: Rinkeby
* Testnet: Ropsten
## 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-ethereum-node
```
#### Python
```bash
pip3 install cdklabs.cdk-ethereum-node
```
#### Java
Add the following to `pom.xml`:
```xml
<dependency>
<groupId>io.github.cdklabs</groupId>
<artifactId>cdk-ethereum-node</artifactId>
</dependency>
```
#### .NET
```bash
dotnet add package Cdklabs.CdkEthereumNode
```
## Usage
A minimally complete deployment is shown below. By default,
a `bc.t3.large` node will be created on the Ethereum Mainnet.
```python
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { EthereumNode, Network, InstanceType } from '@cdklabs/cdk-ethereum-node';
export class MyStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
new EthereumNode(this, 'Example');
}
}
```
The equivalent Python code is as follows:
```python
from aws_cdk import Stack
from cdklabs.cdk_ethereum_node import EthereumNode
class MyStack(Stack):
def __init__(self, scope, id, **kwargs):
super().__init__(scope, id, **kwargs)
EthereumNode(self, 'Example')
```
The following is a more complex instantiation illustrating some of the node configuration options available.
```python
new EthereumNode(this, 'Example', {
network: Network.ROPSTEN,
availabilityZone: 'us-east-1b',
instanceType: InstanceType.BURSTABLE3_LARGE,
});
```
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/)
* [Ethereum](https://ethereum.org/en/developers/docs/)
## 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
* Trinity Key (trinikey@amazon.com)
* Marc Gozali (gozalim@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-ethereum-node.git",
"name": "cdklabs.cdk-ethereum-node",
"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/df/cc/677bb10af171c5c37bc8046b73a3e47c4b70f3cd80513381388017f625c5/cdklabs.cdk-ethereum-node-0.0.545.tar.gz",
"platform": null,
"description": "# Ethereum on Amazon Managed Blockchain\n\n[![license](https://img.shields.io/github/license/cdklabs/cdk-ethereum-node?color=green)](https://opensource.org/licenses/MIT)\n[![release](https://img.shields.io/github/v/release/cdklabs/cdk-ethereum-node?color=green)](https://github.com/cdklabs/cdk-ethereum-node/releases)\n[![npm:version](https://img.shields.io/npm/v/@cdklabs/cdk-ethereum-node?color=blue)](https://www.npmjs.com/package/@cdklabs/cdk-ethereum-node)\n[![PyPi:version](https://img.shields.io/pypi/v/cdklabs.cdk-ethereum-node?color=blue)](https://pypi.org/project/cdklabs.cdk-ethereum-node/)\n[![Maven:version](https://img.shields.io/maven-central/v/io.github.cdklabs/cdk-ethereum-node?color=blue&label=maven)](https://central.sonatype.dev/artifact/io.github.cdklabs/cdk-ethereum-node/0.0.61)\n[![NuGet:version](https://img.shields.io/nuget/v/Cdklabs.CdkEthereumNode?color=blue)](https://www.nuget.org/packages/Cdklabs.CdkEthereumNode)\n\nThis repository contains a CDK construct to deploy an Ethereum node running\non Amazon Managed Blockchain. The following networks are supported:\n\n* Mainnet (default)\n* Testnet: Goerli\n* Testnet: Rinkeby\n* Testnet: Ropsten\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-ethereum-node\n```\n\n#### Python\n\n```bash\npip3 install cdklabs.cdk-ethereum-node\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-ethereum-node</artifactId>\n</dependency>\n```\n\n#### .NET\n\n```bash\ndotnet add package Cdklabs.CdkEthereumNode\n```\n\n## Usage\n\nA minimally complete deployment is shown below. By default,\na `bc.t3.large` node will be created on the Ethereum Mainnet.\n\n```python\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { Construct } from 'constructs';\nimport { EthereumNode, Network, InstanceType } from '@cdklabs/cdk-ethereum-node';\n\nexport class MyStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n new EthereumNode(this, 'Example');\n }\n}\n```\n\nThe equivalent Python code is as follows:\n\n```python\nfrom aws_cdk import Stack\nfrom cdklabs.cdk_ethereum_node import EthereumNode\n\nclass MyStack(Stack):\n def __init__(self, scope, id, **kwargs):\n super().__init__(scope, id, **kwargs)\n EthereumNode(self, 'Example')\n```\n\nThe following is a more complex instantiation illustrating some of the node configuration options available.\n\n```python\nnew EthereumNode(this, 'Example', {\n network: Network.ROPSTEN,\n availabilityZone: 'us-east-1b',\n instanceType: InstanceType.BURSTABLE3_LARGE,\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* [Ethereum](https://ethereum.org/en/developers/docs/)\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* Trinity Key (trinikey@amazon.com)\n* Marc Gozali (gozalim@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 an Ethereum node running on Amazon Managed Blockchain",
"version": "0.0.545",
"project_urls": {
"Homepage": "https://github.com/cdklabs/cdk-ethereum-node.git",
"Source": "https://github.com/cdklabs/cdk-ethereum-node.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "66399b7d0c9f253b1ed1bb1612a483b8677e397b8f41719002b77ad33c35e3c6",
"md5": "e82714b1cd138bc7fc674c981125c44c",
"sha256": "6d9b25c30af5c78010e891311d0315a71605e3ce5348cde1234c7d3d17ff0083"
},
"downloads": -1,
"filename": "cdklabs.cdk_ethereum_node-0.0.545-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e82714b1cd138bc7fc674c981125c44c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 26847,
"upload_time": "2024-05-12T00:21:36",
"upload_time_iso_8601": "2024-05-12T00:21:36.862758Z",
"url": "https://files.pythonhosted.org/packages/66/39/9b7d0c9f253b1ed1bb1612a483b8677e397b8f41719002b77ad33c35e3c6/cdklabs.cdk_ethereum_node-0.0.545-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dfcc677bb10af171c5c37bc8046b73a3e47c4b70f3cd80513381388017f625c5",
"md5": "ce1257c941d927de9cea80212fe4a9e7",
"sha256": "e08cbea41a2242cbf20eb96fa0453db2155bb52164ef6ccabc1e55abc8d4f70e"
},
"downloads": -1,
"filename": "cdklabs.cdk-ethereum-node-0.0.545.tar.gz",
"has_sig": false,
"md5_digest": "ce1257c941d927de9cea80212fe4a9e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 27950,
"upload_time": "2024-05-12T00:21:42",
"upload_time_iso_8601": "2024-05-12T00:21:42.283860Z",
"url": "https://files.pythonhosted.org/packages/df/cc/677bb10af171c5c37bc8046b73a3e47c4b70f3cd80513381388017f625c5/cdklabs.cdk-ethereum-node-0.0.545.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-12 00:21:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cdklabs",
"github_project": "cdk-ethereum-node",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cdklabs.cdk-ethereum-node"
}