UNPKG

bns-v2-sdk

Version:

The official BNS V2 SDK for interacting with Stacks Blockchain

38 lines (37 loc) 2.99 kB
import { CanNamespaceBeRegisteredOptions, CanRegisterNameOptions, CanResolveNameOptions, FetchUserOwnedNamesOptions, GetBnsFromIdOptions, GetIdFromBnsOptions, GetLastTokenIdOptions, GetNamePriceOptions, GetNamespacePriceOptions, GetNamespacePropertiesOptions, GetOwnerOptions, GetPrimaryNameOptions, GetRenewalHeightOptions, NamespaceProperties, NameInfo, ResolveNameOptions, ZonefileData, GetOwnerByIdOptions, NewZonefileData } from "./interfaces"; export declare function getNameTradingStatus({ fullyQualifiedName, network, }: CanRegisterNameOptions): Promise<{ canTrade: boolean; isValid: boolean; isRevoked: boolean; reason?: string; }>; export declare function getLastTokenId({ network, }: GetLastTokenIdOptions): Promise<bigint | string | number>; export declare function getRenewalHeight({ fullyQualifiedName, network, }: GetRenewalHeightOptions): Promise<bigint | string | number>; export declare function canResolveName({ fullyQualifiedName, network, }: CanResolveNameOptions): Promise<{ renewal: bigint | string | number; owner: string; }>; export declare function getOwner({ fullyQualifiedName, network, }: GetOwnerOptions): Promise<string | null>; export declare function getOwnerById({ id, network, }: GetOwnerByIdOptions): Promise<string | null>; export declare function getIdFromBns({ fullyQualifiedName, network, }: GetIdFromBnsOptions): Promise<bigint | string | number>; export declare function getBnsFromId({ id, network, }: GetBnsFromIdOptions): Promise<{ name: string; namespace: string; } | null>; export declare function canRegisterName({ fullyQualifiedName, network, }: CanRegisterNameOptions): Promise<boolean>; export declare function getNamespacePrice({ namespace, network, }: GetNamespacePriceOptions): Promise<bigint | string | number>; export declare function getNamePrice({ fullyQualifiedName, network, }: GetNamePriceOptions): Promise<bigint | string | number>; export declare function canNamespaceBeRegistered({ namespace, network, }: CanNamespaceBeRegisteredOptions): Promise<boolean>; export declare function getNamespaceProperties({ namespace, network, }: GetNamespacePropertiesOptions): Promise<NamespaceProperties>; export declare function getNameInfo({ fullyQualifiedName, network, }: CanRegisterNameOptions): Promise<NameInfo>; export declare function getPrimaryName({ address, network, }: GetPrimaryNameOptions): Promise<{ name: string; namespace: string; } | null>; export declare function fetchUserOwnedNames({ senderAddress, network, }: FetchUserOwnedNamesOptions): Promise<Array<{ name: string; namespace: string; }>>; export declare function resolveNameZonefile({ fullyQualifiedName, network, }: ResolveNameOptions): Promise<ZonefileData | null>; export declare function getZonefileRaw({ fullyQualifiedName, network, }: ResolveNameOptions): Promise<any | null>; export declare function getZonefileProfile({ fullyQualifiedName, network, }: ResolveNameOptions): Promise<NewZonefileData | null>;