Skip to content

Latest commit

 

History

History
executable file
·
467 lines (356 loc) · 22.7 KB

README.md

File metadata and controls

executable file
·
467 lines (356 loc) · 22.7 KB
Raw

Ethereum Attestation Service

Docs NPM Package Test License

Introduction

The Ethereum Attestation Service is a free and open protocol for on-chain attestations on EVM compatible blockchains. It is a generalized service that allows anyone to register a schema for their particular use case, and then make attestations following their schema.

Schemas can be registered using the SchemaRegistry.sol contract, and attestations are made using the EAS.sol contract.

In addition, we provide a resolver contract for advanced use cases, such as on-chain verification of attestation data, and also attaching payments to attestations (which makes a new suite of powerful web3 applications possible).

We also provide an SDK for developers.

On-chain attestations will enable a powerful new range of web3 applications, including:

  • Identity
  • Trust Scores
  • Goodness Scores
  • Credit Scores
  • Clout
  • Land Registries
  • Social Networks
  • Portable Trust Layers
  • Retroactive Public Goods Funding
  • KYC Services
  • Uncollateralized Lending / Borrowing
  • Voting
  • Oracles (who can be atomically paid for making attestations inside the protocol)
  • Likes/Dislikes
  • Content Filtering
  • And many more!

Deployments

Please note that you can also import and use the addresses directly in your code using the @ethereum-attestation-service/eas-contracts/deployments deployment artifacts corresponding to your desired network.

Mainnets

Ethereum

Version 0.26:

Optimism

Version 1.0.1:

Version 1.2.0:

Base

Version 1.0.1:

Version 1.2.0:

Arbitrum One

Version 0.26:

Arbitrum Nova

Version 1.3.0:

Polygon

Version 1.3.0:

Scroll

Version 1.3.0:

zkSync

Version 1.3.0:

Celo

Version 1.3.0:

Blast

Version 1.3.0:

Linea

Version 1.2.0:

Testnets

Sepolia

Version 0.26:

Version 1.2.0:

Optimism Sepolia

Version 1.0.2:

Version 1.3.0:

Optimism Goerli

Version 1.0.1:

Version 1.2.0:

Base Sepolia

Version 1.2.0:

Version 1.3.0:

Base Goerli

Version 1.0.1:

Version 1.2.0:

Arbitrum Goerli

Version 1.1.0:

Polygon Amoy

Version 1.3.0:

Scroll Sepolia

Version 1.3.0:

Linea Goerli

Version 1.2.0:

Installation

pnpm add @ethereum-attestation-service/eas-contracts

Testing

Testing the protocol is possible via multiple approaches:

Unit Tests

You can run the full test suite via:

pnpm test

Test Coverage

Latest Test Coverage Report (2023-10-31)

  • 100% Statements 350/350
  • 100% Branches 172/172
  • 100% Functions 120/120
  • 100% Lines 491/491
----------------------------------|----------|----------|----------|----------|----------------|
File                              |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
----------------------------------|----------|----------|----------|----------|----------------|
 contracts/                       |      100 |      100 |      100 |      100 |                |
  Common.sol                      |      100 |      100 |      100 |      100 |                |
  EAS.sol                         |      100 |      100 |      100 |      100 |                |
  IEAS.sol                        |      100 |      100 |      100 |      100 |                |
  ISchemaRegistry.sol             |      100 |      100 |      100 |      100 |                |
  Indexer.sol                     |      100 |      100 |      100 |      100 |                |
  SchemaRegistry.sol              |      100 |      100 |      100 |      100 |                |
  Semver.sol                      |      100 |      100 |      100 |      100 |                |
 contracts/eip1271/               |      100 |      100 |      100 |      100 |                |
  EIP1271Verifier.sol             |      100 |      100 |      100 |      100 |                |
 contracts/eip712/proxy/          |      100 |      100 |      100 |      100 |                |
  EIP712Proxy.sol                 |      100 |      100 |      100 |      100 |                |
 contracts/eip712/proxy/examples/ |      100 |      100 |      100 |      100 |                |
  PermissionedEIP712Proxy.sol     |      100 |      100 |      100 |      100 |                |
 contracts/resolver/              |      100 |      100 |      100 |      100 |                |
  ISchemaResolver.sol             |      100 |      100 |      100 |      100 |                |
  SchemaResolver.sol              |      100 |      100 |      100 |      100 |                |
 contracts/resolver/examples/     |      100 |      100 |      100 |      100 |                |
  AttestationResolver.sol         |      100 |      100 |      100 |      100 |                |
  AttesterResolver.sol            |      100 |      100 |      100 |      100 |                |
  DataResolver.sol                |      100 |      100 |      100 |      100 |                |
  ExpirationTimeResolver.sol      |      100 |      100 |      100 |      100 |                |
  PayingResolver.sol              |      100 |      100 |      100 |      100 |                |
  RecipientResolver.sol           |      100 |      100 |      100 |      100 |                |
  RevocationResolver.sol          |      100 |      100 |      100 |      100 |                |
  TokenResolver.sol               |      100 |      100 |      100 |      100 |                |
  ValueResolver.sol               |      100 |      100 |      100 |      100 |                |
----------------------------------|----------|----------|----------|----------|----------------|
All files                         |      100 |      100 |      100 |      100 |                |
----------------------------------|----------|----------|----------|----------|----------------|

Instructions

In order to audit the test coverage of the full test suite, run:

pnpm test:coverage

Profiling

You can profile the gas costs of all of the user-focused flows via:

pnpm test:profile

Deploying

The contracts have built-in support for deployments on different chains and mainnet forks. You can deploy the project by:

pnpm deploy

There’s also a special deployment mode which deploys the protocol to a mainnet fork, with additional goodies. It can be run via:

pnpm deploy:fork

The framework was inspired and adopted from Bancor V3.

License

EAS is open source and distributed under the MIT License (see LICENSE).