@joclaim/attestor-core 0.2.0 → 0.2.3

package/README.md

@@ -1,14 +1,18 @@
-# Joclaim Attestor Core
+# Reclaim Attestor Core
 
 <div>
     <div>
-        <img src="https://raw.githubusercontent.com/xj894976677/.github/main/assets/banners/Attestor-Core.png"  />
+        <img src="https://raw.githubusercontent.com/reclaimprotocol/.github/main/assets/banners/Attestor-Core.png"  />
     </div>
 </div>
 
-## What is Joclaim?
 
-Joclaim enables you to bring user activity, reputation, and identity from external websites into your own platform.
+![Test status](https://github.com/ReclaimProtocol/attestor-core/actions/workflows/ci-cd.yml/badge.svg?job=test)
+![Deploy status](https://github.com/ReclaimProtocol/attestor-core/actions/workflows/ci-cd.yml/badge.svg?job=deploy)
+
+## What is the Reclaim Protocol?
+
+Reclaim enables you to bring user activity, reputation, and identity from external websites into your own platform.
 
 For example,
 - Import the number of rides the user has taken on Uber to build a competing ride sharing platform
@@ -20,26 +24,28 @@ And many more...
 
 ### Now what is this repository?
 
-The `attestor-core` package is the core implementation of the Joclaim protocol.
+The `attestor-core` package is the core implementation of the Reclaim protocol.
 
-TLDR: An "attestor" is a server that sits between the Joclaim user & the internet. The client sends data to the internet via the attestor. All this data is exchanged securely via the TLS protocol.
+TLDR: An "attestor" is a server that sits between the reclaim user & the internet. The client sends data to the internet via the attestor. All this data is exchanged securely via the TLS protocol.
 
 We leverage some special properties of the TLS protocol along with zero-knowledge proofs to reveal only the necessary information to the attestor.
 The attestor then signs this data & sends it back to the client. The client can then use this signed data to prove the claim to anyone.
 
-This package contains both the client & server side code for the Joclaim protocol.
+This package contains both the client & server side code for the Reclaim protocol.
 
 Read a longer brief [here](/docs/problem-statement.md).
 
 This repository contains **Typescript** implementation of the attestor server & the SDK to interact with it. The SDK is compatible with the browser & NodeJS. However, to run the SDK on React Native/Mobile, refer to our [React Native guide](/docs/browser-rpc.md).
 
+Note: if you're looking to build apps on Reclaim, we'd recommend you to use the [Reclaim SDK](https://docs.reclaimprotocol.org/) instead. This repository is intended for developers looking to contribute to the core protocol.
+
 ## Install
 
 From GitHub:
-`npm install git+https://github.com/xj894976677/attestor-core`
+`npm install git+https://github.com/reclaimprotocol/attestor-core`
 
 From NPM:
-`npm install @joclaim/attestor-core`
+`npm install @reclaimprotocol/attestor-core`
 
 **Note:** if you plan on running the package on NodeJS or any non-browser environment, download the ZK files required to generate & verify ZK proofs:
 ```bash
@@ -56,7 +62,7 @@ We'd recommend you go through our documentation in the following order:
 1. [Problem Statement](/docs/problem-statement.md): Understand the problem we're solving & whether this is the right solution for you.
 2. [Getting Started](/docs/getting-started.md): Understand how to get started with the attestor SDK & create your first claim.
 3. [Browser RPC/React Native](/docs/browser-rpc.md): How to setup the attestor client SDK for environments like React Native or any other mobile app.
-4. [Provider](/docs/provider.md): What is a provider in the Joclaim context, how to create one & details on the HTTP provider.
+4. [Provider](/docs/provider.md): What is a provider in the Reclaim context, how to create one & details on the HTTP provider.
 5. [Internals of Claim Creation](/docs/claim-creation.md): In-depth description of the full flow of creating a claim with a attestor.
 6. [Working with the Codebase](/docs/project.md): Understand how to work with the codebase & how to deploy an attestor server.
 7. [Run your own Attestor Server](/docs/run-server.md): Understand how to run your own attestor server locally or deploy it to the cloud.
@@ -68,22 +74,22 @@ We're excited that you're interested in contributing to our project! Before you
 
 ## Code of Conduct
 
-Please read and follow our [Code of Conduct](https://github.com/xj894976677/.github/blob/main/Code-of-Conduct.md) to ensure a positive and inclusive environment for all contributors.
+Please read and follow our [Code of Conduct](https://github.com/reclaimprotocol/.github/blob/main/Code-of-Conduct.md) to ensure a positive and inclusive environment for all contributors.
 
 ## Security
 
-If you discover any security-related issues, please refer to our [Security Policy](https://github.com/xj894976677/.github/blob/main/SECURITY.md) for information on how to responsibly disclose vulnerabilities.
+If you discover any security-related issues, please refer to our [Security Policy](https://github.com/reclaimprotocol/.github/blob/main/SECURITY.md) for information on how to responsibly disclose vulnerabilities.
 
 ## Contributor License Agreement
 
-Before contributing to this project, please read and sign our [Contributor License Agreement (CLA)](https://github.com/xj894976677/.github/blob/main/CLA.md).
+Before contributing to this project, please read and sign our [Contributor License Agreement (CLA)](https://github.com/reclaimprotocol/.github/blob/main/CLA.md).
 
 ## Indie Hackers
 
-For Indie Hackers: [Check out our guidelines and potential grant opportunities](https://github.com/xj894976677/.github/blob/main/Indie-Hackers.md)
+For Indie Hackers: [Check out our guidelines and potential grant opportunities](https://github.com/reclaimprotocol/.github/blob/main/Indie-Hackers.md)
 
 ## License
 
 This project is licensed under a [AGPL v3](./LICENSE). By contributing to this project, you agree that your contributions will be licensed under its terms.
 
-Thank you for your contributions!
+Thank you for your contributions!

package/lib/avs/abis/avsDirectoryABI.d.ts

@@ -0,0 +1,60 @@
+export declare const avsDirectoryABI: ({
+    type: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    stateMutability: string;
+    name?: undefined;
+    outputs?: undefined;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    outputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: ({
+        name: string;
+        type: string;
+        internalType: string;
+        components?: undefined;
+    } | {
+        name: string;
+        type: string;
+        internalType: string;
+        components: {
+            name: string;
+            type: string;
+            internalType: string;
+        }[];
+    })[];
+    outputs: never[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        indexed: boolean;
+        internalType: string;
+    }[];
+    anonymous: boolean;
+    stateMutability?: undefined;
+    outputs?: undefined;
+})[];

package/lib/avs/abis/avsDirectoryABI.js

@@ -0,0 +1,340 @@
+export const avsDirectoryABI = [
+    {
+        type: "constructor",
+        inputs: [
+            {
+                name: "_delegation",
+                type: "address",
+                internalType: "contract IDelegationManager",
+            },
+        ],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "DOMAIN_TYPEHASH",
+        inputs: [],
+        outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "OPERATOR_AVS_REGISTRATION_TYPEHASH",
+        inputs: [],
+        outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "avsOperatorStatus",
+        inputs: [
+            { name: "", type: "address", internalType: "address" },
+            { name: "", type: "address", internalType: "address" },
+        ],
+        outputs: [
+            {
+                name: "",
+                type: "uint8",
+                internalType: "enum IAVSDirectory.OperatorAVSRegistrationStatus",
+            },
+        ],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "calculateOperatorAVSRegistrationDigestHash",
+        inputs: [
+            { name: "operator", type: "address", internalType: "address" },
+            { name: "avs", type: "address", internalType: "address" },
+            { name: "salt", type: "bytes32", internalType: "bytes32" },
+            { name: "expiry", type: "uint256", internalType: "uint256" },
+        ],
+        outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "cancelSalt",
+        inputs: [{ name: "salt", type: "bytes32", internalType: "bytes32" }],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "delegation",
+        inputs: [],
+        outputs: [
+            {
+                name: "",
+                type: "address",
+                internalType: "contract IDelegationManager",
+            },
+        ],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "deregisterOperatorFromAVS",
+        inputs: [{ name: "operator", type: "address", internalType: "address" }],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "domainSeparator",
+        inputs: [],
+        outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "initialize",
+        inputs: [
+            { name: "initialOwner", type: "address", internalType: "address" },
+            {
+                name: "_pauserRegistry",
+                type: "address",
+                internalType: "contract IPauserRegistry",
+            },
+            { name: "initialPausedStatus", type: "uint256", internalType: "uint256" },
+        ],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "operatorSaltIsSpent",
+        inputs: [
+            { name: "", type: "address", internalType: "address" },
+            { name: "", type: "bytes32", internalType: "bytes32" },
+        ],
+        outputs: [{ name: "", type: "bool", internalType: "bool" }],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "owner",
+        inputs: [],
+        outputs: [{ name: "", type: "address", internalType: "address" }],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "pause",
+        inputs: [
+            { name: "newPausedStatus", type: "uint256", internalType: "uint256" },
+        ],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "pauseAll",
+        inputs: [],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "paused",
+        inputs: [{ name: "index", type: "uint8", internalType: "uint8" }],
+        outputs: [{ name: "", type: "bool", internalType: "bool" }],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "paused",
+        inputs: [],
+        outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "pauserRegistry",
+        inputs: [],
+        outputs: [
+            { name: "", type: "address", internalType: "contract IPauserRegistry" },
+        ],
+        stateMutability: "view",
+    },
+    {
+        type: "function",
+        name: "registerOperatorToAVS",
+        inputs: [
+            { name: "operator", type: "address", internalType: "address" },
+            {
+                name: "operatorSignature",
+                type: "tuple",
+                internalType: "struct ISignatureUtils.SignatureWithSaltAndExpiry",
+                components: [
+                    { name: "signature", type: "bytes", internalType: "bytes" },
+                    { name: "salt", type: "bytes32", internalType: "bytes32" },
+                    { name: "expiry", type: "uint256", internalType: "uint256" },
+                ],
+            },
+        ],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "renounceOwnership",
+        inputs: [],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "setPauserRegistry",
+        inputs: [
+            {
+                name: "newPauserRegistry",
+                type: "address",
+                internalType: "contract IPauserRegistry",
+            },
+        ],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "transferOwnership",
+        inputs: [{ name: "newOwner", type: "address", internalType: "address" }],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "unpause",
+        inputs: [
+            { name: "newPausedStatus", type: "uint256", internalType: "uint256" },
+        ],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "updateAVSMetadataURI",
+        inputs: [{ name: "metadataURI", type: "string", internalType: "string" }],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "event",
+        name: "AVSMetadataURIUpdated",
+        inputs: [
+            { name: "avs", type: "address", indexed: true, internalType: "address" },
+            {
+                name: "metadataURI",
+                type: "string",
+                indexed: false,
+                internalType: "string",
+            },
+        ],
+        anonymous: false,
+    },
+    {
+        type: "event",
+        name: "Initialized",
+        inputs: [
+            { name: "version", type: "uint8", indexed: false, internalType: "uint8" },
+        ],
+        anonymous: false,
+    },
+    {
+        type: "event",
+        name: "OperatorAVSRegistrationStatusUpdated",
+        inputs: [
+            {
+                name: "operator",
+                type: "address",
+                indexed: true,
+                internalType: "address",
+            },
+            { name: "avs", type: "address", indexed: true, internalType: "address" },
+            {
+                name: "status",
+                type: "uint8",
+                indexed: false,
+                internalType: "enum IAVSDirectory.OperatorAVSRegistrationStatus",
+            },
+        ],
+        anonymous: false,
+    },
+    {
+        type: "event",
+        name: "OwnershipTransferred",
+        inputs: [
+            {
+                name: "previousOwner",
+                type: "address",
+                indexed: true,
+                internalType: "address",
+            },
+            {
+                name: "newOwner",
+                type: "address",
+                indexed: true,
+                internalType: "address",
+            },
+        ],
+        anonymous: false,
+    },
+    {
+        type: "event",
+        name: "Paused",
+        inputs: [
+            {
+                name: "account",
+                type: "address",
+                indexed: true,
+                internalType: "address",
+            },
+            {
+                name: "newPausedStatus",
+                type: "uint256",
+                indexed: false,
+                internalType: "uint256",
+            },
+        ],
+        anonymous: false,
+    },
+    {
+        type: "event",
+        name: "PauserRegistrySet",
+        inputs: [
+            {
+                name: "pauserRegistry",
+                type: "address",
+                indexed: false,
+                internalType: "contract IPauserRegistry",
+            },
+            {
+                name: "newPauserRegistry",
+                type: "address",
+                indexed: false,
+                internalType: "contract IPauserRegistry",
+            },
+        ],
+        anonymous: false,
+    },
+    {
+        type: "event",
+        name: "Unpaused",
+        inputs: [
+            {
+                name: "account",
+                type: "address",
+                indexed: true,
+                internalType: "address",
+            },
+            {
+                name: "newPausedStatus",
+                type: "uint256",
+                indexed: false,
+                internalType: "uint256",
+            },
+        ],
+        anonymous: false,
+    },
+];

package/lib/avs/abis/delegationABI.d.ts

@@ -0,0 +1,126 @@
+export declare const delegationABI: ({
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    outputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+        components: {
+            name: string;
+            type: string;
+            internalType: string;
+        }[];
+    }[];
+    outputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: ({
+        name: string;
+        type: string;
+        internalType: string;
+        components: {
+            name: string;
+            type: string;
+            internalType: string;
+        }[];
+    } | {
+        name: string;
+        type: string;
+        internalType: string;
+        components?: undefined;
+    })[];
+    outputs: never[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+        components: ({
+            name: string;
+            type: string;
+            internalType: string;
+            components?: undefined;
+        } | {
+            name: string;
+            type: string;
+            internalType: string;
+            components: {
+                name: string;
+                type: string;
+                internalType: string;
+            }[];
+        })[];
+    }[];
+    outputs: never[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        internalType: string;
+    }[];
+    outputs: {
+        name: string;
+        type: string;
+        internalType: string;
+        components: {
+            name: string;
+            type: string;
+            internalType: string;
+        }[];
+    }[];
+    stateMutability: string;
+    anonymous?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: ({
+        name: string;
+        type: string;
+        indexed: boolean;
+        internalType: string;
+        components?: undefined;
+    } | {
+        name: string;
+        type: string;
+        indexed: boolean;
+        internalType: string;
+        components: {
+            name: string;
+            type: string;
+            internalType: string;
+        }[];
+    })[];
+    anonymous: boolean;
+    outputs?: undefined;
+    stateMutability?: undefined;
+})[];