@vleap/warps 3.0.0-alpha.8 → 3.0.0-alpha.81

package/dist/index.d.mts

@@ -1,596 +0,0 @@
-import { Transaction, TransactionOnNetwork, Address, TokenTransfer as TokenTransfer$1, AbiRegistry, NetworkEntrypoint } from '@multiversx/sdk-core';
-import { TypedValue, Type, OptionValue, OptionalValue, List, VariadicValue, CompositeValue, StringValue, U8Value, U16Value, U32Value, U64Value, BigUIntValue, BooleanValue, AddressValue, TokenIdentifierValue, BytesValue, TokenTransfer, Struct, CodeMetadataValue, NothingValue, Transaction as Transaction$1, Address as Address$1 } from '@multiversx/sdk-core/out';
-import QRCodeStyling from 'qr-code-styling';
-
-declare const CacheTtl: {
-    OneMinute: number;
-    OneHour: number;
-    OneDay: number;
-    OneWeek: number;
-    OneMonth: number;
-    OneYear: number;
-};
-declare const CacheKey: {
-    Warp: (id: string) => string;
-    WarpAbi: (id: string) => string;
-    LastWarpExecutionInputs: (id: string, action: number) => string;
-    RegistryInfo: (id: string) => string;
-    Brand: (hash: string) => string;
-    ChainInfo: (chain: WarpChain) => string;
-    ChainInfos: () => string;
-};
-type CacheType = 'memory' | 'localStorage';
-declare class WarpCache {
-    private strategy;
-    constructor(type?: CacheType);
-    private selectStrategy;
-    set<T>(key: string, value: T, ttl: number): void;
-    get<T>(key: string): T | null;
-    forget(key: string): void;
-    clear(): void;
-}
-
-type WarpChainEnv = 'mainnet' | 'testnet' | 'devnet';
-type ProtocolName = 'warp' | 'brand' | 'abi';
-
-type WarpChain = string;
-type WarpInitConfig = {
-    env: WarpChainEnv;
-    clientUrl?: string;
-    currentUrl?: string;
-    vars?: Record<string, string | number>;
-    user?: {
-        wallet?: string;
-    };
-    schema?: {
-        warp?: string;
-        brand?: string;
-    };
-    cache?: {
-        ttl?: number;
-        type?: CacheType;
-    };
-    registry?: {
-        contract?: string;
-    };
-    index?: {
-        url?: string;
-        apiKey?: string;
-        searchParamName?: string;
-    };
-};
-type WarpCacheConfig = {
-    ttl?: number;
-};
-type WarpChainInfo = {
-    name: WarpChain;
-    displayName: string;
-    chainId: string;
-    blockTime: number;
-    addressHrp: string;
-    apiUrl: string;
-    explorerUrl: string;
-};
-type WarpIdType = 'hash' | 'alias';
-type WarpVarPlaceholder = string;
-type WarpResultName = string;
-type WarpResulutionPath = string;
-type WarpMessageName = string;
-type Warp = {
-    protocol: string;
-    name: string;
-    title: string;
-    description: string | null;
-    bot?: string;
-    preview?: string;
-    vars?: Record<WarpVarPlaceholder, string>;
-    actions: WarpAction[];
-    next?: string;
-    results?: Record<WarpResultName, WarpResulutionPath>;
-    messages?: Record<WarpMessageName, string>;
-    meta?: WarpMeta;
-};
-type WarpMeta = {
-    hash: string;
-    creator: string;
-    createdAt: string;
-};
-type WarpAction = WarpTransferAction | WarpContractAction | WarpQueryAction | WarpCollectAction | WarpLinkAction;
-type WarpActionType = 'transfer' | 'contract' | 'query' | 'collect' | 'link';
-type WarpTransferAction = {
-    type: WarpActionType;
-    chain?: WarpChain;
-    label: string;
-    description?: string | null;
-    address?: string;
-    data?: string;
-    value?: string;
-    transfers?: WarpContractActionTransfer[];
-    inputs?: WarpActionInput[];
-    next?: string;
-};
-type WarpContractAction = {
-    type: WarpActionType;
-    chain?: WarpChain;
-    label: string;
-    description?: string | null;
-    address: string;
-    func: string | null;
-    args: string[];
-    value?: string;
-    gasLimit: number;
-    transfers?: WarpContractActionTransfer[];
-    abi?: string;
-    inputs?: WarpActionInput[];
-    next?: string;
-};
-type WarpContractActionTransfer = {
-    token: string;
-    nonce?: number;
-    amount?: string;
-};
-type WarpQueryAction = {
-    type: WarpActionType;
-    chain?: WarpChain;
-    label: string;
-    description?: string | null;
-    address: string;
-    func: string;
-    args: string[];
-    abi?: string;
-    inputs?: WarpActionInput[];
-    next?: string;
-};
-type WarpCollectAction = {
-    type: WarpActionType;
-    chain?: WarpChain;
-    label: string;
-    description?: string | null;
-    destination: {
-        url: string;
-        method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
-        headers?: Record<string, string>;
-    };
-    inputs?: WarpActionInput[];
-    next?: string;
-};
-type WarpLinkAction = {
-    type: WarpActionType;
-    chain?: WarpChain;
-    label: string;
-    description?: string | null;
-    url: string;
-    inputs?: WarpActionInput[];
-};
-type WarpActionInputSource = 'field' | 'query' | 'user:wallet';
-type BaseWarpActionInputType = 'string' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'biguint' | 'bool' | 'address' | 'token' | 'codemeta' | 'hex' | 'esdt' | 'nft';
-type WarpActionInputType = string;
-type WarpActionInputPosition = 'receiver' | 'value' | 'transfer' | `arg:${1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10}` | 'data';
-type WarpActionInputModifier = 'scale';
-type WarpActionInput = {
-    name: string;
-    as?: string;
-    description?: string | null;
-    bot?: string;
-    type: WarpActionInputType;
-    position?: WarpActionInputPosition;
-    source: WarpActionInputSource;
-    required?: boolean;
-    min?: number | WarpVarPlaceholder;
-    max?: number | WarpVarPlaceholder;
-    pattern?: string;
-    patternDescription?: string;
-    options?: string[] | {
-        [key: string]: string;
-    };
-    modifier?: string;
-};
-type ResolvedInput = {
-    input: WarpActionInput;
-    value: string | null;
-};
-type WarpContract = {
-    address: string;
-    owner: string;
-    verified: boolean;
-};
-type WarpContractVerification = {
-    codeHash: string;
-    abi: object;
-};
-
-type WarpWarpAbi = {
-    protocol: string;
-    content: WarpAbiContents;
-    meta?: WarpMeta;
-};
-type WarpAbiContents = {
-    name?: string;
-    constructor?: any;
-    upgradeConstructor?: any;
-    endpoints?: any[];
-    types?: Record<string, any>;
-    events?: any[];
-};
-
-type Brand = {
-    protocol: string;
-    name: string;
-    description: string;
-    logo: string;
-    urls?: BrandUrls;
-    colors?: BrandColors;
-    cta?: BrandCta;
-    meta?: BrandMeta;
-};
-type BrandUrls = {
-    web?: string;
-};
-type BrandColors = {
-    primary?: string;
-    secondary?: string;
-};
-type BrandCta = {
-    title: string;
-    description: string;
-    label: string;
-    url: string;
-};
-type BrandMeta = {
-    hash: string;
-    creator: string;
-    createdAt: string;
-};
-
-type WarpTrustStatus = 'unverified' | 'verified' | 'blacklisted';
-type WarpRegistryInfo = {
-    hash: string;
-    alias: string | null;
-    trust: WarpTrustStatus;
-    owner: string;
-    createdAt: number;
-    upgradedAt: number;
-    brand: string | null;
-    upgrade: string | null;
-};
-type WarpRegistryConfigInfo = {
-    unitPrice: bigint;
-    admins: string[];
-};
-
-type WarpExecution = {
-    success: boolean;
-    warp: Warp;
-    action: number;
-    user: string | null;
-    txHash: string | null;
-    next: WarpExecutionNextInfo | null;
-    values: any[];
-    results: WarpExecutionResults;
-    messages: WarpExecutionMessages;
-};
-type WarpExecutionNextInfo = {
-    identifier: string | null;
-    url: string;
-}[];
-type WarpExecutionResults = Record<WarpResultName, any | null>;
-type WarpExecutionMessages = Record<WarpMessageName, string | null>;
-
-type WarpSearchResult = {
-    hits: WarpSearchHit[];
-};
-type WarpSearchHit = {
-    hash: string;
-    alias: string;
-    name: string;
-    title: string;
-    description: string;
-    preview: string;
-    status: string;
-    category: string;
-    featured: boolean;
-};
-
-declare class BrandBuilder {
-    private config;
-    private pendingBrand;
-    constructor(config: WarpInitConfig);
-    createInscriptionTransaction(brand: Brand): Transaction;
-    createFromRaw(encoded: string, validateSchema?: boolean): Promise<Brand>;
-    createFromTransaction(tx: TransactionOnNetwork, validateSchema?: boolean): Promise<Brand>;
-    createFromTransactionHash(hash: string): Promise<Brand | null>;
-    setName(name: string): BrandBuilder;
-    setDescription(description: string): BrandBuilder;
-    setLogo(logo: string): BrandBuilder;
-    setUrls(urls: BrandUrls): BrandBuilder;
-    setColors(colors: BrandColors): BrandBuilder;
-    setCta(cta: BrandCta): BrandBuilder;
-    build(): Promise<Brand>;
-    private ensure;
-    private ensureValidSchema;
-}
-
-declare const WarpProtocolVersions: {
-    Warp: string;
-    Brand: string;
-    Abi: string;
-};
-declare const WarpConfig: {
-    LatestWarpSchemaUrl: string;
-    LatestBrandSchemaUrl: string;
-    DefaultClientUrl: (env: WarpChainEnv) => "https://usewarp.to" | "https://testnet.usewarp.to" | "https://devnet.usewarp.to";
-    SuperClientUrls: string[];
-    MainChain: {
-        Name: string;
-        DisplayName: string;
-        ApiUrl: (env: WarpChainEnv) => "https://devnet-api.multiversx.com" | "https://testnet-api.multiversx.com" | "https://api.multiversx.com";
-        ExplorerUrl: (env: WarpChainEnv) => "https://devnet-explorer.multiversx.com" | "https://testnet-explorer.multiversx.com" | "https://explorer.multiversx.com";
-        BlockTime: (env: WarpChainEnv) => number;
-        AddressHrp: string;
-        ChainId: (env: WarpChainEnv) => "D" | "T" | "1";
-    };
-    Registry: {
-        Contract: (env: WarpChainEnv) => "erd1qqqqqqqqqqqqqpgqje2f99vr6r7sk54thg03c9suzcvwr4nfl3tsfkdl36" | "####" | "erd1qqqqqqqqqqqqqpgq3mrpj3u6q7tejv6d7eqhnyd27n9v5c5tl3ts08mffe";
-    };
-    AvailableActionInputSources: WarpActionInputSource[];
-    AvailableActionInputTypes: WarpActionInputType[];
-    AvailableActionInputPositions: WarpActionInputPosition[];
-};
-
-type InterpolationBag = {
-    config: WarpInitConfig;
-    chain: WarpChainInfo;
-};
-declare class WarpInterpolator {
-    static apply(config: WarpInitConfig, warp: Warp): Promise<Warp>;
-    static applyGlobals(config: WarpInitConfig, warp: Warp): Promise<Warp>;
-    static applyVars(config: WarpInitConfig, warp: Warp): Warp;
-    private static applyRootGlobals;
-    private static applyActionGlobals;
-}
-
-declare const WarpConstants: {
-    HttpProtocolPrefix: string;
-    IdentifierParamName: string;
-    IdentifierParamSeparator: string;
-    IdentifierType: {
-        Alias: string;
-        Hash: string;
-    };
-    Source: {
-        UserWallet: string;
-    };
-    Globals: {
-        UserWallet: {
-            Placeholder: string;
-            Accessor: (bag: InterpolationBag) => string | undefined;
-        };
-        ChainApiUrl: {
-            Placeholder: string;
-            Accessor: (bag: InterpolationBag) => string;
-        };
-        ChainExplorerUrl: {
-            Placeholder: string;
-            Accessor: (bag: InterpolationBag) => string;
-        };
-    };
-    Vars: {
-        Query: string;
-        Env: string;
-    };
-    ArgParamsSeparator: string;
-    ArgCompositeSeparator: string;
-    Transform: {
-        Prefix: string;
-    };
-    Egld: {
-        Identifier: string;
-        EsdtIdentifier: string;
-        DisplayName: string;
-        Decimals: number;
-    };
-};
-
-declare const getMainChainInfo: (config: WarpInitConfig) => WarpChainInfo;
-declare const getChainExplorerUrl: (chain: WarpChainInfo, path?: string) => string;
-declare const getLatestProtocolIdentifier: (name: ProtocolName) => string;
-declare const getWarpActionByIndex: (warp: Warp, index: number) => WarpAction;
-declare const toTypedChainInfo: (chainInfo: any) => WarpChainInfo;
-declare const shiftBigintBy: (value: bigint | string, decimals: number) => bigint;
-declare const toPreviewText: (text: string, maxChars?: number) => string;
-declare const replacePlaceholders: (message: string, bag: Record<string, any>) => string;
-
-declare const option: (value: TypedValue | null, type?: Type) => OptionValue;
-declare const optional: (value: TypedValue | null, type?: Type) => OptionalValue;
-declare const list: (values: TypedValue[]) => List;
-declare const variadic: (values: TypedValue[]) => VariadicValue;
-declare const composite: (values: TypedValue[]) => CompositeValue;
-declare const string: (value: string) => StringValue;
-declare const u8: (value: number) => U8Value;
-declare const u16: (value: number) => U16Value;
-declare const u32: (value: number) => U32Value;
-declare const u64: (value: bigint) => U64Value;
-declare const biguint: (value: bigint | string | number) => BigUIntValue;
-declare const boolean: (value: boolean) => BooleanValue;
-declare const address: (value: string) => AddressValue;
-declare const token: (value: string) => TokenIdentifierValue;
-declare const hex: (value: string) => BytesValue;
-declare const esdt: (value: TokenTransfer) => Struct;
-declare const codemeta: (hexString: string) => CodeMetadataValue;
-declare const nothing: () => NothingValue;
-
-declare class WarpAbiBuilder {
-    private config;
-    private cache;
-    constructor(config: WarpInitConfig);
-    createInscriptionTransaction(abi: WarpAbiContents): Transaction;
-    createFromRaw(encoded: string): Promise<WarpWarpAbi>;
-    createFromTransaction(tx: TransactionOnNetwork): Promise<WarpWarpAbi>;
-    createFromTransactionHash(hash: string, cache?: WarpCacheConfig): Promise<WarpWarpAbi | null>;
-}
-
-type TxComponents = {
-    destination: Address;
-    args: string[];
-    value: bigint;
-    transfers: TokenTransfer$1[];
-    data: Buffer | null;
-    resolvedInputs: ResolvedInput[];
-};
-declare class WarpActionExecutor {
-    private config;
-    private url;
-    private serializer;
-    private contractLoader;
-    private cache;
-    constructor(config: WarpInitConfig);
-    createTransactionForExecute(warp: Warp, actionIndex: number, inputs: string[]): Promise<Transaction>;
-    getTransactionExecutionResults(warp: Warp, actionIndex: number, tx: TransactionOnNetwork): Promise<WarpExecution>;
-    executeQuery(warp: Warp, actionIndex: number, inputs: string[]): Promise<WarpExecution>;
-    executeCollect(warp: Warp, actionIndex: number, inputs: string[], meta?: Record<string, any>): Promise<WarpExecution>;
-    getTxComponentsFromInputs(chain: WarpChainInfo, action: WarpTransferAction | WarpContractAction | WarpQueryAction, inputs: string[], sender?: Address): Promise<TxComponents>;
-    getResolvedInputs(chain: WarpChainInfo, action: WarpAction, inputArgs: string[]): Promise<ResolvedInput[]>;
-    getModifiedInputs(inputs: ResolvedInput[]): ResolvedInput[];
-    preprocessInput(chain: WarpChainInfo, input: string): Promise<string>;
-    getAbiForAction(action: WarpContractAction | WarpQueryAction): Promise<AbiRegistry>;
-    private getPreparedArgs;
-    private getPreparedMessages;
-    private fetchAbi;
-    private toTypedTransfer;
-}
-
-type WarpNativeValue = string | number | bigint | boolean | null | TokenTransfer | WarpNativeValue[];
-declare class WarpArgSerializer {
-    nativeToString(type: WarpActionInputType, value: WarpNativeValue): string;
-    typedToString(value: TypedValue): string;
-    typedToNative(value: TypedValue): [WarpActionInputType, WarpNativeValue];
-    nativeToTyped(type: WarpActionInputType, value: WarpNativeValue): TypedValue;
-    nativeToType(type: BaseWarpActionInputType): Type;
-    stringToNative(value: string): [WarpActionInputType, WarpNativeValue];
-    stringToTyped(value: string): TypedValue;
-    typeToString(type: Type): WarpActionInputType;
-}
-
-declare class WarpBuilder {
-    private config;
-    private cache;
-    private pendingWarp;
-    constructor(config: WarpInitConfig);
-    createInscriptionTransaction(warp: Warp): Transaction;
-    createFromRaw(encoded: string, validate?: boolean): Promise<Warp>;
-    createFromTransaction(tx: TransactionOnNetwork, validate?: boolean): Promise<Warp>;
-    createFromTransactionHash(hash: string, cache?: WarpCacheConfig): Promise<Warp | null>;
-    setName(name: string): WarpBuilder;
-    setTitle(title: string): WarpBuilder;
-    setDescription(description: string): WarpBuilder;
-    setPreview(preview: string): WarpBuilder;
-    setActions(actions: WarpAction[]): WarpBuilder;
-    addAction(action: WarpAction): WarpBuilder;
-    build(): Promise<Warp>;
-    getDescriptionPreview(description: string, maxChars?: number): string;
-    private ensure;
-    private validate;
-}
-
-declare class WarpContractLoader {
-    private readonly config;
-    constructor(config: WarpInitConfig);
-    getContract(address: string, chain: WarpChainInfo): Promise<WarpContract | null>;
-    getVerificationInfo(address: string, chain: WarpChainInfo): Promise<WarpContractVerification | null>;
-}
-
-declare class WarpIndex {
-    private config;
-    constructor(config: WarpInitConfig);
-    search(query: string, params?: Record<string, any>, headers?: Record<string, string>): Promise<WarpSearchHit[]>;
-}
-
-type DetectionResult = {
-    match: boolean;
-    url: string;
-    warp: Warp | null;
-    registryInfo: WarpRegistryInfo | null;
-    brand: Brand | null;
-};
-type DetectionResultFromHtml = {
-    match: boolean;
-    results: {
-        url: string;
-        warp: Warp;
-    }[];
-};
-declare class WarpLink {
-    private config;
-    constructor(config: WarpInitConfig);
-    isValid(url: string): boolean;
-    detectFromHtml(content: string): Promise<DetectionResultFromHtml>;
-    detect(url: string, cache?: WarpCacheConfig): Promise<DetectionResult>;
-    build(type: WarpIdType, id: string): string;
-    buildFromPrefixedIdentifier(prefixedIdentifier: string): string;
-    generateQrCode(type: WarpIdType, id: string, size?: number, background?: string, color?: string, logoColor?: string): QRCodeStyling;
-    private extractIdentifierInfoFromUrl;
-}
-
-declare class WarpRegistry {
-    private config;
-    private cache;
-    registryConfig: WarpRegistryConfigInfo;
-    constructor(config: WarpInitConfig);
-    init(): Promise<void>;
-    createWarpRegisterTransaction(txHash: string, alias?: string | null, brand?: string | null): Transaction$1;
-    createWarpUnregisterTransaction(txHash: string): Transaction$1;
-    createWarpUpgradeTransaction(alias: string, txHash: string): Transaction$1;
-    createWarpAliasSetTransaction(txHash: string, alias: string): Transaction$1;
-    createWarpVerifyTransaction(txHash: string): Transaction$1;
-    createWarpTransferOwnershipTransaction(txHash: string, newOwner: string): Transaction$1;
-    createBrandRegisterTransaction(txHash: string): Transaction$1;
-    createWarpBrandingTransaction(warpHash: string, brandHash: string): Transaction$1;
-    getInfoByAlias(alias: string, cache?: WarpCacheConfig): Promise<{
-        registryInfo: WarpRegistryInfo | null;
-        brand: Brand | null;
-    }>;
-    getInfoByHash(hash: string, cache?: WarpCacheConfig): Promise<{
-        registryInfo: WarpRegistryInfo | null;
-        brand: Brand | null;
-    }>;
-    getUserWarpRegistryInfos(user?: string): Promise<WarpRegistryInfo[]>;
-    getUserBrands(user?: string): Promise<Brand[]>;
-    getChainInfos(cache?: WarpCacheConfig): Promise<WarpChainInfo[]>;
-    getChainInfo(chain: WarpChain, cache?: WarpCacheConfig): Promise<WarpChainInfo | null>;
-    fetchBrand(hash: string, cache?: WarpCacheConfig): Promise<Brand | null>;
-    getRegistryContractAddress(): Address$1;
-    private loadRegistryConfigs;
-    private getFactory;
-    private getController;
-    private isCurrentUserAdmin;
-}
-
-declare class WarpUtils {
-    static getInfoFromPrefixedIdentifier(prefixedIdentifier: string): {
-        type: WarpIdType;
-        identifier: string;
-        identifierBase: string;
-    } | null;
-    static getNextInfo(config: WarpInitConfig, warp: Warp, actionIndex: number, results: WarpExecutionResults): WarpExecutionNextInfo | null;
-    private static buildNextUrl;
-    private static getNestedValue;
-    static getChainInfoForAction(config: WarpInitConfig, action: WarpAction): Promise<WarpChainInfo>;
-    static getChainEntrypoint(chainInfo: WarpChainInfo, env: WarpChainEnv): NetworkEntrypoint;
-}
-
-type ValidationResult = {
-    valid: boolean;
-    errors: ValidationError[];
-};
-type ValidationError = string;
-declare class WarpValidator {
-    private config;
-    constructor(config: WarpInitConfig);
-    validate(warp: Warp): Promise<ValidationResult>;
-    private validateMaxOneValuePosition;
-    private validateVariableNamesAndResultNamesUppercase;
-    private validateAbiIsSetIfApplicable;
-    private validateSchema;
-}
-
-export { type BaseWarpActionInputType, type Brand, BrandBuilder, type BrandColors, type BrandCta, type BrandMeta, type BrandUrls, CacheKey, CacheTtl, type CacheType, type InterpolationBag, type ProtocolName, type ResolvedInput, type Warp, WarpAbiBuilder, type WarpAbiContents, type WarpAction, WarpActionExecutor, type WarpActionInput, type WarpActionInputModifier, type WarpActionInputPosition, type WarpActionInputSource, type WarpActionInputType, type WarpActionType, WarpArgSerializer, WarpBuilder, WarpCache, type WarpCacheConfig, type WarpChain, type WarpChainEnv, type WarpChainInfo, type WarpCollectAction, WarpConfig, WarpConstants, type WarpContract, type WarpContractAction, type WarpContractActionTransfer, WarpContractLoader, type WarpContractVerification, type WarpExecution, type WarpExecutionMessages, type WarpExecutionNextInfo, type WarpExecutionResults, type WarpIdType, WarpIndex, type WarpInitConfig, WarpInterpolator, WarpLink, type WarpLinkAction, type WarpMessageName, type WarpMeta, type WarpNativeValue, WarpProtocolVersions, type WarpQueryAction, WarpRegistry, type WarpRegistryConfigInfo, type WarpRegistryInfo, type WarpResultName, type WarpResulutionPath, type WarpSearchHit, type WarpSearchResult, type WarpTransferAction, type WarpTrustStatus, WarpUtils, WarpValidator, type WarpVarPlaceholder, type WarpWarpAbi, address, biguint, boolean, codemeta, composite, esdt, getChainExplorerUrl, getLatestProtocolIdentifier, getMainChainInfo, getWarpActionByIndex, hex, list, nothing, option, optional, replacePlaceholders, shiftBigintBy, string, toPreviewText, toTypedChainInfo, token, u16, u32, u64, u8, variadic };