@ethereum-attestation-service/contracts

Ethereum Attestation Service

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

Goerli

v0.14

• EAS:
  • Contract: 0x6e195B51493e56d59768f8a87230ADe73BD4FC86
  • Deployment and ABI: EAS.json
• SchemaRegistry:
  • Contract: 0xB6652C033728658e1413F36cce9cA7f7eEbd5872
  • Deployment and ABI: SchemaRegistry.json
• EIP712Verifier:
  • Contract: 0xC8B0998Cf1e0541a108C0901099F4a9Deb8F84B1
  • Deployment and ABI: EIP712Verifier.json

Installation

yarn install @ethereum-attestation-service/contracts

Testing

Testing the protocol is possible via multiple approaches:

Unit Tests

You can run the full test suite via:

yarn test

Deployment Tests

You can test new deployments (and the health of the network) against a mainnet fork via:

yarn test:deploy

Please make sure to properly configure your Tenderly settings via .env.

This will automatically be skipped on an already deployed and configured deployment scripts and will only test the additional changeset resulting by running any new/pending deployment scripts and perform an e2e test against the up to date state. This is especially useful to verify that any future deployments and upgrades, suggested by the DAO, work correctly and preserve the integrity of the system.

Test Coverage

Latest Test Coverage Report (2022-10-18)

• 100% Statements 90/90
• 100% Branches 50/50
• 100% Functions 62/62
• 100% Lines 136/136

------------------------------|----------|----------|----------|----------|----------------|
File                          |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
------------------------------|----------|----------|----------|----------|----------------|
 contracts/                   |      100 |      100 |      100 |      100 |                |
  EAS.sol                     |      100 |      100 |      100 |      100 |                |
  EIP712Verifier.sol          |      100 |      100 |      100 |      100 |                |
  IEAS.sol                    |      100 |      100 |      100 |      100 |                |
  IEIP712Verifier.sol         |      100 |      100 |      100 |      100 |                |
  ISchemaRegistry.sol         |      100 |      100 |      100 |      100 |                |
  SchemaRegistry.sol          |      100 |      100 |      100 |      100 |                |
  Types.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:

yarn test:coverage

Profiling

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

yarn test:profile

Deploying

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

yarn deploy

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

yarn deploy:fork

The framework was inspired and adopted from Bancor V3.

License

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