bns-v2-sdk/dist/interfaces.d.ts

The official BNS V2 SDK for interacting with Stacks Blockchain

import { ClarityValue, PostCondition } from "@stacks/transactions";
import { NetworkType } from "./config";
export interface ContractCallPayload {
    contractAddress: string;
    contractName: string;
    functionName: string;
    functionArgs: ClarityValue[];
    postConditions: PostCondition[];
    network: NetworkType;
}
export interface PriceFunction {
    base: bigint | string | number;
    coefficient: bigint | string | number;
    b1: bigint | string | number;
    b2: bigint | string | number;
    b3: bigint | string | number;
    b4: bigint | string | number;
    b5: bigint | string | number;
    b6: bigint | string | number;
    b7: bigint | string | number;
    b8: bigint | string | number;
    b9: bigint | string | number;
    b10: bigint | string | number;
    b11: bigint | string | number;
    b12: bigint | string | number;
    b13: bigint | string | number;
    b14: bigint | string | number;
    b15: bigint | string | number;
    b16: bigint | string | number;
    nonAlphaDiscount: bigint | string | number;
    noVowelDiscount: bigint | string | number;
}
export interface BaseTransactionOptions {
    network: NetworkType;
    senderAddress: string;
}
export interface BnsReadOnlyOptions {
    functionName: string;
    functionArgs: ClarityValue[];
    senderAddress: string;
    network: NetworkType;
}
export interface TransferNameOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    newOwnerAddress: string;
}
export interface ListInUstxOptions extends BaseTransactionOptions {
    id: bigint;
    price: bigint;
    commissionTraitAddress: string;
    commissionTraitName: string;
}
export interface UnlistInUstxOptions extends BaseTransactionOptions {
    id: bigint;
}
export interface BuyInUstxOptions extends BaseTransactionOptions {
    id: number;
    expectedPrice: bigint;
    commissionTraitAddress: string;
    commissionTraitName: string;
}
export interface SetPrimaryNameOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
}
export interface FreezeManagerOptions extends BaseTransactionOptions {
    namespace: string;
}
export interface PreorderNamespaceOptions extends BaseTransactionOptions {
    namespace: string;
    salt: string;
    stxToBurn: bigint;
}
export interface RevealNamespaceOptions extends BaseTransactionOptions {
    namespace: string;
    salt: string;
    priceFunction?: PriceFunction;
    lifetime?: bigint;
    namespaceImportAddress: string;
    namespaceManagerAddress?: string;
    canUpdatePrice: boolean;
    managerTransfer?: boolean;
    managerFrozen?: boolean;
}
export interface LaunchNamespaceOptions extends BaseTransactionOptions {
    namespace: string;
}
export interface TurnOffManagerTransfersOptions extends BaseTransactionOptions {
    namespace: string;
}
export interface ImportNameOptions extends BaseTransactionOptions {
    namespace: string;
    name: string;
    beneficiary: string;
}
export interface NamespaceUpdatePriceOptions extends BaseTransactionOptions {
    namespace: string;
    priceFunction: PriceFunction;
}
export interface NamespaceFreezePriceOptions extends BaseTransactionOptions {
    namespace: string;
}
export interface NameFastClaimOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    stxToBurn: number | bigint;
    sendTo: string;
}
export interface PreorderNameOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    salt: string;
    stxToBurn: number | bigint;
}
export interface RegisterNameOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    salt: string;
    stxToBurn: number | bigint;
}
export interface ClaimPreorderOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    salt: string;
    stxToClaim: string;
}
export interface RenewNameOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    stxToBurn: bigint;
}
export interface UpdateZonefileOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    zonefileInputs: ZonefileData | undefined;
}
export interface SubdomainProperties {
    owner: string;
    general?: string;
    twitter?: string;
    url?: string;
    nostr?: string;
    lightning?: string;
    btc?: string;
    bio?: string;
    website?: string;
    pfp?: string;
    name?: string;
    location?: string;
    social?: SocialEntry[];
    addresses?: AddressEntry[];
}
export interface SubdomainMap {
    [name: string]: SubdomainProperties;
}
export interface BaseZonefileData {
    owner: string;
    general: string;
    twitter: string;
    url: string;
    nostr: string;
    lightning: string;
    btc: string;
}
export type ZonefileData = BaseZonefileData & ({
    externalSubdomainFile: string;
    subdomains?: never;
} | {
    externalSubdomainFile?: never;
    subdomains: SubdomainMap;
});
export interface CanRegisterNameOptions {
    fullyQualifiedName: string;
    network: NetworkType;
}
export interface GetLastTokenIdOptions {
    network: NetworkType;
}
export interface GetRenewalHeightOptions {
    fullyQualifiedName: string;
    network: NetworkType;
}
export interface CanResolveNameOptions {
    fullyQualifiedName: string;
    network: NetworkType;
}
export interface GetOwnerOptions {
    fullyQualifiedName: string;
    network: NetworkType;
}
export interface GetOwnerByIdOptions {
    id: number;
    network: NetworkType;
}
export interface GetNamespacePriceOptions {
    namespace: string;
    network: NetworkType;
}
export interface GetNamePriceOptions {
    fullyQualifiedName: string;
    network: NetworkType;
}
export interface CanNamespaceBeRegisteredOptions {
    namespace: string;
    network: NetworkType;
}
export interface GetNamespacePropertiesOptions {
    namespace: string;
    network: NetworkType;
}
export interface GetIdFromBnsOptions {
    fullyQualifiedName: string;
    network: NetworkType;
}
export interface GetBnsFromIdOptions {
    id: bigint;
    network: NetworkType;
}
export interface GetPrimaryNameOptions {
    address: string;
    network: NetworkType;
}
export interface ResolveNameOptions {
    fullyQualifiedName: string;
    network: NetworkType;
}
export interface FetchUserOwnedNamesOptions {
    senderAddress: string;
    network: NetworkType;
}
export interface NamespaceProperties {
    namespace: string;
    properties: {
        "namespace-manager": string | null;
        "manager-transferable": boolean;
        "manager-frozen": boolean;
        "namespace-import": string;
        "revealed-at": bigint | string | number;
        "launched-at": bigint | string | number | null;
        lifetime: bigint | string | number;
        "can-update-price-function": boolean;
        "price-function": PriceFunction;
    };
}
export interface NameInfo {
    owner: string;
    registeredAt: bigint | string | number | null;
    renewalHeight: bigint | string | number;
    stxBurn: bigint | string | number;
    importedAt: bigint | string | number | null;
    preorderedBy: string | null;
    hashedSaltedFqnPreorder: string | null;
}
export interface SocialEntry {
    platform: string;
    username: string;
}
export interface AddressEntry {
    network: string;
    address: string;
    type: string;
}
export interface MetaEntry {
    name: string;
    value: string;
}
export type SubdomainEntry = SubdomainProperties;
export interface NewZonefileData {
    owner: string;
    btc?: string;
    bio?: string;
    website?: string;
    pfp?: string;
    name?: string;
    location?: string;
    social?: SocialEntry[];
    addresses?: AddressEntry[];
    meta?: MetaEntry[];
    subdomains?: SubdomainMap[];
    externalSubdomainsFile?: string;
}
export interface FlexibleUpdateZonefileOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    zonefileData: any;
}
export interface FormattedUpdateZonefileOptions extends BaseTransactionOptions {
    fullyQualifiedName: string;
    zonefileData: NewZonefileData;
}