Hikyaku Protocol makes it a breeze to send web3 assets to anyone with just an email address, even if you don't know their web3 address, all while maintaining privacy through end-to-end encryption.
https://hikyaku-protocol.vercel.app/
Made by ken, Yoshi, Tei in EthGlobal ETHTokyo 2023 Hackathon.
Table of Contents:
Currently, there are many services that require users to register their web3 address. However, it is difficult for users to register their web3 address because they need to know how to use MetaMask or other wallet applications. In addition, it is difficult for users to remember their web3 address.
When a user try to resolve an email address, the user's email address is encrypted by LitProtocol and stored in the contract. At this time, the user can select the notifier provider from the list of providers registered in the contract.(Currently, only our first-party provider is available.)
The notifier provider sends an email to the user's email address. The email contains a url to the web3 address resolution page.
The url SHOULD be in the following format.
https://hikyaku-protocol.vercel.app/resolve?k={signed_jwt_token}
The JWT token is signed by the notifier provider's private key and the format is following:
{
"iss": "https://hikyaku-protocol-notifier.vercel.app",
"sub": "[email protected]",
"req": "0xdD2FD4581271e230360230F9337D5c0430Bf44C0",
"type": "email",
"nonce": 9999,
"exp": 1620000000
}The issuer SHOULD publish the public key of the private key used to sign the JWT token. The path of the public key SHOULD be in the following format /.well-known/hikyaku-configuration.
When the user opens the url in the email, the user can register his/her web3 address. The user's web3 address is encrypted by LitProtocol and stored in the contract.
Once the user's web3 address is registered, the email address can be resolved to the web3 address by calling the getResolvedAddress function of the contract.
- Package-Manager:
pnpm - Monorepo Tooling:
turborepo - Smart Contract Development:
hardhat- Deploy & Address-Export:
hardhat-deploy - Typescript-Types:
typechain
- Deploy & Address-Export:
- Frontend:
next- Contract Interactions:
wagmi,rainbowkit - Styling:
chakra,tailwindcss,twin.macro,emotion
- Contract Interactions:
- Misc:
- Linting & Formatting:
eslint,prettier,husky,lint-staged
- Linting & Formatting:
- Blockchain (Can be deployed any EVM-compatible chains.)
- Polygon(Mumbai)
- Scroll
# Install pnpm
npm i -g pnpm
# Install dependencies
pnpm install
# Copy & fill environments
# NOTE: Documentation of environment variables can be found in the according `.example` files
cp packages/frontend/.env.local.example packages/frontend/.env.local
cp packages/contracts/.env.example packages/contracts/.env# Generate contract-types, start local hardhat node, and start frontend with turborepo
pnpm dev
# Only start frontend (from root-dir)
# NOTE: Alternatively it can just be started via `pnpm dev` inside `packages/frontend`
pnpm frontend:devSetting up a deployment via Vercel is pretty straightforward as build settings are preconfigured in vercel.json. To get started, press the Deploy button and enter the default environment variables listed below.
| Environment Variable | Value |
|---|---|
NEXT_PUBLIC_PRODUCTION_MODE |
true |
NEXT_PUBLIC_URL |
https://your-repo.vercel.app |
NEXT_PUBLIC_DEFAULT_CHAIN |
5 |
NEXT_PUBLIC_SUPPORTED_CHAINS |
[5] |
NEXT_PUBLIC_RPC_1 |
https://rpc.ankr.com/eth |
NEXT_PUBLIC_RPC_5 |
https://rpc.ankr.com/eth_goerli |
You can find mode documentation on those environment variables in packages/frontend/.env.local.example. Always make sure to include respective RPCs for supported chains and define them within packages/frontend/src/shared/environment.ts. Valid hardhat deployments under packages/contracts/deployments are mandatory for each supported chain.