@oma3/omatrust 0.1.0-alpha.1 → 0.1.0-alpha.10

package/dist/subject-ownership-CXvzEjpH.d.cts

@@ -0,0 +1,434 @@
+type Hex = `0x${string}`;
+type Did = string;
+type ProofType = "pop-jws" | "pop-eip712" | "x402-receipt" | "evidence-pointer" | "tx-encoded-value" | "tx-interaction" | "x402-offer";
+type ProofPurpose = "shared-control" | "commercial-tx";
+type SchemaField = {
+    name: string;
+    type: string;
+    value?: unknown;
+};
+type AttestationValidationError = {
+    schemaFieldName: string;
+    expectedType: string;
+    providedType: string;
+    providedValue: unknown;
+};
+type AttestationQueryResult = {
+    uid: Hex;
+    schema: Hex;
+    attester: Hex;
+    recipient: Hex;
+    txHash?: Hex;
+    revocable: boolean;
+    revocationTime: bigint;
+    expirationTime: bigint;
+    time: bigint;
+    refUID: Hex;
+    data: Record<string, unknown>;
+    raw?: Hex;
+};
+type ProofWrapper = {
+    proofType: ProofType;
+    proofObject: unknown;
+    proofPurpose?: ProofPurpose;
+    version?: number;
+    issuedAt?: number;
+    expiresAt?: number;
+};
+type TxEncodedValueProof = ProofWrapper & {
+    proofType: "tx-encoded-value";
+    proofPurpose: ProofPurpose;
+    proofObject: {
+        chainId: string;
+        txHash: Hex;
+    };
+};
+type TxInteractionProof = ProofWrapper & {
+    proofType: "tx-interaction";
+    proofPurpose: "commercial-tx";
+    proofObject: {
+        chainId: string;
+        txHash: Hex;
+    };
+};
+type PopEip712Proof = ProofWrapper & {
+    proofType: "pop-eip712";
+    proofObject: {
+        domain: {
+            name: string;
+            version: string;
+            chainId: number;
+            verifyingContract?: Hex;
+        };
+        message: {
+            signer: string;
+            authorizedEntity: string;
+            signingPurpose: string;
+            creationTimestamp: number;
+            expirationTimestamp: number;
+            randomValue: Hex;
+            statement: string;
+        };
+        signature: Hex;
+    };
+};
+type PopJwsProof = ProofWrapper & {
+    proofType: "pop-jws";
+    proofObject: string;
+};
+type X402ReceiptProof = ProofWrapper & {
+    proofType: "x402-receipt";
+    proofPurpose: "commercial-tx";
+    proofObject: Record<string, unknown>;
+};
+type X402OfferProof = ProofWrapper & {
+    proofType: "x402-offer";
+    proofPurpose: "commercial-tx";
+    proofObject: Record<string, unknown>;
+};
+type EvidencePointerProof = ProofWrapper & {
+    proofType: "evidence-pointer";
+    proofPurpose: "shared-control";
+    proofObject: {
+        url: string;
+    };
+};
+type ChainConstants = {
+    base: bigint;
+    range: bigint;
+    decimals: number;
+    nativeSymbol: string;
+};
+type SubmitAttestationParams = {
+    signer: unknown;
+    chainId: number;
+    easContractAddress: Hex;
+    schemaUid: Hex;
+    schema: SchemaField[] | string;
+    data: Record<string, unknown>;
+    revocable?: boolean;
+    expirationTime?: bigint | number;
+    refUid?: Hex;
+    value?: bigint | number;
+};
+type SubmitAttestationResult = {
+    uid: Hex;
+    txHash: Hex;
+    receipt?: unknown;
+};
+type RevokeAttestationParams = {
+    signer: unknown;
+    easContractAddress: Hex;
+    schemaUid: Hex;
+    uid: Hex;
+    value?: bigint | number;
+};
+type RevokeAttestationResult = {
+    txHash: Hex;
+    receipt?: unknown;
+};
+type PrepareDelegatedAttestationParams = {
+    chainId: number;
+    easContractAddress: Hex;
+    schemaUid: Hex;
+    schema: SchemaField[] | string;
+    data: Record<string, unknown>;
+    attester: Hex;
+    nonce: bigint | number;
+    revocable?: boolean;
+    expirationTime?: bigint | number;
+    refUid?: Hex;
+    value?: bigint | number;
+    deadline?: bigint | number;
+};
+type PrepareDelegatedAttestationResult = {
+    delegatedRequest: Record<string, unknown>;
+    typedData: {
+        domain: Record<string, unknown>;
+        types: Record<string, unknown>;
+        message: Record<string, unknown>;
+    };
+};
+type BuildDelegatedTypedDataFromEncodedParams = {
+    chainId: number;
+    easContractAddress: Hex;
+    schemaUid: Hex;
+    encodedData: Hex;
+    recipient: Hex;
+    attester: Hex;
+    nonce: bigint | number;
+    revocable?: boolean;
+    expirationTime?: bigint | number;
+    refUid?: Hex;
+    value?: bigint | number;
+    deadline?: bigint | number;
+};
+type SubmitDelegatedAttestationParams = {
+    relayUrl: string;
+    prepared: PrepareDelegatedAttestationResult;
+    signature: Hex | string;
+    attester?: Hex;
+};
+type SubmitDelegatedAttestationResult = {
+    uid: Hex;
+    txHash?: Hex;
+    status: "submitted" | "confirmed";
+};
+type GetAttestationParams = {
+    uid: Hex;
+    provider: unknown;
+    easContractAddress: Hex;
+    schema?: SchemaField[] | string;
+};
+type ListAttestationsParams = {
+    did: Did;
+    provider: unknown;
+    easContractAddress: Hex;
+    schemas?: Hex[];
+    limit?: number;
+    fromBlock?: number;
+    toBlock?: number;
+};
+type GetAttestationsByAttesterParams = {
+    attester: Hex;
+    provider: unknown;
+    easContractAddress: Hex;
+    schemas?: Hex[];
+    limit?: number;
+    fromBlock?: number;
+    toBlock?: number;
+};
+type VerifyAttestationParams = {
+    attestation: AttestationQueryResult;
+    provider?: unknown;
+    checks?: ProofType[];
+    context?: Record<string, unknown>;
+};
+type VerifyAttestationResult = {
+    valid: boolean;
+    checks: Record<string, boolean>;
+    reasons: string[];
+};
+type CallControllerWitnessParams = {
+    gatewayUrl: string;
+    attestationUid: Hex;
+    chainId: number;
+    easContract: Hex;
+    schemaUid: Hex;
+    subject: Did;
+    controller: Did;
+    timeoutMs?: number;
+};
+type CallControllerWitnessResult = {
+    ok: boolean;
+    method: "dns-txt" | "did-json";
+    details?: unknown;
+};
+type VerifyProofParams = {
+    proof: ProofWrapper;
+    provider?: unknown;
+    expectedSubject?: Did;
+    expectedController?: Did;
+};
+type VerifyProofResult = {
+    valid: boolean;
+    proofType: ProofType;
+    reason?: string;
+};
+
+declare function submitAttestation(params: SubmitAttestationParams): Promise<SubmitAttestationResult>;
+
+declare function revokeAttestation(params: RevokeAttestationParams): Promise<RevokeAttestationResult>;
+
+declare function buildDelegatedAttestationTypedData(params: PrepareDelegatedAttestationParams): {
+    domain: Record<string, unknown>;
+    types: Record<string, unknown>;
+    message: Record<string, unknown>;
+};
+declare function buildDelegatedTypedDataFromEncoded(params: BuildDelegatedTypedDataFromEncodedParams): {
+    domain: Record<string, unknown>;
+    types: Record<string, unknown>;
+    message: Record<string, unknown>;
+};
+declare function splitSignature(signature: Hex | string): {
+    v: number;
+    r: Hex;
+    s: Hex;
+};
+declare function prepareDelegatedAttestation(params: PrepareDelegatedAttestationParams): Promise<PrepareDelegatedAttestationResult>;
+declare function submitDelegatedAttestation(params: SubmitDelegatedAttestationParams): Promise<SubmitDelegatedAttestationResult>;
+
+declare function getAttestation(params: GetAttestationParams): Promise<AttestationQueryResult>;
+declare function getAttestationsForDid(params: ListAttestationsParams): Promise<AttestationQueryResult[]>;
+declare function getAttestationsByAttester(params: GetAttestationsByAttesterParams): Promise<AttestationQueryResult[]>;
+declare function listAttestations(params: ListAttestationsParams): Promise<AttestationQueryResult[]>;
+type GetLatestAttestationsParams = {
+    provider: unknown;
+    easContractAddress: Hex;
+    schemas?: Hex[];
+    limit?: number;
+    fromBlock?: number;
+};
+declare function getLatestAttestations(params: GetLatestAttestationsParams): Promise<AttestationQueryResult[]>;
+declare function deduplicateReviews(attestations: AttestationQueryResult[]): AttestationQueryResult[];
+declare function calculateAverageUserReviewRating(attestations: AttestationQueryResult[]): number;
+declare function getMajorVersion(version: string): number;
+
+declare function verifyProof(params: VerifyProofParams): Promise<VerifyProofResult>;
+declare function verifyAttestation(params: VerifyAttestationParams): Promise<VerifyAttestationResult>;
+
+declare function normalizeSchema(schema: SchemaField[] | string): SchemaField[];
+declare function schemaToString(schema: SchemaField[] | string): string;
+declare function encodeAttestationData(schema: SchemaField[] | string, data: Record<string, unknown>): Hex;
+declare function validateAttestationData(schema: SchemaField[] | string, data: Record<string, unknown>): AttestationValidationError[];
+declare function decodeAttestationData(schema: SchemaField[] | string, encodedData: Hex): Record<string, unknown>;
+declare function extractExpirationTime(data: Record<string, unknown>): bigint | number | undefined;
+
+declare function verifySchemaExists(schemaRegistry: unknown, schemaUid: Hex): Promise<boolean>;
+declare function getSchemaDetails(schemaRegistry: unknown, schemaUid: Hex): Promise<{
+    uid: Hex;
+    schema: string;
+    resolver: Hex;
+    revocable: boolean;
+}>;
+declare function formatSchemaUid(schemaUid: string): Hex;
+
+declare function callControllerWitness(params: CallControllerWitnessParams): Promise<CallControllerWitnessResult>;
+
+declare function getSupportedChainIds(): number[];
+declare function isChainSupported(chainId: number): boolean;
+declare function getChainConstants(chainId: number, purpose: ProofPurpose): ChainConstants;
+declare function constructSeed(subjectDidHash: Hex, counterpartyDidHash: Hex, purpose: ProofPurpose): Uint8Array;
+declare function hashSeed(seedBytes: Uint8Array, chainId: number): Hex;
+declare function calculateTransferAmount(subject: string, counterparty: string, chainId: number, purpose: ProofPurpose): bigint;
+declare function calculateTransferAmountFromAddresses(subjectAddress: string, counterpartyAddress: string, chainId: number, purpose: ProofPurpose): bigint;
+declare function createTxEncodedValueProof(chainId: number, txHash: Hex, purpose: ProofPurpose): TxEncodedValueProof;
+declare function formatTransferAmount(amount: bigint | number, chainId: number): string;
+declare function getExplorerTxUrl(chainId: number, txHash: Hex): string;
+declare function getExplorerAddressUrl(chainId: number, address: string): string;
+
+declare function createTxInteractionProof(chainId: number, txHash: Hex): TxInteractionProof;
+
+type CreatePopEip712ProofParams = {
+    signer: string;
+    authorizedEntity: string;
+    signingPurpose: ProofPurpose;
+    chainId: number;
+    creationTimestamp?: number;
+    expirationTimestamp?: number;
+    randomValue?: Hex;
+    statement?: string;
+};
+declare function createPopEip712Proof(params: CreatePopEip712ProofParams, signFn: (typedData: Record<string, unknown>) => Promise<Hex>): Promise<PopEip712Proof>;
+
+type CreatePopJwsProofParams = {
+    issuer: Did;
+    audience: Did;
+    purpose: ProofPurpose;
+    issuedAt?: number;
+    expiresAt?: number;
+    nonce?: string;
+};
+declare function createPopJwsProof(params: CreatePopJwsProofParams, signFn: (payload: Record<string, unknown>, header: Record<string, unknown>) => Promise<string>): Promise<PopJwsProof>;
+
+declare function createX402ReceiptProof(receipt: Record<string, unknown>): X402ReceiptProof;
+declare function createX402OfferProof(offer: Record<string, unknown>): X402OfferProof;
+
+declare function createEvidencePointerProof(url: string): EvidencePointerProof;
+
+declare function parseDnsTxtRecord(record: string): {
+    version?: string;
+    controller?: Did;
+    [key: string]: string | undefined;
+};
+declare function buildDnsTxtRecord(controllerDid: Did): string;
+
+declare function fetchDidDocument(domain: string): Promise<Record<string, unknown>>;
+interface VerifyDidJsonControllerDidOptions {
+    fetchDidDocument?: (domain: string) => Promise<Record<string, unknown>>;
+}
+declare function extractAddressesFromDidDocument(didDocument: Record<string, unknown>): string[];
+declare function verifyDidDocumentControllerDid(didDocument: Record<string, unknown>, expectedControllerDid: Did): {
+    valid: boolean;
+    reason?: string;
+};
+declare function verifyDidJsonControllerDid(domain: string, expectedControllerDid: Did, options?: VerifyDidJsonControllerDidOptions): Promise<{
+    valid: boolean;
+    reason?: string;
+}>;
+
+declare function buildEip712Domain(name: string, version: string, chainId: number, verifyingContract: Hex): {
+    name: string;
+    version: string;
+    chainId: number;
+    verifyingContract: Hex;
+};
+declare function getOmaTrustProofEip712Types(): {
+    primaryType: string;
+    types: Record<string, Array<{
+        name: string;
+        type: string;
+    }>>;
+};
+declare function verifyEip712Signature(typedData: {
+    domain: Record<string, unknown>;
+    types: Record<string, unknown>;
+    message: Record<string, unknown>;
+}, signature: Hex | string): {
+    valid: boolean;
+    signer?: string;
+};
+
+interface VerifyDnsTxtControllerDidOptions {
+    resolveTxt?: (host: string) => Promise<string[][]>;
+    recordPrefix?: string;
+}
+
+type SubjectOwnershipVerificationMethod = "dns" | "did-document" | "wallet" | "contract" | "minting-wallet" | "transfer";
+interface SubjectOwnershipVerificationResult {
+    valid: boolean;
+    method?: SubjectOwnershipVerificationMethod;
+    reason?: string;
+    details?: string;
+    subjectDid: Did;
+    connectedWalletDid: Did;
+    controllingWalletDid?: Did;
+}
+interface EvmOwnershipProvider {
+    call(transaction: {
+        to: string;
+        data: string;
+    }): Promise<string>;
+    getCode(address: string): Promise<string>;
+    getStorage(address: string, slot: string): Promise<string>;
+    getTransaction(hash: string): Promise<{
+        from?: string | null;
+        to?: string | null;
+        value?: bigint | string | number | null;
+        blockNumber?: number | null;
+    } | null>;
+    getTransactionReceipt(hash: string): Promise<{
+        blockNumber: number;
+    } | null>;
+    getBlockNumber(): Promise<number>;
+    getBlock(blockNumber: number): Promise<{
+        timestamp: number;
+    } | null>;
+}
+interface VerifyDidWebOwnershipParams extends VerifyDnsTxtControllerDidOptions {
+    subjectDid: Did;
+    connectedWalletDid: Did;
+    fetchDidDocument?: (domain: string) => Promise<Record<string, unknown>>;
+}
+interface VerifyDidPkhOwnershipParams {
+    subjectDid: Did;
+    connectedWalletDid: Did;
+    provider: EvmOwnershipProvider;
+    txHash?: Hex | string;
+}
+type VerifySubjectOwnershipParams = VerifyDidWebOwnershipParams | (VerifyDidPkhOwnershipParams & VerifyDnsTxtControllerDidOptions);
+declare function verifyDidWebOwnership(params: VerifyDidWebOwnershipParams): Promise<SubjectOwnershipVerificationResult>;
+declare function verifyDidPkhOwnership(params: VerifyDidPkhOwnershipParams): Promise<SubjectOwnershipVerificationResult>;
+declare function verifySubjectOwnership(params: VerifySubjectOwnershipParams): Promise<SubjectOwnershipVerificationResult>;
+
+export { createEvidencePointerProof as $, type AttestationQueryResult as A, type BuildDelegatedTypedDataFromEncodedParams as B, type CallControllerWitnessParams as C, type Did as D, type EvidencePointerProof as E, type VerifyProofParams as F, type GetAttestationParams as G, type Hex as H, type VerifyProofResult as I, type VerifySubjectOwnershipParams as J, type X402ReceiptProof as K, type ListAttestationsParams as L, buildDelegatedAttestationTypedData as M, buildDelegatedTypedDataFromEncoded as N, buildDnsTxtRecord as O, type PopEip712Proof as P, buildEip712Domain as Q, type RevokeAttestationParams as R, type SchemaField as S, type TxEncodedValueProof as T, calculateAverageUserReviewRating as U, type VerifyAttestationParams as V, calculateTransferAmount as W, type X402OfferProof as X, calculateTransferAmountFromAddresses as Y, callControllerWitness as Z, constructSeed as _, type AttestationValidationError as a, createPopEip712Proof as a0, createPopJwsProof as a1, createTxEncodedValueProof as a2, createTxInteractionProof as a3, createX402OfferProof as a4, createX402ReceiptProof as a5, decodeAttestationData as a6, deduplicateReviews as a7, encodeAttestationData as a8, extractAddressesFromDidDocument as a9, validateAttestationData as aA, verifyAttestation as aB, verifyDidDocumentControllerDid as aC, verifyDidJsonControllerDid as aD, verifyDidPkhOwnership as aE, verifyDidWebOwnership as aF, verifyEip712Signature as aG, verifyProof as aH, verifySchemaExists as aI, verifySubjectOwnership as aJ, extractExpirationTime as aa, fetchDidDocument as ab, formatSchemaUid as ac, formatTransferAmount as ad, getAttestation as ae, getAttestationsByAttester as af, getAttestationsForDid as ag, getChainConstants as ah, getExplorerAddressUrl as ai, getExplorerTxUrl as aj, getLatestAttestations as ak, getMajorVersion as al, getOmaTrustProofEip712Types as am, getSchemaDetails as an, getSupportedChainIds as ao, hashSeed as ap, isChainSupported as aq, listAttestations as ar, normalizeSchema as as, parseDnsTxtRecord as at, prepareDelegatedAttestation as au, revokeAttestation as av, schemaToString as aw, splitSignature as ax, submitAttestation as ay, submitDelegatedAttestation as az, type CallControllerWitnessResult as b, type ChainConstants as c, type CreatePopEip712ProofParams as d, type CreatePopJwsProofParams as e, type EvmOwnershipProvider as f, type GetAttestationsByAttesterParams as g, type GetLatestAttestationsParams as h, type PopJwsProof as i, type PrepareDelegatedAttestationParams as j, type PrepareDelegatedAttestationResult as k, type ProofPurpose as l, type ProofType as m, type ProofWrapper as n, type RevokeAttestationResult as o, type SubjectOwnershipVerificationMethod as p, type SubjectOwnershipVerificationResult as q, type SubmitAttestationParams as r, type SubmitAttestationResult as s, type SubmitDelegatedAttestationParams as t, type SubmitDelegatedAttestationResult as u, type TxInteractionProof as v, type VerifyAttestationResult as w, type VerifyDidJsonControllerDidOptions as x, type VerifyDidPkhOwnershipParams as y, type VerifyDidWebOwnershipParams as z };