@arianee/contracts

Arianee Contracts

This repository contains the smart contracts, deployment scripts, and tests of the Arianee protocol.

We are leveraging the power of Hardhat, an advanced development environment designed specifically for EVMs, to enable efficient and robust DX.

What is Arianee ?

Arianee is a pioneering, blockchain-based protocol designed to forge lasting relationships between brands and their customers. The Arianee protocol empowers brands to issue digital certificates of authenticity or ownership for their products, represented as non-fungible tokens (NFTs) on the Ethereum blockchain. This isn't limited just to physical products, but can also be extended to intangible assets such as loyalty cards, digital goods, experiences and more, creating a versatile ecosystem of verified assets.

Key features of Arianee include:

• Creation and Minting of NFTs: Brands can create digital representations or "passports" of their assets - tangible or intangible - as NFTs.
• Transfer of NFTs: These digital assets can be easily transferred from one owner to another, facilitating a secure and transparent secondary market.
• Proof of Ownership: The protocol enables owners to prove their ownership of an asset both online and in real life, enhancing trust and reducing fraud.
• Direct-to-Asset Messaging: Brands can send messages directly to the NFT holders, enabling a direct communication channel with the customer.
• Update and Recall of NFTs: Brands can update the content of minted NFTs, and recover them to their issuer if necessary (i.e in case of theft or loss).

Read more about the Arianee protocol at docs.arianee.org.

Installation

npm install @arianee/contracts

Usage

You can use the types and factories generated with TypeChain for ethers6.

Example:

import { CreditManager, CreditManager__factory } from "@arianee/contracts";

const creditManagerContract = CreditManager__factory.connect(
  "0x123456",
  contractRunner
);

Development

To get started with this repository, first install the necessary dependencies:

npm install

Tests

To run the tests, run the following command:

npm run test

Deployment

To deploy the contracts, run the following command:

npm run deploy

Others useful commands

• npm run deploy-protocol -- --ver <protocolVersion> --aria <ariaTokenAddress> --forwarder <trustedForwarderAddress> --network <targetNetwork>: Deploy a new version of the Arianee protocol.
• npm run configure-protocol -- --ver <protocolVersion> --aria <ariaTokenAddress> --forwarder <trustedForwarderAddress> --network <targetNetwork>: Configure the CreditManager and RulesManager.contracts of a deployed Arianee protocol. Please also take a look at ConfigureProtocolTaskParams in ./plugins/configure-protocol.ts before running this command.
• npm run deploy-registry -- --ver <registryVersion> --arianee <arianeeAddress> --forwarder <trustedForwarderAddress>: Deploy an OwnershipRegistry contract.
• npm run register-token -- --regver <registryVersion> --address <tokenAddress> --subens <subdomain>.arianee.eth --network <targetNetwork>: Register a token on the OwnershipRegistry.
• npm run register-issuer -- --regver <registryVersion> --address <issuerAddress> --subens <subdomain>.arianee.eth --network <targetNetwork>: Register an issuer on the OwnershipRegistry.
• npm run deploy-test-smart-asset -- --protover <protocolVersion> --forwarder <trustedForwarderAddress> --network <targetNetwork>: Deploy a TestSmartAsset contract with pre-defined parameters
• npm run test-flow -- --protover <protocolVersion> --regver <registryVersion> --smartasset <smartAssetAddress> --network <targetNetwork> --subens <subdomain>.arianee.eth --ensnetwork <targetEnsNetwork>: Execute a pre-defined test flow.
• npm run deploy-ctf -- --ver <contractVersion> --forwarder <trustedForwarderAddress>: Deploy a MockGaslessCaptureTheFlag contract.
• npm run gen:interfaces: Run a custom Hardhat plugin to generate Solidity interfaces for all contracts defined in plugins/gen-interfaces.ts.
• npm run gen:doc: Run @primitivefinance/hardhat-dodoc to generate documentation for all contracts.
• npx hardhat help: Displays help and usage instructions for Hardhat.
• npx hardhat node: Starts a local Ethereum node on your machine.

Contributing

We welcome contributions from the community. To contribute, please fork the repository and submit a pull request with your changes.

Make sure to include tests for any new functionality and ensure that all tests are passing before submitting the pull request.