opacity-issuer-core 0.2.1

package/dist/subgraph.d.ts

@@ -0,0 +1,456 @@
+import { Hex, Address } from 'viem';
+import { O as OpacityIssuerError, F as FetchLike } from './transport-0_X4HTI6.js';
+import './types-B4Yi7WA4.js';
+
+type IndexerErrorCode = 'NOT_CONFIGURED' | 'INVALID_ARGUMENT' | 'ABORTED' | 'TIMEOUT' | 'TRANSPORT' | 'HTTP' | 'GRAPHQL' | 'INDEXING_ERROR' | 'INVALID_RESPONSE' | 'DEPLOYMENT_CHANGED' | 'SNAPSHOT_CHANGED';
+/** Indexer failures never represent a failed on-chain transaction. */
+declare class OpacityIndexerError extends OpacityIssuerError {
+    readonly code: IndexerErrorCode;
+    constructor(code: IndexerErrorCode, message: string, options?: {
+        cause?: unknown;
+    });
+}
+
+interface Field<T> {
+    selection?: string;
+    parse(value: unknown, path: string, domain?: boolean): T;
+}
+type Parsed<T> = T extends Field<infer V> ? V : never;
+declare const userRef: Field<{
+    id: `0x${string}`;
+}>;
+declare const metaField: Field<{
+    deployment: string;
+    hasIndexingErrors: boolean;
+    block: {
+        number: bigint;
+        hash: `0x${string}` | null;
+        timestamp: bigint | null;
+    };
+}>;
+declare const tokenField: Field<{
+    id: `0x${string}`;
+    issuer: {
+        id: `0x${string}`;
+    };
+    issuerAdmin: `0x${string}` | null;
+    allowlistRegistry: `0x${string}`;
+    name: string | null;
+    symbol: string | null;
+    paused: boolean;
+    mintingPaused: boolean;
+    policyEngine: `0x${string}` | null;
+    transferOperator: `0x${string}` | null;
+    tokenTraitRegistry: `0x${string}` | null;
+    maxPolicies: bigint | null;
+    activePolicyCount: bigint;
+    activeRuleSetSnapshot: `0x${string}` | null;
+    ruleSetDeploymentCount: bigint;
+    deployedAtBlock: bigint;
+    deployedAtTimestamp: bigint;
+    deployTxHash: `0x${string}`;
+    beaconVariant: {
+        id: `0x${string}`;
+        beacon: `0x${string}`;
+        isActive: boolean;
+    } | null;
+}>;
+declare const supplyField: Field<{
+    id: `0x${string}`;
+    token: {
+        id: `0x${string}`;
+    };
+    tokenId: bigint;
+    totalSupply: bigint;
+    maxSupply: bigint;
+    holderCount: bigint;
+}>;
+declare const policyField: Field<{
+    id: `0x${string}`;
+    token: {
+        id: `0x${string}`;
+    };
+    implementation: {
+        id: `0x${string}`;
+        status: "UNKNOWN" | "PENDING" | "APPROVED" | "REVOKED" | "CANCELLED";
+    };
+    policyType: "TRADING_DISABLED_V1" | "ALLOWED_TRANSFEREE_V1" | "HOLDER_COUNT_CAP_V1" | "CEILING_BALANCE_V1" | "FLOOR_BALANCE_V1" | "DENYLIST_V1" | "INSIDER_FREEZE_V1" | "SELF_TRANSFER_ONLY_V1" | "UNKNOWN";
+    scopeKey: `0x${string}`;
+    active: boolean;
+    rawConfig: `0x${string}`;
+    guardTrait: `0x${string}`;
+    guardMode: "NONE" | "ONLY_IF_FROM_HAS" | "ONLY_IF_TO_HAS" | "ONLY_IF_EITHER_HAS";
+    guardTraitIsGlobal: boolean;
+    configEnabled: boolean | null;
+    configMaxHolders: bigint | null;
+    configIsPercentage: boolean | null;
+    configCeiling: bigint | null;
+    configDenominatorMode: "CURRENT_SUPPLY" | "MAX_SUPPLY" | null;
+    configTraitList: `0x${string}`[] | null;
+    configRequireAll: boolean | null;
+    attachedAtBlock: bigint;
+    lastReconfiguredAtBlock: bigint | null;
+}>;
+declare const entryField: Field<{
+    id: `0x${string}`;
+    status: "VERIFIED" | "COMPLIANCE_REMOVAL" | "USER_REMOVAL" | "MIGRATED";
+    user: {
+        id: `0x${string}`;
+    } | null;
+    expiresAt: bigint | null;
+    addedBy: `0x${string}` | null;
+    migratedTo: `0x${string}` | null;
+    migratedFrom: `0x${string}` | null;
+    lastUpdatedBlock: bigint;
+    lastUpdatedTimestamp: bigint;
+}>;
+declare const accountField: Field<{
+    id: `0x${string}`;
+    isAuthorizedIssuer: boolean;
+    allowlistEntry: {
+        id: `0x${string}`;
+        status: "VERIFIED" | "COMPLIANCE_REMOVAL" | "USER_REMOVAL" | "MIGRATED";
+        user: {
+            id: `0x${string}`;
+        } | null;
+        expiresAt: bigint | null;
+        addedBy: `0x${string}` | null;
+        migratedTo: `0x${string}` | null;
+        migratedFrom: `0x${string}` | null;
+        lastUpdatedBlock: bigint;
+        lastUpdatedTimestamp: bigint;
+    } | null;
+}>;
+declare const globalTraitField: Field<{
+    id: `0x${string}`;
+    user: {
+        id: `0x${string}`;
+    };
+    traitId: `0x${string}`;
+    enabled: boolean;
+    lastUpdatedBy: `0x${string}`;
+    lastUpdatedBlock: bigint;
+    lastUpdatedTimestamp: bigint;
+    traitConfig: {
+        expiryDuration: bigint;
+        teeEnableable: boolean;
+        writerEnableable: boolean;
+    };
+}>;
+declare const tokenTraitField: Field<{
+    id: `0x${string}`;
+    token: {
+        id: `0x${string}`;
+    };
+    user: {
+        id: `0x${string}`;
+    };
+    traitId: `0x${string}`;
+    enabled: boolean;
+    lastUpdatedBlock: bigint;
+    lastUpdatedTimestamp: bigint;
+}>;
+declare const walletBalanceField: Field<{
+    id: `0x${string}`;
+    token: {
+        id: `0x${string}`;
+    };
+    account: {
+        id: `0x${string}`;
+    };
+    tokenId: bigint;
+    balance: bigint;
+    frozenAmount: bigint;
+}>;
+declare const userBalanceField: Field<{
+    id: `0x${string}`;
+    token: {
+        id: `0x${string}`;
+    };
+    user: {
+        id: `0x${string}`;
+    };
+    tokenId: bigint;
+    balance: bigint;
+    openIntervalId: `0x${string}` | null;
+}>;
+declare const transferField: Field<{
+    id: `0x${string}`;
+    token: {
+        id: `0x${string}`;
+    };
+    operator: `0x${string}`;
+    from: {
+        id: `0x${string}`;
+    };
+    to: {
+        id: `0x${string}`;
+    };
+    tokenId: bigint;
+    value: bigint;
+    isBatch: boolean;
+    batchIndex: bigint;
+    blockNumber: bigint;
+    blockTimestamp: bigint;
+    transactionHash: `0x${string}`;
+    logIndex: bigint;
+}>;
+declare const attestationField: Field<{
+    id: `0x${string}`;
+    attestor: {
+        id: `0x${string}`;
+    };
+    document: {
+        id: `0x${string}`;
+    };
+    user: {
+        id: `0x${string}`;
+    };
+    wallet: `0x${string}`;
+    traitId: `0x${string}`;
+    docHash: `0x${string}`;
+    nonce: `0x${string}`;
+    globalTrait: {
+        id: `0x${string}`;
+        enabled: boolean;
+    };
+    blockNumber: bigint;
+    blockTimestamp: bigint;
+    transactionHash: `0x${string}`;
+    logIndex: bigint;
+}>;
+declare const registryField: Field<{
+    id: string;
+    contractAddress: `0x${string}`;
+    paused: boolean;
+    defaultExpiryDuration: bigint | null;
+    authorizedSigner: `0x${string}` | null;
+    teeTraitAllowlistEnforced: boolean;
+}>;
+declare const uriField: Field<{
+    id: `0x${string}`;
+    token: {
+        id: `0x${string}`;
+    };
+    tokenId: bigint;
+    uri: string;
+    lastUpdatedBlock: bigint;
+}>;
+declare const vaultField: Field<{
+    id: `0x${string}`;
+    token: {
+        id: `0x${string}`;
+    };
+    tokenId: bigint;
+    stablecoin: `0x${string}`;
+    firstObservedAtBlock: bigint;
+    firstObservedAtTimestamp: bigint;
+    firstObservedTxHash: `0x${string}`;
+    depositCount: bigint;
+    withdrawalCount: bigint;
+    totalDeposited: bigint;
+    totalWithdrawn: bigint;
+    adminExecutionCount: bigint;
+}>;
+declare const vaultMovementField: Field<{
+    user: {
+        id: `0x${string}`;
+    };
+    amount: bigint;
+    id: `0x${string}`;
+    vault: {
+        id: `0x${string}`;
+    };
+    token: {
+        id: `0x${string}`;
+    };
+    blockNumber: bigint;
+    blockTimestamp: bigint;
+    transactionHash: `0x${string}`;
+}>;
+declare const vaultAdminField: Field<{
+    owner: `0x${string}`;
+    target: `0x${string}`;
+    selector: `0x${string}`;
+    id: `0x${string}`;
+    vault: {
+        id: `0x${string}`;
+    };
+    token: {
+        id: `0x${string}`;
+    };
+    blockNumber: bigint;
+    blockTimestamp: bigint;
+    transactionHash: `0x${string}`;
+}>;
+type IndexerMetadata = Parsed<typeof metaField>;
+type IndexedToken = Parsed<typeof tokenField>;
+type IndexedTokenId = Parsed<typeof supplyField>;
+type IndexedPolicy = Parsed<typeof policyField>;
+type IndexedAccount = Parsed<typeof accountField>;
+type IndexedUser = Parsed<typeof userRef>;
+type IndexedAllowlistEntry = Parsed<typeof entryField>;
+type IndexedGlobalTrait = Parsed<typeof globalTraitField>;
+type IndexedTokenTrait = Parsed<typeof tokenTraitField>;
+type IndexedWalletBalance = Parsed<typeof walletBalanceField>;
+type IndexedUserBalance = Parsed<typeof userBalanceField>;
+type IndexedBalance = IndexedWalletBalance | IndexedUserBalance;
+type IndexedTransfer = Parsed<typeof transferField>;
+type IndexedDocumentAttestation = Parsed<typeof attestationField>;
+type IndexedRegistry = Parsed<typeof registryField>;
+type IndexedTokenURI = Parsed<typeof uriField>;
+/** Event totals are historical activity, not current reserves or redemption liquidity. */
+type IndexedVault = Parsed<typeof vaultField>;
+type IndexedVaultMovement = Parsed<typeof vaultMovementField>;
+type IndexedVaultAdminExecution = Parsed<typeof vaultAdminField>;
+interface IndexerRequestOptions {
+    signal?: AbortSignal;
+    timeoutMs?: number;
+    /** Indexed historical state; Graph Node may prune old blocks. Omit to read its current head. */
+    blockNumber?: bigint;
+    /** Prefer a block hash from getMetadata() to keep a snapshot stable across chain reorgs. */
+    blockHash?: Hex;
+}
+/** Opaque to consumers: reuse unchanged with the same method and filters. */
+interface IndexerCursor {
+    after: Hex;
+    blockNumber: bigint;
+    /** Null when Graph Node did not expose the historical block hash. */
+    blockHash: Hex | null;
+    deployment: string;
+    scope: string;
+}
+interface IndexerPageOptions extends IndexerRequestOptions {
+    /** Default 100; integer 1–999. A further row is fetched to detect continuation. */
+    pageSize?: number;
+    cursor?: IndexerCursor;
+}
+interface IndexedResult<T> {
+    item: T | null;
+    meta: IndexerMetadata;
+}
+interface IndexedPage<T> {
+    items: T[];
+    meta: IndexerMetadata;
+    nextCursor: IndexerCursor | null;
+}
+interface ListIndexedTokensParams extends IndexerPageOptions {
+    issuer?: Address;
+    registry?: Address;
+}
+interface TokenIndexPageParams extends IndexerPageOptions {
+    token: Address;
+}
+interface ListIndexedPoliciesParams extends TokenIndexPageParams {
+    /** Defaults to true. Pass false for detached policies. */
+    active?: boolean;
+}
+interface UserIndexPageParams extends IndexerPageOptions {
+    userId: Hex;
+}
+interface ListIndexedTokenTraitsParams extends UserIndexPageParams {
+    token?: Address;
+}
+interface ListIndexedBalancesParams extends IndexerPageOptions {
+    /** Mutually exclusive with userId. Without either filter, lists wallet balances. */
+    wallet?: Address;
+    userId?: Hex;
+    token?: Address;
+    tokenId?: bigint;
+    /** Defaults to true; false also includes zero balances. */
+    positiveOnly?: boolean;
+}
+interface ListIndexedTransfersParams extends IndexerPageOptions {
+    wallet?: Address;
+    token?: Address;
+    tokenId?: bigint;
+}
+interface ListIndexedDocumentAttestationsParams extends IndexerPageOptions {
+    wallet?: Address;
+    userId?: Hex;
+    traitId?: Hex;
+}
+interface ListIndexedVaultsParams extends IndexerPageOptions {
+    token?: Address;
+}
+interface ListIndexedVaultMovementsParams extends ListIndexedVaultsParams {
+    vault?: Address;
+    wallet?: Address;
+}
+interface ListIndexedVaultAdminExecutionsParams extends ListIndexedVaultsParams {
+    vault?: Address;
+    owner?: Address;
+    target?: Address;
+}
+/**
+ * Event-indexed views, not transaction preflight or live balances. The endpoint defines the
+ * indexed chain/registry; Graph metadata identifies a deployment, not a chain id. Verify that
+ * deployment and token.allowlistRegistry against your intended contract environment.
+ *
+ * Arrays are separate paged queries so traits, token IDs and histories cannot truncate silently.
+ * getUser supplies the identity row; use listUserAccounts/listGlobalTraits/listTokenTraits to
+ * traverse it. A historical attestation does not establish a currently enabled trait.
+ */
+interface OpacityIndexerNamespace {
+    getMetadata(options?: IndexerRequestOptions): Promise<IndexerMetadata>;
+    getRegistry(options?: IndexerRequestOptions): Promise<IndexedResult<IndexedRegistry>>;
+    listTokens(params?: ListIndexedTokensParams): Promise<IndexedPage<IndexedToken>>;
+    getToken(token: Address, options?: IndexerRequestOptions): Promise<IndexedResult<IndexedToken>>;
+    listTokenIds(params: TokenIndexPageParams): Promise<IndexedPage<IndexedTokenId>>;
+    listTokenURIs(params: TokenIndexPageParams): Promise<IndexedPage<IndexedTokenURI>>;
+    listPolicies(params: ListIndexedPoliciesParams): Promise<IndexedPage<IndexedPolicy>>;
+    getAccount(wallet: Address, options?: IndexerRequestOptions): Promise<IndexedResult<IndexedAccount>>;
+    getUser(userId: Hex, options?: IndexerRequestOptions): Promise<IndexedResult<IndexedUser>>;
+    listUserAccounts(params: UserIndexPageParams): Promise<IndexedPage<IndexedAllowlistEntry>>;
+    listGlobalTraits(params: UserIndexPageParams): Promise<IndexedPage<IndexedGlobalTrait>>;
+    listTokenTraits(params: ListIndexedTokenTraitsParams): Promise<IndexedPage<IndexedTokenTrait>>;
+    listBalances(params?: ListIndexedBalancesParams): Promise<IndexedPage<IndexedBalance>>;
+    listTransfers(params?: ListIndexedTransfersParams): Promise<IndexedPage<IndexedTransfer>>;
+    listDocumentAttestations(params?: ListIndexedDocumentAttestationsParams): Promise<IndexedPage<IndexedDocumentAttestation>>;
+    /** Requires the sandbox v3 subgraph schema; includes previously assigned vaults. */
+    getVault(vault: Address, options?: IndexerRequestOptions): Promise<IndexedResult<IndexedVault>>;
+    listVaults(params?: ListIndexedVaultsParams): Promise<IndexedPage<IndexedVault>>;
+    listVaultDeposits(params?: ListIndexedVaultMovementsParams): Promise<IndexedPage<IndexedVaultMovement>>;
+    listVaultWithdrawals(params?: ListIndexedVaultMovementsParams): Promise<IndexedPage<IndexedVaultMovement>>;
+    listVaultAdminExecutions(params?: ListIndexedVaultAdminExecutionsParams): Promise<IndexedPage<IndexedVaultAdminExecution>>;
+}
+/** Separate unauthenticated transport: mobile-api headers and wallet auth never enter this factory. */
+declare function createIndexerNamespace(config: {
+    url?: string | undefined;
+    fetch?: FetchLike;
+    timeoutMs?: number;
+}): OpacityIndexerNamespace;
+/** Validate API-decoded domain values with the same schemas used for direct GraphQL data. */
+declare function validateIndexerOperationResult(operation: keyof OpacityIndexerNamespace, value: unknown, args?: readonly unknown[]): unknown;
+
+type IndexerOperation = keyof OpacityIndexerNamespace;
+/** Named operations only; hosted requests never carry arbitrary GraphQL or upstream URLs. */
+declare const INDEXER_OPERATIONS: readonly IndexerOperation[];
+/** Validate decoded arguments for both direct clients and API adapters without changing defaults. */
+declare function validateIndexerOperationArgs(operation: IndexerOperation, args: unknown): unknown[];
+
+type WireValue = null | boolean | number | string | WireValue[] | {
+    [key: string]: WireValue;
+};
+/** Lossless JSON encoding. The reserved __bigint marker must contain only a decimal integer. */
+declare function encodeWireValue(value: unknown): WireValue;
+/** Decode only the reserved marker; ordinary decimal strings remain strings. */
+declare function decodeWireValue(value: unknown): unknown;
+
+interface SubgraphRequestOptions {
+    signal?: AbortSignal;
+    timeoutMs?: number;
+}
+interface SubgraphClientConfig {
+    url: string;
+    fetch?: FetchLike;
+    timeoutMs?: number;
+    headers?: Record<string, string>;
+}
+interface SubgraphClient {
+    query<T>(query: string, variables?: Record<string, unknown>, options?: SubgraphRequestOptions): Promise<T>;
+}
+/** Direct GraphQL adapter for trusted applications that own their endpoint configuration. */
+declare function createSubgraphClient(config: SubgraphClientConfig): SubgraphClient;
+
+export { INDEXER_OPERATIONS, type IndexedAccount, type IndexedAllowlistEntry, type IndexedBalance, type IndexedDocumentAttestation, type IndexedGlobalTrait, type IndexedPage, type IndexedPolicy, type IndexedRegistry, type IndexedResult, type IndexedToken, type IndexedTokenId, type IndexedTokenTrait, type IndexedTokenURI, type IndexedTransfer, type IndexedUser, type IndexedUserBalance, type IndexedVault, type IndexedVaultAdminExecution, type IndexedVaultMovement, type IndexedWalletBalance, type IndexerCursor, type IndexerErrorCode, type IndexerMetadata, type IndexerOperation, type IndexerPageOptions, type IndexerRequestOptions, type ListIndexedBalancesParams, type ListIndexedDocumentAttestationsParams, type ListIndexedPoliciesParams, type ListIndexedTokenTraitsParams, type ListIndexedTokensParams, type ListIndexedTransfersParams, type ListIndexedVaultAdminExecutionsParams, type ListIndexedVaultMovementsParams, type ListIndexedVaultsParams, OpacityIndexerError, type OpacityIndexerNamespace, type SubgraphClient, type SubgraphClientConfig, type SubgraphRequestOptions, type TokenIndexPageParams, type UserIndexPageParams, type WireValue, createIndexerNamespace, createSubgraphClient, decodeWireValue, encodeWireValue, validateIndexerOperationArgs, validateIndexerOperationResult };