@iota/iota-names-sdk/dist/cjs/types.d.ts

IOTA-Names SDK

import { Network } from '@iota/iota-sdk/client';
import { IotaGraphQLClient } from '@iota/iota-sdk/graphql';
import type { TransactionObjectArgument, TransactionObjectInput } from '@iota/iota-sdk/transactions';
import { CouponBcs, CouponHouseBcs } from './bcs';
export interface CoinConfig {
    type: string;
}
export type PackageInfo = {
    adminAddress: string;
    adminCap: string;
    auctionPackageId: VersionedPackageId;
    auctionHouseObjectId: string;
    couponsPackageId: VersionedPackageId;
    iotaNamesObjectId: string;
    packageId: VersionedPackageId;
    paymentsPackageId: VersionedPackageId;
    publisherId: string;
    registryTableId: string;
    reverseRegistryTableId: string;
    subnamesPackageId: VersionedPackageId;
    tempSubnameProxyPackageId: VersionedPackageId;
    upgradeCap: string;
};
export interface NameRecord {
    name: string;
    nftId: string;
    targetAddress: string;
    expirationDate: Date;
    data: Record<string, string>;
    avatar?: string;
}
export type VersionedPackageId = string | {
    [version: string]: string;
};
export type BaseParams = {
    coinConfig?: CoinConfig;
    coin: TransactionObjectInput;
    couponCodes?: string[];
    address?: string;
};
export type RegistrationParams = BaseParams & {
    name: string;
};
export type RegistrationWithYearsParams = RegistrationParams & {
    years: number;
};
export type RenewalParams = BaseParams & {
    name: string;
    nft: TransactionObjectInput;
    years: number;
};
export type ReceiptParams = {
    paymentIntent: TransactionObjectArgument;
    payment: TransactionObjectArgument;
    coinConfig: CoinConfig;
};
export type CouponHouse = typeof CouponHouseBcs.$inferType;
export type Coupon = typeof CouponBcs.$inferType & {
    couponCode: string;
};
export type IotaNamesClientConfig = {
    graphQlClient: IotaGraphQLClient;
} & IotaNamesClientNetworkConfig;
export type IotaNamesClientNetworkConfig = {
    network: Network;
} | {
    packageInfo: PackageInfo;
};
export type IotaNamesPriceList = Map<[number, number], number>;
export type IotaNamesCoreConfig = {
    max_years: number;
};
export type IotaNamesSubnamesConfig = {
    minimum_duration: number;
};