@thurinlabs/identity-kit 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,204 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+interface SignetClaim {
+    index: number;
+    fingerprint: string;
+    createdAt: number;
+    revoked: boolean;
+    pgpSignature: string | null;
+    pgpPublicKey: string | null;
+    txHash: string | null;
+    verification: PGPVerification | null;
+}
+interface PGPVerification {
+    verified: boolean;
+    reason?: string;
+}
+interface PGPKeyInfo {
+    fingerprint: string;
+    userIDs: string[];
+    algorithm: string;
+    created: string | null;
+    expires: string | null;
+    notations: Notation[];
+    subkeys: SubkeyInfo[];
+}
+interface SubkeyInfo {
+    algorithm: string;
+    created: string | null;
+    fingerprint: string;
+}
+interface Notation {
+    name: string;
+    value: string;
+}
+interface Proof {
+    provider: string;
+    label: string;
+    url: string;
+    user?: string;
+    instance?: string;
+    repo?: string;
+    gistId?: string;
+    castHash?: string;
+    domain?: string;
+}
+interface ProofResult {
+    provider: string;
+    label: string;
+    url: string;
+    displayUrl: string;
+    href: string | null;
+    secondaryHref: string | null;
+    status: 'verified' | 'unverified' | 'pending' | 'skipped';
+    reason?: string;
+}
+interface EFPGraph {
+    followers: number;
+    following: number;
+    top8: string[];
+    hasEfp: boolean;
+}
+interface ScryIdentity {
+    address: string | null;
+    ensName: string | null;
+    ensAvatar: string | null;
+    claims: SignetClaim[];
+    totalClaims: number;
+    activeClaims: number;
+    currentFingerprint: string | null;
+    pgpKeyInfo: PGPKeyInfo | null;
+    proofs: ProofResult[];
+    efp: EFPGraph | null;
+    isLoading: boolean;
+    error: Error | null;
+}
+type Theme = 'thurin' | 'dark' | 'light';
+interface IdentityKitConfig {
+    rpcUrl?: string;
+    neynarApiKey?: string;
+    scryBaseUrl?: string;
+}
+
+interface IdentityKitProviderProps extends IdentityKitConfig {
+    children: ReactNode;
+}
+declare function IdentityKitProvider({ children, rpcUrl, neynarApiKey, scryBaseUrl, }: IdentityKitProviderProps): react_jsx_runtime.JSX.Element;
+
+interface ScryCardProps {
+    ens?: string;
+    address?: string;
+    theme?: Theme;
+}
+declare function ScryCard({ ens, address, theme }: ScryCardProps): react_jsx_runtime.JSX.Element;
+
+declare function useScryIdentity(ensOrAddress: string | undefined | null): ScryIdentity;
+
+declare function useSignetClaims(address: string | undefined | null): {
+    claims: SignetClaim[];
+    totalClaims: number;
+    activeClaims: number;
+    currentFingerprint: string | null;
+    isLoading: boolean;
+};
+
+declare function useEFPGraph(address: string | undefined | null): {
+    efp: EFPGraph | null;
+    isLoading: boolean;
+};
+
+declare function usePGPProofs(fingerprint: string | undefined | null): {
+    keyInfo: PGPKeyInfo | null;
+    proofs: ProofResult[];
+    isLoading: boolean;
+};
+
+declare function identifyProof(notation: Notation): Proof | null;
+declare function displayUrl(proof: Proof): string;
+declare function proofHref(proof: Proof): string | null;
+declare function proofSecondaryHref(proof: Proof): string | null;
+declare function verifyProof(proof: Proof, fingerprint: string, neynarApiKey?: string): Promise<PGPVerification>;
+
+declare function parsePgpKey(armoredKey: string): Promise<PGPKeyInfo | null>;
+declare function verifyAttestation({ pgpPublicKey, pgpSignature, fingerprint, ethAddress, }: {
+    pgpPublicKey: string | null;
+    pgpSignature: string | null;
+    fingerprint: string;
+    ethAddress: string;
+}): Promise<PGPVerification>;
+declare function fetchKeyByFingerprint(fingerprint: string): Promise<string | null>;
+declare function fetchKeyByKeyId(keyId: string): Promise<string | null>;
+
+declare function fetchEFPGraph(address: string): Promise<EFPGraph | null>;
+
+declare const REGISTRY_ADDRESS: "0xf7a45BC662A78a6fb417ED5f52b3766cbf13EbBb";
+declare const CONTRACT_DEPLOY_BLOCK = 24515891n;
+declare const REGISTRY_ABI: readonly [{
+    readonly name: "Attested";
+    readonly type: "event";
+    readonly inputs: readonly [{
+        readonly name: "ethAddress";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "fingerprintHash";
+        readonly type: "string";
+        readonly indexed: true;
+    }, {
+        readonly name: "fingerprint";
+        readonly type: "string";
+        readonly indexed: false;
+    }, {
+        readonly name: "pgpSignature";
+        readonly type: "string";
+        readonly indexed: false;
+    }, {
+        readonly name: "pgpPublicKey";
+        readonly type: "string";
+        readonly indexed: false;
+    }, {
+        readonly name: "index";
+        readonly type: "uint256";
+        readonly indexed: false;
+    }, {
+        readonly name: "timestamp";
+        readonly type: "uint256";
+        readonly indexed: false;
+    }];
+}, {
+    readonly name: "attestationCount";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "getAttestation";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+    }, {
+        readonly name: "index";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "fingerprint";
+        readonly type: "string";
+    }, {
+        readonly name: "createdAt";
+        readonly type: "uint256";
+    }, {
+        readonly name: "revoked";
+        readonly type: "bool";
+    }];
+}];
+
+export { CONTRACT_DEPLOY_BLOCK, type EFPGraph, type IdentityKitConfig, IdentityKitProvider, type IdentityKitProviderProps, type Notation, type PGPKeyInfo, type PGPVerification, type Proof, type ProofResult, REGISTRY_ABI, REGISTRY_ADDRESS, ScryCard, type ScryCardProps, type ScryIdentity, type SignetClaim, type SubkeyInfo, type Theme, displayUrl, fetchEFPGraph, fetchKeyByFingerprint, fetchKeyByKeyId, identifyProof, parsePgpKey, proofHref, proofSecondaryHref, useEFPGraph, usePGPProofs, useScryIdentity, useSignetClaims, verifyAttestation, verifyProof };