Skip to content

README.md

Latest commit

 

History

History
135 lines (97 loc) · 4.5 KB

README.md

File metadata and controls

135 lines (97 loc) · 4.5 KB

Examples

This folder is a Yarn workspaces monorepo containing usage examples for bite-solidity. Each subdirectory is a thin, scenario-specific workspace member that compiles independently while reusing shared configuration and utilities from the workspace root.

Disclaimer: Code in this examples/ directory is not production-ready and is provided for educational and demonstration purposes only.

Project structure

examples/
├── package.json            # workspace root — shared dependencies
├── hardhat.config.ts       # shared Hardhat config (Solidity, networks, dependency compiler)
├── tsconfig.json           # shared TypeScript config
├── scripts/
│   └── utils.ts            # shared helpers (ECIES decrypt, key derivation)
├── encrypted-value-registry/
│   ├── package.json        # name + scripts only (no deps)
│   ├── hardhat.config.ts   # 2-line re-export of ../hardhat.config
│   ├── tsconfig.json       # extends ../tsconfig.json
│   ├── contracts/
│   └── scripts/
└── ...

Each example workspace member contains only its own contracts, scripts, and tests. Dependencies, Hardhat settings, and TypeScript configuration are defined once at the workspace root and inherited. This keeps examples minimal and makes future migrations (e.g., Hardhat v2 → v3) a single-point change.

Getting started

From the examples/ directory:

yarn install          # install all workspace dependencies
yarn compile          # compile all examples

Or compile a single example:

cd encrypted-value-registry
yarn compile

BITE integration flow

BITE 2 blockchains expose three precompiled contracts for confidential computation:

Precompile Address Description
SubmitCTX 0x1B Submits a conditional transaction for threshold decryption and callback
EncryptECIES 0x1C Encrypts data for a specific recipient public key
EncryptTE 0x1D Encrypts data with the network threshold key

Compiler compatibility

For contracts that interact with BITE precompiles, we recommend using EVM version istanbul for now.

Hardhat:

export default {
	solidity: {
		version: "0.X.X",
		settings: {
			evmVersion: "istanbul"
		}
	}
};

Foundry (foundry.toml):

[profile.default]
evm_version = "istanbul"

Available examples

Example Description Key features
Encrypted Value Registry Stores a value encrypted and reveals it to authorized accounts. Authorized viewers are hidden (encrypted). CTX, ECIES, TE

Local testing with mocks

The contracts/test/ folder in this repository contains mocks for the BITE precompiles so you can test logic locally in your repository without a live BITE 2 node.

const BiteMock = await ethers.getContractFactory("BiteMock");
const bite = await BiteMock.deploy();

const SubmitCTXMock = await ethers.getContractFactory("SubmitCTXMock");
const submitCTXMock = await SubmitCTXMock.deploy(await bite.getAddress());

const EncryptTEMock = await ethers.getContractFactory("EncryptTEMock");
const encryptTEMock = await EncryptTEMock.deploy(await bite.getAddress());

const EncryptECIESMock = await ethers.getContractFactory("EncryptECIESMock");
const encryptECIESMock = await EncryptECIESMock.deploy(await bite.getAddress());


// NOTE: Leverage your local testing network cheat codes. This example uses hardhat node
const runtimeBytecode1 = await ethers.provider.getCode(await submitCTXMock.getAddress());
const runtimeBytecode2 = await ethers.provider.getCode(await encryptTEMock.getAddress());
const runtimeBytecode3 = await ethers.provider.getCode(await encryptECIESMock.getAddress());

await network.provider.send("hardhat_setCode", [
    "0x1B",
    runtimeBytecode1
]);

await network.provider.send("hardhat_setCode", [
    "0x1C",
    runtimeBytecode3
]);

await network.provider.send("hardhat_setCode", [
    "0x1D",
    runtimeBytecode2
]);

// Once setup ready, deploy and use contract that implements BITE.sol
const myContractFactory = await ethers.getContractFactory("MyBiteContract");
const myContract = await myContractFactory.deploy();
await myContract.waitForDeployment();

await myContract.someMethodThatUsesCTX();

// Needs to manually trigger callback stored in BiteMock.sol contract
await bite.sendCallback();

BiteMock is only for development and testing. It does not provide any real cryptographic security guarantees.