@4mica/sdk 1.2.16 → 1.3.1

package/dist/models-B15ouNYG.d.cts

@@ -0,0 +1,386 @@
+/** Signing scheme used when producing a payment guarantee signature. */
+declare enum SigningScheme {
+    /** EIP-712 typed-data signing (default, preferred). */
+    EIP712 = "eip712",
+    /** EIP-191 personal_sign (for wallets that do not support typed data). */
+    EIP191 = "eip191"
+}
+/** ECDSA signature and the scheme used to produce it. */
+interface PaymentSignature {
+    /** 65-byte ECDSA signature as a `0x`-prefixed hex string. */
+    signature: string;
+    scheme: SigningScheme;
+}
+/**
+ * V1 payment guarantee request claims. Signed by the payer and submitted to the
+ * core RPC to obtain a BLS guarantee certificate.
+ *
+ * Build with the static {@link PaymentGuaranteeRequestClaims.new} factory which
+ * normalises addresses and parses `uint256` values.
+ */
+declare class PaymentGuaranteeRequestClaims {
+    userAddress: string;
+    recipientAddress: string;
+    reqId: bigint;
+    amount: bigint;
+    timestamp: number;
+    assetAddress: string;
+    constructor(init: {
+        userAddress: string;
+        recipientAddress: string;
+        reqId?: bigint;
+        amount: bigint;
+        timestamp: number;
+        assetAddress: string;
+    });
+    static new(userAddress: string, recipientAddress: string, amount: number | bigint | string, timestamp: number, erc20Token?: string | null, reqId?: number | bigint | string): PaymentGuaranteeRequestClaims;
+}
+/** On-chain validation policy fields carried in a V2 payment guarantee certificate. */
+interface PaymentGuaranteeValidationPolicyV2 {
+    validationRegistryAddress: string;
+    validationRequestHash: string;
+    validationChainId: number;
+    validatorAddress: string;
+    validatorAgentId: bigint;
+    minValidationScore: number;
+    validationSubjectHash: string;
+    jobHash: string;
+    requiredValidationTag: string;
+}
+/**
+ * V2 payment guarantee request claims — extends V1 with a full on-chain validation policy.
+ *
+ * Compute `validationSubjectHash` via `computeValidationSubjectHash(baseClaims)` and
+ * `validationRequestHash` via `computeValidationRequestHash(partialV2)` before constructing.
+ * The `jobHash` must be provided and included in the validation request hash.
+ *
+ * @throws {@link ValidationError} if `minValidationScore` is outside [1, 100].
+ */
+declare class PaymentGuaranteeRequestClaimsV2 extends PaymentGuaranteeRequestClaims {
+    validationRegistryAddress: string;
+    validationRequestHash: string;
+    validationChainId: number;
+    validatorAddress: string;
+    validatorAgentId: bigint;
+    minValidationScore: number;
+    validationSubjectHash: string;
+    jobHash: string;
+    requiredValidationTag: string;
+    constructor(init: {
+        userAddress: string;
+        recipientAddress: string;
+        reqId?: bigint;
+        amount: bigint;
+        timestamp: number;
+        assetAddress: string;
+        validationRegistryAddress: string;
+        validationRequestHash: string;
+        validationChainId: number;
+        validatorAddress: string;
+        validatorAgentId: bigint;
+        minValidationScore: number;
+        validationSubjectHash: string;
+        jobHash: string;
+        requiredValidationTag: string;
+    });
+}
+/**
+ * Decoded payment guarantee claims, as returned by `decodeGuaranteeClaims`.
+ * `version` is `1` for V1 certificates and `2` for V2 certificates.
+ * V2 certificates additionally carry a `validationPolicy`.
+ */
+interface PaymentGuaranteeClaims {
+    domain: Uint8Array;
+    userAddress: string;
+    recipientAddress: string;
+    cycleId: bigint;
+    reqId: bigint;
+    amount: bigint;
+    assetAddress: string;
+    timestamp: number;
+    version: number;
+    validationPolicy?: PaymentGuaranteeValidationPolicyV2;
+}
+/**
+ * BLS guarantee certificate returned by `issuePaymentGuarantee`.
+ * Both fields are `0x`-prefixed hex strings.
+ */
+interface BLSCert {
+    /** ABI-encoded `(uint64 version, bytes innerClaims)` envelope as a hex string. */
+    claims: string;
+    /** BLS12-381 G2 signature as a hex string. */
+    signature: string;
+}
+/** On-chain collateral position for a single asset, returned by `getUser`. */
+interface UserInfo {
+    /** Asset address (`0x000...` for ETH). */
+    asset: string;
+    /** Total deposited collateral available for payments (in token base units). */
+    collateral: bigint;
+    /** Amount of a pending withdrawal request (0 if none). */
+    withdrawalRequestAmount: bigint;
+    /** Unix timestamp when the withdrawal request was made (0 if none). */
+    withdrawalRequestTimestamp: number;
+}
+declare class UserSuspensionStatus {
+    userAddress: string;
+    suspended: boolean;
+    updatedAt: number;
+    constructor(userAddress: string, suspended: boolean, updatedAt: number);
+    static fromRpc(raw: Record<string, unknown>): UserSuspensionStatus;
+}
+declare class AdminApiKeyInfo {
+    id: string;
+    name: string;
+    scopes: string[];
+    createdAt: number;
+    revokedAt?: number | null | undefined;
+    constructor(id: string, name: string, scopes: string[], createdAt: number, revokedAt?: number | null | undefined);
+    static fromRpc(raw: Record<string, unknown>): AdminApiKeyInfo;
+}
+declare class AdminApiKeySecret {
+    id: string;
+    name: string;
+    scopes: string[];
+    createdAt: number;
+    apiKey: string;
+    constructor(id: string, name: string, scopes: string[], createdAt: number, apiKey: string);
+    static fromRpc(raw: Record<string, unknown>): AdminApiKeySecret;
+}
+/**
+ * Off-chain clearing settlement action a participant performs against the
+ * ClearingHouse contract for a given cycle.
+ */
+type ClearingSettlementActionKind = "pay_net_debit" | "claim_net_credit" | "mark_defaulted";
+/** Role a participant holds in a settlement cycle. */
+type ClearingParticipantRole = "NET_CREDITOR" | "NET_DEBTOR" | "BALANCED" | string;
+/**
+ * A participant's committed position in a settlement cycle, with the Merkle
+ * proof needed to settle on-chain. Returned by `getClearingParticipantProof`.
+ */
+declare class ClearingParticipantProof {
+    /** On-chain `bytes32` cycle identifier. */
+    cycleId: string;
+    /** Core database cycle identifier. */
+    cycleIdText: string;
+    assetAddress: string;
+    participant: string;
+    role: ClearingParticipantRole;
+    /** Amount used with the participant's role-specific ClearingHouse call. */
+    amount: bigint;
+    netDebit: bigint;
+    netCredit: bigint;
+    leaf: string;
+    merkleRoot: string;
+    proof: string[];
+    constructor(
+    /** On-chain `bytes32` cycle identifier. */
+    cycleId: string, 
+    /** Core database cycle identifier. */
+    cycleIdText: string, assetAddress: string, participant: string, role: ClearingParticipantRole, 
+    /** Amount used with the participant's role-specific ClearingHouse call. */
+    amount: bigint, netDebit: bigint, netCredit: bigint, leaf: string, merkleRoot: string, proof: string[]);
+    static fromRpc(raw: Record<string, unknown>): ClearingParticipantProof;
+}
+/**
+ * A prepared ClearingHouse contract call for a participant, including the amount
+ * and Merkle proof. Returned by `getClearingSettlementAction` and its helpers.
+ */
+declare class ClearingSettlementActionResponse {
+    /** ClearingHouse contract address. */
+    contractAddress: string;
+    /** Contract function to call (`payNetDebit`, `claimNetCredit`, `markDefaulted`). */
+    functionName: string;
+    action: ClearingSettlementActionKind;
+    /** On-chain `bytes32` cycle identifier. */
+    cycleId: string;
+    /** Core database cycle identifier. */
+    cycleIdText: string;
+    assetAddress: string;
+    /** Participant whose committed Merkle leaf is proven. */
+    participant: string;
+    /** Alias for `participant` when `action = mark_defaulted`. */
+    debtor: string | null;
+    /** Amount argument for the selected ClearingHouse function. */
+    amount: bigint;
+    /** Native value to attach — non-zero only for native-asset debtor payments. */
+    payableValue: bigint;
+    proof: string[];
+    constructor(
+    /** ClearingHouse contract address. */
+    contractAddress: string, 
+    /** Contract function to call (`payNetDebit`, `claimNetCredit`, `markDefaulted`). */
+    functionName: string, action: ClearingSettlementActionKind, 
+    /** On-chain `bytes32` cycle identifier. */
+    cycleId: string, 
+    /** Core database cycle identifier. */
+    cycleIdText: string, assetAddress: string, 
+    /** Participant whose committed Merkle leaf is proven. */
+    participant: string, 
+    /** Alias for `participant` when `action = mark_defaulted`. */
+    debtor: string | null, 
+    /** Amount argument for the selected ClearingHouse function. */
+    amount: bigint, 
+    /** Native value to attach — non-zero only for native-asset debtor payments. */
+    payableValue: bigint, proof: string[]);
+    static fromRpc(raw: Record<string, unknown>): ClearingSettlementActionResponse;
+}
+declare class AssetBalanceInfo {
+    userAddress: string;
+    assetAddress: string;
+    total: bigint;
+    locked: bigint;
+    version: number;
+    updatedAt: number;
+    constructor(userAddress: string, assetAddress: string, total: bigint, locked: bigint, version: number, updatedAt: number);
+    static fromRpc(raw: Record<string, unknown>): AssetBalanceInfo;
+}
+declare class RecipientPaymentInfo {
+    userAddress: string;
+    recipientAddress: string;
+    txHash: string;
+    amount: bigint;
+    verified: boolean;
+    finalized: boolean;
+    failed: boolean;
+    createdAt: number;
+    constructor(userAddress: string, recipientAddress: string, txHash: string, amount: bigint, verified: boolean, finalized: boolean, failed: boolean, createdAt: number);
+    static fromRpc(raw: Record<string, unknown>): RecipientPaymentInfo;
+}
+interface SupportedTokenInfo {
+    symbol: string;
+    address: string;
+    decimals?: number;
+}
+declare class SupportedTokensResponse {
+    chainId: number;
+    tokens: SupportedTokenInfo[];
+    constructor(chainId: number, tokens: SupportedTokenInfo[]);
+    static fromRpc(raw: Record<string, unknown>): SupportedTokensResponse;
+}
+declare class CorePublicParameters {
+    publicKey: Uint8Array;
+    contractAddress: string;
+    ethereumHttpRpcUrl: string;
+    eip712Name: string;
+    eip712Version: string;
+    chainId: number;
+    maxAcceptedGuaranteeVersion: number;
+    acceptedGuaranteeVersions: number[];
+    activeGuaranteeDomainSeparator: string;
+    /** Allowlist of trusted validation registry addresses configured in core (may be empty). */
+    trustedValidationRegistries: string[];
+    validationHashCanonicalizationVersion: string;
+    constructor(publicKey: Uint8Array, contractAddress: string, ethereumHttpRpcUrl: string, eip712Name: string, eip712Version: string, chainId: number, maxAcceptedGuaranteeVersion?: number, acceptedGuaranteeVersions?: number[], activeGuaranteeDomainSeparator?: string, 
+    /** Allowlist of trusted validation registry addresses configured in core (may be empty). */
+    trustedValidationRegistries?: string[], validationHashCanonicalizationVersion?: string);
+    static fromRpc(payload: Record<string, unknown>): CorePublicParameters;
+}
+
+interface PaymentPayloadClaimsBase {
+    user_address: string;
+    recipient_address: string;
+    req_id: string;
+    amount: string;
+    timestamp: number;
+    asset_address: string;
+}
+/** Wire-format representation of V1 payment guarantee claims sent to the core RPC. */
+interface PaymentPayloadClaims extends PaymentPayloadClaimsBase {
+    version: "v1";
+}
+/** Wire-format representation of V2 payment guarantee claims sent to the core RPC. */
+interface PaymentPayloadClaimsV2 extends PaymentPayloadClaimsBase {
+    version: "v2";
+    validation_registry_address: string;
+    validation_request_hash: string;
+    validation_chain_id: number;
+    validator_address: string;
+    validator_agent_id: string;
+    min_validation_score: number;
+    validation_subject_hash: string;
+    job_hash: string;
+    required_validation_tag: string;
+}
+/** Assembled payment payload ready to be submitted to the core RPC `issueGuarantee` endpoint. */
+interface PaymentPayload {
+    claims: PaymentPayloadClaims | PaymentPayloadClaimsV2;
+    /** 65-byte ECDSA signature as a `0x`-prefixed hex string. */
+    signature: string;
+    scheme: SigningScheme;
+}
+
+interface PaymentRequirementsV1 {
+    scheme: string;
+    network: string;
+    maxAmountRequired: string;
+    payTo: string;
+    asset: string;
+    resource?: string;
+    description?: string;
+    mimeType?: string;
+    outputSchema?: unknown;
+    maxTimeoutSeconds?: number;
+    extra?: PaymentRequirementsExtra;
+}
+interface PaymentRequirementsV2 {
+    scheme: string;
+    network: string;
+    asset: string;
+    amount: string;
+    payTo: string;
+    maxTimeoutSeconds?: number;
+    extra?: PaymentRequirementsExtra;
+}
+type PaymentRequirements = PaymentRequirementsV2;
+interface PaymentRequirementsExtra {
+    tabEndpoint?: string;
+    validationRegistryAddress?: string;
+    validationChainId?: number;
+    validatorAddress?: string;
+    validatorAgentId?: string;
+    minValidationScore?: number;
+    jobHash?: string;
+    requiredValidationTag?: string;
+}
+interface TabResponse {
+    userAddress: string;
+    nextReqId?: string;
+}
+type X402PaymentPayloadClaims = PaymentPayload["claims"];
+type X402PaymentPayload = PaymentPayload;
+interface X402PaymentEnvelopeV1 {
+    x402Version: number;
+    scheme: string;
+    network: string;
+    payload: X402PaymentPayload;
+}
+interface X402ResourceInfo {
+    url: string;
+    description: string;
+    mimeType: string;
+}
+interface X402PaymentEnvelopeV2 {
+    x402Version: number;
+    accepted: PaymentRequirementsV2;
+    payload: X402PaymentPayload;
+    resource: X402ResourceInfo;
+}
+interface X402SignedPayment {
+    header: string;
+    payload: X402PaymentPayload;
+    signature: PaymentSignature;
+}
+interface X402SettledPayment {
+    payment: X402SignedPayment;
+    settlement: unknown;
+}
+interface X402PaymentRequired {
+    x402Version: number;
+    error?: string;
+    resource: X402ResourceInfo;
+    accepts: PaymentRequirementsV2[];
+    extensions?: Record<string, unknown>;
+}
+
+export { AdminApiKeySecret as A, type BLSCert as B, CorePublicParameters as C, type X402PaymentPayloadClaims as D, PaymentGuaranteeRequestClaims as P, RecipientPaymentInfo as R, SupportedTokensResponse as S, type TabResponse as T, UserSuspensionStatus as U, type X402SignedPayment as X, type ClearingSettlementActionKind as a, AdminApiKeyInfo as b, PaymentGuaranteeRequestClaimsV2 as c, SigningScheme as d, type PaymentGuaranteeClaims as e, ClearingParticipantProof as f, ClearingSettlementActionResponse as g, AssetBalanceInfo as h, type UserInfo as i, type PaymentSignature as j, type PaymentPayload as k, type PaymentPayloadClaims as l, type PaymentPayloadClaimsV2 as m, type PaymentRequirementsV1 as n, type X402PaymentRequired as o, type PaymentRequirementsV2 as p, type X402SettledPayment as q, type X402ResourceInfo as r, type ClearingParticipantRole as s, type PaymentGuaranteeValidationPolicyV2 as t, type PaymentRequirements as u, type PaymentRequirementsExtra as v, type SupportedTokenInfo as w, type X402PaymentEnvelopeV1 as x, type X402PaymentEnvelopeV2 as y, type X402PaymentPayload as z };