Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pavlovdog/farcaster-solidity
A collection of Solidity libraries for interacting with the Farcaster messages on-chain
https://github.com/pavlovdog/farcaster-solidity
Last synced: 2 months ago
JSON representation
A collection of Solidity libraries for interacting with the Farcaster messages on-chain
- Host: GitHub
- URL: https://github.com/pavlovdog/farcaster-solidity
- Owner: pavlovdog
- Created: 2023-12-21T10:03:50.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-04T17:04:41.000Z (3 months ago)
- Last Synced: 2024-04-14T02:19:38.680Z (3 months ago)
- Language: Solidity
- Homepage:
- Size: 462 KB
- Stars: 72
- Watchers: 5
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Lists
- awesome-farcaster - Farcaster Solidity
README
# Farcaster Solidity
A set of Solidity libraries for verifying and parsing Farcaster messages on-chain. Made by [fastfourier.eth](https://warpcast.com/fastfourier.eth).
## Introduction
The difference between a Farcaster and many other social networks is the cryptographic protocol that allows any user to verify any action, that happened on the network. Using cryptographic signatures and an onchain key registry, it is possible to verify the correctness of the cast, like, the following relation, etc.
The goal of this project is to provide a set of Solidity libraries and examples, helping to verify and parse Farcaster messages on-chain.
## Overview
Farcaster messages (cast, like, following, etc) are represented as Protobuf messages, signed with the user's private key. Here's an illustration of what happens when a new cast is sent to the Farcaster network:
1. Alice publishes a cast. Application (eg Warpcast) forms a message from text, mentions, links, etc
2. The message is encoded using the Protobuf scheme into a series of bytes. Then it gets hashed using the Blake3 hash function, and the first 20 bytes of the hash are signed with the user's Ed25519 private key. The corresponding public key is stored in a smart contract called `KeyRegistry` on Optimism Mainnet.
3. The message and the signature, are being sent to the network
4. Each network participant verifies, that the signature is correct and accepts the message as valid.
All these actions can be done inside the smart contract, verifying that Alice indeed sent the message!
## Usage example
The full example can be found at [contracts/Test.sol](./contracts/Test.sol).
```solidity
function verifyCastAddMessage(
bytes32 public_key,
bytes32 signature_r,
bytes32 signature_s,
bytes memory message
) external {
MessageData memory message_data = _verifyMessage(
public_key,
signature_r,
signature_s,
message
);
if (message_data.type_ != MessageType.MESSAGE_TYPE_CAST_ADD) {
revert InvalidMessageType();
}
emit MessageCastAddVerified(
message_data.fid,
message_data.cast_add_body.text,
message_data.cast_add_body.mentions
);
}
```
## Gas usage
Gas usage mainly consists of three components:
- Blake3 hashing (500k - 1m gas)
- Ed25519 signature verification (≈ 1m gas)
- Message decoding (≈ 100k gas)
```
·-----------------------------------------|----------------------------|-------------|-----------------------------·
| Solc version: 0.8.19 · Optimizer enabled: false · Runs: 200 · Block limit: 30000000 gas │
··········································|····························|·············|······························
| Methods │
·············|····························|··············|·············|·············|···············|··············
| Contract · Method · Min · Max · Avg · # calls · usd (avg) │
·············|····························|··············|·············|·············|···············|··············
| Test · verifyCastAddMessage · - · - · 1922353 · 2 · - │
·············|····························|··············|·············|·············|···············|··············
| Test · verifyReactionAddMessage · - · - · 1518784 · 2 · - │
·············|····························|··············|·············|·············|···············|··············
```
## FAQ
### Is it possible to reduce gas usage per message?
Yes, absolutely! The main idea is to move expensive computations (Blake3 hashing and Ed25519 signature verification) off-chain, using ZK proofs.
In this case, the Solidity contract verifies only a short proof (≈300k gas vs 2m).
This approach can be scaled with batching, so in the case of 10 messages, it takes 300k / 10 = 30k gas to verify a single message.
### Which message types are supported?
Most of them. Due to the contract size limitations, decodings for `CastRemoveBody`, `VerificationRemoveBody`, and `UserNameProof` are not included. You can include them yourself, by modifying the [message.proto](./protobufs/message.proto), check out the [Running Locally](#running-locally) section.
### My contract does not fit into the 24 kb limit
Try to use external libraries, as they are quite heavy to be used internally. Check the [test.ts](./test/test.ts) for deployment reference.
### How can I verify the correctness of the public key?
Farcaster uses onchain `KeyRegistry` contract ([spec](https://github.com/farcasterxyz/protocol/blob/main/docs/SPECIFICATION.md#12-key-registry)), which stores the relation between the user's FID (Farcaster ID) and a public key. Here's a verification example:
```solidity
address KEY_REGISTRY = 0x....;
IKeyRegistry.KeyData memory keyData = IKeyRegistry(KEY_REGISTRY).keyDataOf(
messageData.fid,
bytes.concat(publicKey)
);
if (keyData.state != IKeyRegistry.KeyState.ADDED) revert InvalidKey();
```
Keep in mind, that KeyRegistry contact has been migrated multiple times, so make sure you use the actual address from the [Farcaster Specification](https://github.com/farcasterxyz/protocol/blob/main/docs/SPECIFICATION.md#12-key-registry).
### Can I use this project in networks other than Optimism Mainnet?
Technically it's possible, but it's quite tricky. The best way to achieve this will be by using storage proofs for KeyRegistry storage verification.
## Running locally
```bash
node --version
v18.17.1
npm --version
9.6.7
yarn
yarn hh:compile
yarn hh:test
# Get contract's size in kb
yarn hh:size
```
### Modifying proto schemes
To modify .proto schemes, install [protobuf3-solidity](https://github.com/celestiaorg/protobuf3-solidity).
```
git clone https://github.com/celestiaorg/protobuf3-solidity
cd protobuf3-solidity
make
```
Export the path to the binary and run `yarn protoc` to update Solidity libraries and TS definitions
```bash
export PROTO_GEN_SOL=./../protobuf3-solidity/bin/protoc-gen-sol
cd farcaster-solidity
yarn protoc
```
Keep in mind, that not all Protobuf features are supported (`oneOf` fields, repeated strings, non-packed repeated fields). Another important thing is that message fields should be enumerated in a strict incremental order.
## Links & credits
- [Blake3 Solidity implementation](https://github.com/mel-project/blake3-sol)
- [Ed25519 Solidity implementation](https://github.com/chengwenxi/Ed25519)
- [protobuf3-solidity](https://github.com/celestiaorg/protobuf3-solidity)
- [@farcaster/core](https://github.com/farcasterxyz/hub-monorepo/tree/main/packages/core) (contains .proto files)
- [Farcaster specification](https://github.com/farcasterxyz/protocol/blob/main/docs/SPECIFICATION.md)