Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KOSASIH authored Jul 27, 2024
1 parent 96d3750 commit 3509a51
Showing 1 changed file with 59 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Nexus Smart Chain Bridge Contracts

This repository contains the bridge contracts for the Nexus Smart Chain, a part of the PI-Nexus Autonomous Banking Network.

# Overview

The Nexus Smart Chain bridge contracts enable the seamless transfer of assets between the Ethereum blockchain and the Polkadot network. The bridge contracts are designed to provide a secure, efficient, and decentralized way to move assets between the two networks.

# Contracts

The following contracts are included in this repository:

- NexusSmartChainBridgeFactory: A factory contract that deploys new bridge contracts.
- NexusSmartChainRelayerFactory: A factory contract that deploys new relayer contracts.
- NexusSmartChainTokenFactory: A factory contract that deploys new token contracts.
- NexusSmartChainBridge: A bridge contract that enables the transfer of assets between Ethereum and Polkadot.
- NexusSmartChainRelayer: A relayer contract that relays messages between Ethereum and Polkadot.
- NexusSmartChainToken: A token contract that represents an asset on the Nexus Smart Chain.

# Installation

To install the bridge contracts, follow these steps:

1. Clone the repository: git clone https://github.com/KOSASIH/pi-nexus-autonomous-banking-network.git
2. Navigate to the bridge contracts directory: cd pi-nexus-autonomous-banking-network/blockchain_integration/pi_network/pi-network-interoperability/bridge-contracts/nexus-smart-chain
3. Install the dependencies: npm install

# Deployment

To deploy the bridge contracts, follow these steps:

1. Compile the contracts: npx hardhat compile
2. Deploy the contracts: npx hardhat deploy

# Testing

To test the bridge contracts, follow these steps:

1. Run the tests: npx hardhat test

# License

The Nexus Smart Chain bridge contracts are licensed under the MIT License.

# Contributing

Contributions to the Nexus Smart Chain bridge contracts are welcome. To contribute, follow these steps:

1. Fork the repository: git fork https://github.com/KOSASIH/pi-nexus-autonomous-banking-network.git
2. Create a new branch: git branch my-feature
3. Make your changes: git add. and git commit -m "My feature"
4. Push your changes: git push origin my-feature
5. Create a pull request: git request-pull origin my-feature

# Acknowledgments

The Nexus Smart Chain bridge contracts were developed by the PI-Nexus Autonomous Banking Network team. Special thanks to the contributors who have helped make this project possible.

*Enjoy your day* ... ☺ .. ☕

0 comments on commit 3509a51

Please sign in to comment.