Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dirt-road-development/rorrim-protocol
Rirrom Protocol - a SKALE Network Protocol for Seamless asset movement
https://github.com/dirt-road-development/rorrim-protocol
blockchain evm ima innovation mirror rirrom skale-network solidity
Last synced: about 1 month ago
JSON representation
Rirrom Protocol - a SKALE Network Protocol for Seamless asset movement
- Host: GitHub
- URL: https://github.com/dirt-road-development/rorrim-protocol
- Owner: Dirt-Road-Development
- Created: 2023-07-21T16:42:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-21T23:37:24.000Z (over 1 year ago)
- Last Synced: 2024-11-11T18:29:45.192Z (3 months ago)
- Topics: blockchain, evm, ima, innovation, mirror, rirrom, skale-network, solidity
- Language: TypeScript
- Homepage:
- Size: 109 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rorrim Protocol
[](https://www.npmjs.com/package/@dirtroad/rorrim)
Rorrim Protocol is a SKALE specific smart contract protocol designed to help manage cross-chain NFT operations.
This software is currently a proof-of-concept to help simplify multi-chain interactions on SKALE.
## Installation
To add to your project, run:
```shell
npm add @dirtroad/rorrim
```
## Building
### rorrim Contract
To add the rorrim (target) contract to your project, import the following in your Solidity contract:
```solidity
import "@dirtroad/rorrim/contracts/rirrorm/rorrimNFT.sol";
```
### Calypso Contract
To add the calypso (target) contract to your project, import the following in your Solidity contract:
```solidity
import "@dirtroad/rorrim/contracts/rirrorm/CalypsoNFT.sol";
```
### Extending the rorrim Protocol
To extend the protocol to work on other SKALE Chains you can:
- Write your own launch script. See the default task at [Default Launch Task](./tasks)
- Write your own contracts that inherit the above and update or edit the [Default Launch Task](./tasks). For examples of extending the existing contracts see the [Mocks](./contracts/mocks/)
## Deployment (Launch)
To deploy the base protocol you must do the following:
1. Add a private key without the 0x to a .env file `cp .env.example .env && vim .env`
2. Make sure your ethereum account has deployer role on the necessary chains i.e Calypso/Nebula (Note - Chaos does not require deployer role)
Once complete, run the following to launch the protocol:
```shell
// Deploy on Mainnet (Calypso & Nebula)
npx hardhat launch --location mainnet --name --symbol
// Deploy on Testnet (Calypso & Nebula)
npx hardhat launch --location testnet --name --symbol
// Deploy on Testnet (Calypso & Chaos)
npx hardhat launch --location testnet-chaos --name --symbol
```
### Security and Liability
The rorrim Protocol contracts and code is WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.