# attest.so

<div align="center">

![attest.so Logo](https://github.com/user-attachments/assets/520b21ee-c8d7-4bda-9809-999c489551b9)

**A Unified Trust Framework for Blockchain-Based Attestation Infrastructure**

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Solana Radar Award](https://img.shields.io/badge/Solana%20Radar-Public%20Goods%20Award-yellow)](https://x.com/solana/status/1856362113561964676)
[![GitHub Issues](https://img.shields.io/github/issues/daccred/attest.so)](https://github.com/daccred/attest.so/issues)

---

<table>
<tr>
<td width="50%" valign="top">

### 🌐 Website & Docs
- **[🏠 Website](https://attestprotocol.org)**
  Official attestprotocol.org home
- **[📚 Developer Docs](https://docs.attestprotocol.org)**
  Complete integration guides & API reference

### 🛠️ Live Environments

<table>
<thead>
<tr>
<th>Network</th>
<th>Stellar</th>
<th>Solana</th>
<th>Starknet</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>Sandbox</b></td>
<td colspan="3" align="center"><a href="https://sandbox.attest.so">🧪 Try it now</a></td>
</tr>
<tr>
<td><b>Testnet</b></td>
<td align="center"><a href="https://testnet.attestprotocol.org">🔗 Launch</a></td>
<td align="center">🚧 Soon</td>
<td align="center">🚧 Soon</td>
</tr>
<tr>
<td><b>Mainnet</b></td>
<td align="center"><a href="https://stellar.attestprotocol.org">🚀 Launch</a></td>
<td align="center">🚧 Soon</td>
<td align="center">🚧 Soon</td>
</tr>
</tbody>
</table>

</td>
<td width="50%" valign="top">

### 📜 Smart Contracts

**Stellar (Mainnet)** · [View on Stellar.Expert](https://stellar.expert/explorer/public)
- [Protocol Contract](https://stellar.expert/explorer/public/contract/CBUUI7WKGOTPCLXBPCHTKB5GNATWM4WAH4KMADY6GFCXOCNVF5OCW2WI) · `CBUUI...`
- [Authority Contract](https://stellar.expert/explorer/public/contract/CBKOB6XEEXYH5SEFQ4YSUEFJGYNBVISQBHQHVGCKB736A3JVGK7F77JG) · `CBKOB...`

**Stellar (Testnet)** · [View on Stellar.Expert](https://stellar.expert/explorer/testnet)
- [Protocol Contract](https://stellar.expert/explorer/testnet/contract/CBFE5YSUHCRYEYEOLNN2RJAWMQ2PW525KTJ6TPWPNS5XLIREZQ3NA4KP) · `CBFE5...`
- [Authority Contract](https://stellar.expert/explorer/testnet/contract/CCMJGCRSQRZ56BDSLCAYV4BNS3SLIDPIP4CQYNT5X2VOPZIQ2ZM7GBVV) · `CCMJG...`

### 📦 NPM Packages

```bash
npm install @attestprotocol/stellar-sdk
npm install @attestprotocol/solana-sdk
npm install @attestprotocol/starknet-sdk
npm install @attestprotocol/cli
```

**Browse on npm:**
[stellar-sdk](https://www.npmjs.com/package/@attestprotocol/stellar-sdk) ·
[solana-sdk](https://www.npmjs.com/package/@attestprotocol/solana-sdk) ·
[starknet-sdk](https://www.npmjs.com/package/@attestprotocol/starknet-sdk) ·
[cli](https://www.npmjs.com/package/@attestprotocol/cli)

</td>
</tr>
</table>

---

</div>

## 🌐 Overview

**attest.so** provides enterprise-grade infrastructure for builders to create "Reputation Authorities" on-chain with verifiable and comprehensive identity proofs. The project supports multiple blockchain platforms, enabling a unified approach to attestations and identity verification.

Our framework addresses critical challenges in Web3:

- **Identity Verification**: Robust mechanisms for verifying identities across blockchain ecosystems
- **Interoperable Trust**: Consistent attestation standards across multiple blockchains
- **Reputation Management**: Infrastructure for building and maintaining on-chain reputation
- **Scalable Solutions**: Enterprise-ready attestation infrastructure for builders

## 🏗️ Architecture

### Core Concepts

- **Attestations**: Verifiable, cryptographically signed claims made by an `Authority` about a `Subject`. They are structured according to a `Schema` and recorded on-chain.
- **Schemas**: Structured templates that define the format and data types for an attestation. They act as a blueprint, ensuring that attestations are consistent and machine-readable.
- **Authorities**: Trusted entities with the permission to issue, manage, and revoke attestations. Authorities are registered on-chain, and their integrity is verifiable.
- **Subjects**: The entities (e.g., users, smart contracts, organizations) about which attestations are made.
- **Resolvers**: On-chain programs responsible for interpreting and verifying attestations. They provide a standardized interface to locate, decode, and validate attestation data, and can be designed to handle complex logic such as dynamic schema resolution, revocation checks, and integration with off-chain data sources.

### Multi-Chain Support

attest.so is designed with cross-chain compatibility as a primary goal:

| Blockchain | Contract Language | Status      | Key Features                                            |
| ---------- | ----------------- | ----------- | ------------------------------------------------------- |
| Stellar    | Soroban (Rust)    | Active      | Fee management, levy collection, verifiable authorities |
| Solana     | Anchor (Rust)     | Development | High throughput, scalable attestation storage           |
| Starknet   | Cairo             | Development | ZK-friendly proofs, privacy-preserving attestations     |
| Sui        | Move              | Planned     | Object-oriented attestation model                       |
| Aptos      | Move              | Planned     | Resource-oriented attestation model                     |

## 🧩 Key Components

### 1. Smart Contracts

The repository contains modular smart contract implementations for multiple blockchain platforms:

#### Stellar/Soroban Implementation

Our Stellar implementation, built with Soroban, provides a robust framework for on-chain attestations. It leverages Rust for performance and safety, and is designed to integrate seamlessly with the Stellar ecosystem, including Horizon and the Stellar SDK.

```
contracts/stellar/
├── authority/        # Manages and resolves authorities
├── protocol/         # Core attestation protocol logic
├── resolvers/        # Schema and attestation resolvers
└── ...               # Other configuration and build files
```

**Key Features:**

- **Authority Management**: Contracts for registering, verifying, and managing attestation authorities.
- **Core Protocol**: The central logic for creating, revoking, and managing attestations.
- **Resolvers**: Efficient on-chain logic to resolve schemas and attestations.
- **Soroban Integration**: Fully leverages Soroban's features for storage, authorization, and events.
- **Fee and Levy System**: Optional fee collection mechanism for monetizing attestation services.

#### Additional Blockchain Implementations

Implementation details for Solana (Anchor), Starknet (Cairo), and Aptos (Move) with blockchain-specific optimizations.

### 2. SDK (Software Development Kit)

A TypeScript SDK that provides a unified interface for interacting with our attestation infrastructure across different blockchains.

```typescript
// Example: Interacting with Stellar contracts via the SDK
import { AttestClient } from '@attestprotocol/sdk';
import { Keypair } from '@stellar/stellar-sdk';

// Initialize client for Stellar
const keypair = Keypair.fromSecret('YOUR_STELLAR_SECRET_KEY');
const client = new AttestClient({
  chain: 'stellar',
  network: 'testnet',
  secretKey: keypair.secret(),
});

// Create an attestation on Stellar
const attestation = await client.attest({
  schema: 'did:attest:identity',
  subject: 'G...', // Subject's Stellar public key
  claims: { verified: true, level: 'premium' },
});
```

**Core Functionality:**

- Blockchain connection management
- Schema creation and registration
- Attestation lifecycle management
- Cross-chain verification utilities
- TypeScript-first for a better developer experience

### 3. CLI (Command Line Interface)

A powerful command-line tool for developers and administrators to interact with the protocol directly from the terminal.

```bash
# Install CLI
npm install -g @attestprotocol/cli

# Create a new attestation on the Stellar testnet
attest create \
  --schema did:attest:identity \
  --subject G... \
  --chain stellar \
  --network testnet \
  --claims '{"verified": true}'
```

### 4. Documentation and Examples

Comprehensive documentation and example implementations to facilitate integration:

- Interactive API reference
- Integration guides
- Example applications
- Best practices

## 📦 Project Structure

The repository follows a monorepo structure using pnpm workspaces:

```
attest.so/
├── apps/
│   ├── docs/
│   └── explorer/
├── contracts/
│   ├── stellar/
│   ├── solana/
│   ├── starknet/
│   ├── sui/
│   └── aptos/
├── packages/
│   ├── sdk/
│   ├── stellar-sdk/
│   ├── solana-sdk/
│   ├── starknet-sdk/
│   ├── cli/
│   └── core/
└── examples/
    ├── identity-verification/
    └── reputation-system/
```

See [NAMING.md](./NAMING.md) for detailed information about naming conventions and directory structure standards.

## 🛠️ Technical Stack

- **Frontend**: Next.js, React, Tailwind CSS
- **SDK/CLI**: TypeScript, Node.js, Stellar SDK, Horizon Client
- **Smart Contracts**:
  - **Stellar**: Rust with Soroban
  - **Solana**: Rust with Anchor
  - **Starknet**: Cairo
  - **Sui**: Move
  - **Aptos**: Move
- **Developer Experience**:
  - pnpm workspaces for monorepo management
  - TypeScript
  - ESLint/Prettier
  - Jest for testing

## 🚀 Getting Started

### Installation

```bash
# Clone the repository
git clone https://github.com/daccred/attest.so.git
cd attest.so

# Install dependencies
pnpm install

# Build all packages
pnpm build
```

### Running the Development Environment

```bash
# Start the documentation site
pnpm run dev:docs

# Run the SDK tests
pnpm run test:sdk

# Deploy contracts to local development network
pnpm run deploy:local
```

### Working with Contracts

```bash
# Build Soroban contracts
cd contracts/stellar
soroban contract build

# Deploy to Stellar testnet
soroban contract deploy \
  --wasm target/wasm32-unknown-unknown/release/authority.wasm \
  --network testnet \
  --source <YOUR_ACCOUNT>
```

## 🤝 Contributing

Contributions are welcome! Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

---

## Setting up Rust Analyzer

With Rust Analyzer installed, you can configure it to recognize all our Rust-based contract projects. This is essential for a smooth development experience, providing features like auto-completion and type-checking.

Add the following to your `.vscode/settings.json` file:

```json
{
  "rust-analyzer.linkedProjects": [
    "contracts/stellar/Cargo.toml",
    "contracts/solana/Cargo.toml"
  ]
}
```

This configuration ensures that Rust Analyzer can correctly interpret the dependencies and structure of each contract crate within our monorepo.

---

## 🔗 Resources & Links

- [Product Development Log](https://daccred.notion.site/We-re-building-https-on-the-blockchain-df20b05cb5a04e379a165714aab024fb?pvs=4)
- [Technical Documentation](https://attest.so) (Coming Soon)
- [API Reference](https://attest.so) (Coming Soon)

---

## 🏆 Awards & Recognition

<div align="center">

<table>
<tr>
<td align="center" width="50%">
<img src="https://cryptologos.cc/logos/solana-sol-logo.png" width="80" alt="Solana Logo"/>
<h3>🎖️ Solana Radar Hackathon</h3>
<p><b>Public Goods Award Winner</b></p>
<p>Recognized for building critical public infrastructure for the Solana ecosystem</p>
<a href="https://x.com/solana/status/1856362113561964676">
  <img src="https://img.shields.io/badge/View%20Announcement-black?style=for-the-badge&logo=x" alt="View on X"/>
</a>
</td>
<td align="center" width="50%">
<img src="https://cryptologos.cc/logos/stellar-xlm-logo.png" width="80" alt="Stellar Logo"/>
<h3>⭐ Stellar Community Fund</h3>
<p><b>SCF Award Recipient</b></p>
<p>Selected for advancing attestation infrastructure on the Stellar network</p>
<a href="https://communityfund.stellar.org/submissions/recIHN98Ja7MMb4DX">
  <img src="https://img.shields.io/badge/View%20Submission-090020?style=for-the-badge&logo=stellar" alt="View on SCF"/>
</a>
</td>
</tr>
</table>

</div>

---

## 📝 License

This project is licensed under the [MIT License](./LICENSE).