Dfns TypeScript SDK - v0.8.37
    Preparing search index...

    Type Alias SearchWalletsResponse

    type SearchWalletsResponse = {
        items: {
            assets?: (
                (
                    | { kind: "Native" }
                    | { kind: "Aip21"; metadata: string }
                    | { assetId: string; kind: "Asa" }
                    | { kind: "Cis2"; tokenAddress: string }
                    | { contract: string; kind: (...) | (...) | (...) }
                    | { contract: string; kind: "Erc7984" }
                    | { kind: "Hts"; tokenId: string }
                    | { currency: string; issuer: string; kind: "Iou" }
                    | { instrumentAdmin: string; instrumentId: string; kind: "Cip56" }
                    | { coin: string; kind: (...) | (...) }
                    | { issuanceId: string; kind: "Xls33" }
                    | { assetId: string; kind: "Asset" }
                    | { kind: "Cis7"; tokenId: string }
                    | { assetCode: string; issuer: string; kind: "Sep41" }
                    | { kind: "Trc10"; tokenId: string }
                    | { kind: (...) | (...); mint: string }
                    | { kind: "Tep74"; master: string }
                ) & {
                    balance: string;
                    decimals: number;
                    symbol?: string;
                    verified?: boolean;
                }
            )[];
            matchedAsset?: (
                | { kind: "Native" }
                | { kind: "Aip21"; metadata: string }
                | { assetId: string; kind: "Asa" }
                | { kind: "Cis2"; tokenAddress: string }
                | { contract: string; kind: "Erc20" | "Snip2" | "Trc20" }
                | { contract: string; kind: "Erc7984" }
                | { kind: "Hts"; tokenId: string }
                | { currency: string; issuer: string; kind: "Iou" }
                | { instrumentAdmin: string; instrumentId: string; kind: "Cip56" }
                | { coin: string; kind: "Coin" | "LockedCoin" }
                | { issuanceId: string; kind: "Xls33" }
                | { assetId: string; kind: "Asset" }
                | { kind: "Cis7"; tokenId: string }
                | { assetCode: string; issuer: string; kind: "Sep41" }
                | { kind: "Trc10"; tokenId: string }
                | { kind: "Spl" | "Spl2022"; mint: string }
                | { kind: "Tep74"; master: string }
            ) & {
                balance: string;
                decimals: number;
                symbol?: string;
                verified?: boolean;
            };
            wallet: {
                address?: string;
                custodial: boolean;
                dateCreated: string;
                dateDeleted?: string;
                externalId?: string;
                id: string;
                name?: string;
                network: string
                | "KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark";
                networkInfo?: { nonceAccounts?: string[]; validatorId?: string };
                signingKey: {
                    curve: "ed25519" | "secp256k1" | "stark";
                    delegatedTo?: string;
                    id: string;
                    publicKey: string;
                    scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
                    storeId?: string;
                };
                status: "Active"
                | "Inactive"
                | "Archived";
                tags: string[];
                validatorId?: string;
                vaultId?: string;
            };
        }[];
        nextPageToken?: string;
        partial?: "capped";
    }
    Index
    items: {
        assets?: (
            (
                | { kind: "Native" }
                | { kind: "Aip21"; metadata: string }
                | { assetId: string; kind: "Asa" }
                | { kind: "Cis2"; tokenAddress: string }
                | { contract: string; kind: (...) | (...) | (...) }
                | { contract: string; kind: "Erc7984" }
                | { kind: "Hts"; tokenId: string }
                | { currency: string; issuer: string; kind: "Iou" }
                | { instrumentAdmin: string; instrumentId: string; kind: "Cip56" }
                | { coin: string; kind: (...) | (...) }
                | { issuanceId: string; kind: "Xls33" }
                | { assetId: string; kind: "Asset" }
                | { kind: "Cis7"; tokenId: string }
                | { assetCode: string; issuer: string; kind: "Sep41" }
                | { kind: "Trc10"; tokenId: string }
                | { kind: (...) | (...); mint: string }
                | { kind: "Tep74"; master: string }
            ) & {
                balance: string;
                decimals: number;
                symbol?: string;
                verified?: boolean;
            }
        )[];
        matchedAsset?: (
            | { kind: "Native" }
            | { kind: "Aip21"; metadata: string }
            | { assetId: string; kind: "Asa" }
            | { kind: "Cis2"; tokenAddress: string }
            | { contract: string; kind: "Erc20" | "Snip2" | "Trc20" }
            | { contract: string; kind: "Erc7984" }
            | { kind: "Hts"; tokenId: string }
            | { currency: string; issuer: string; kind: "Iou" }
            | { instrumentAdmin: string; instrumentId: string; kind: "Cip56" }
            | { coin: string; kind: "Coin" | "LockedCoin" }
            | { issuanceId: string; kind: "Xls33" }
            | { assetId: string; kind: "Asset" }
            | { kind: "Cis7"; tokenId: string }
            | { assetCode: string; issuer: string; kind: "Sep41" }
            | { kind: "Trc10"; tokenId: string }
            | { kind: "Spl" | "Spl2022"; mint: string }
            | { kind: "Tep74"; master: string }
        ) & {
            balance: string;
            decimals: number;
            symbol?: string;
            verified?: boolean;
        };
        wallet: {
            address?: string;
            custodial: boolean;
            dateCreated: string;
            dateDeleted?: string;
            externalId?: string;
            id: string;
            name?: string;
            network: string
            | "KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark";
            networkInfo?: { nonceAccounts?: string[]; validatorId?: string };
            signingKey: {
                curve: "ed25519" | "secp256k1" | "stark";
                delegatedTo?: string;
                id: string;
                publicKey: string;
                scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
                storeId?: string;
            };
            status: "Active"
            | "Inactive"
            | "Archived";
            tags: string[];
            validatorId?: string;
            vaultId?: string;
        };
    }[]

    The matches on this page, in result order.

    Type Declaration

    • Optionalassets?: (
          (
              | { kind: "Native" }
              | { kind: "Aip21"; metadata: string }
              | { assetId: string; kind: "Asa" }
              | { kind: "Cis2"; tokenAddress: string }
              | { contract: string; kind: (...) | (...) | (...) }
              | { contract: string; kind: "Erc7984" }
              | { kind: "Hts"; tokenId: string }
              | { currency: string; issuer: string; kind: "Iou" }
              | { instrumentAdmin: string; instrumentId: string; kind: "Cip56" }
              | { coin: string; kind: (...) | (...) }
              | { issuanceId: string; kind: "Xls33" }
              | { assetId: string; kind: "Asset" }
              | { kind: "Cis7"; tokenId: string }
              | { assetCode: string; issuer: string; kind: "Sep41" }
              | { kind: "Trc10"; tokenId: string }
              | { kind: (...) | (...); mint: string }
              | { kind: "Tep74"; master: string }
          ) & {
              balance: string;
              decimals: number;
              symbol?: string;
              verified?: boolean;
          }
      )[]

      Inline assets for the wallet, populated by setting 'includeAssets' to 'native' or 'verified'. The native asset is always included (even at a zero balance); among tokens, only verified ones with a positive balance appear — unverified tokens are never listed. Please contact us to get your token verified if you want it to appear in this list.

    • OptionalmatchedAsset?: (
          | { kind: "Native" }
          | { kind: "Aip21"; metadata: string }
          | { assetId: string; kind: "Asa" }
          | { kind: "Cis2"; tokenAddress: string }
          | { contract: string; kind: "Erc20" | "Snip2" | "Trc20" }
          | { contract: string; kind: "Erc7984" }
          | { kind: "Hts"; tokenId: string }
          | { currency: string; issuer: string; kind: "Iou" }
          | { instrumentAdmin: string; instrumentId: string; kind: "Cip56" }
          | { coin: string; kind: "Coin" | "LockedCoin" }
          | { issuanceId: string; kind: "Xls33" }
          | { assetId: string; kind: "Asset" }
          | { kind: "Cis7"; tokenId: string }
          | { assetCode: string; issuer: string; kind: "Sep41" }
          | { kind: "Trc10"; tokenId: string }
          | { kind: "Spl" | "Spl2022"; mint: string }
          | { kind: "Tep74"; master: string }
      ) & {
          balance: string;
          decimals: number;
          symbol?: string;
          verified?: boolean;
      }

      The asset that matched/ranked this wallet when filters.asset is set. This is always the filtered token, even if it is unverified (and not included in assets).

    • wallet: {
          address?: string;
          custodial: boolean;
          dateCreated: string;
          dateDeleted?: string;
          externalId?: string;
          id: string;
          name?: string;
          network: string | "KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark";
          networkInfo?: { nonceAccounts?: string[]; validatorId?: string };
          signingKey: {
              curve: "ed25519" | "secp256k1" | "stark";
              delegatedTo?: string;
              id: string;
              publicKey: string;
              scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
              storeId?: string;
          };
          status: "Active"
          | "Inactive"
          | "Archived";
          tags: string[];
          validatorId?: string;
          vaultId?: string;
      }
      • Optionaladdress?: string

        Wallet address on its corresponding network.

      • custodial: boolean

        Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial).

      • dateCreated: string

        ISO 8601 date string when wallet was created.

      • OptionaldateDeleted?: string

        ISO 8601 date string when wallet was deleted.

      • OptionalexternalId?: string

        User-defined value that can be used to correlate the entity with an external system.

      • id: string

        ID of the wallet.

      • Optionalname?: string

        Wallet nickname.

      • network: string | "KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark"

        Network this wallet is bound to.

      • OptionalnetworkInfo?: { nonceAccounts?: string[]; validatorId?: string }

        Additional chain-dependent information about the wallet. Only returned by Get Wallet.

        • OptionalnonceAccounts?: string[]

          Confirmed Solana durable-nonce accounts owned by this wallet.

        • OptionalvalidatorId?: string

          Id of the validator on which the wallet is created for Canton networks.

      • signingKey: {
            curve: "ed25519" | "secp256k1" | "stark";
            delegatedTo?: string;
            id: string;
            publicKey: string;
            scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
            storeId?: string;
        }

        Details about the key underlying the wallet.

        • curve: "ed25519" | "secp256k1" | "stark"

          The elliptic curve for the key.

        • OptionaldelegatedTo?: string

          The end user ID the key (and wallet) is delegated to.

        • id: string

          Key id.

        • publicKey: string

          Hex-encoded value of the public key.

        • scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr"

          The cryptographic scheme for the key.

        • OptionalstoreId?: string

          ID of the key store the signing key lives in (see List Key Stores). Use it to tell wallets apart by custody setup, for instance to scope a policy to one store with the keyStoreId policy filter.

      • status: "Active" | "Inactive" | "Archived"

        Wallet status.

      • tags: string[]

        List of tags.

      • OptionalvalidatorId?: string

        use networkInfo.validatorId instead.

      • OptionalvaultId?: string

        The vault controlling this wallet, absent for ordinary wallets. A vault wallet is read-only, its funds move through the vault endpoints, and it carries its vault name and tags as its own.

    nextPageToken?: string

    Present when more results exist. Send it as paginationToken, with the rest of the request unchanged, to get the next page.

    partial?: "capped"

    Present only as 'capped', and only when an internal cap decided what this search could reach. The results are a subset of the matches and paging will end before the real end of the match set. Do not read them as the closest matches: depending on which branch answered, the cap keeps either the alphabetically first matches or an arbitrary sample of them. Absent means the page is complete. Narrow the search with a longer term or one more filter to get an exact answer.