@nktkas/hyperliquid/esm/api/exchange/_methods/finalizeEvmContract.d.ts

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

/// <amd-module name="file:///home/runner/work/hyperliquid/hyperliquid/src/api/exchange/_methods/finalizeEvmContract.ts" />
import * as v from "valibot";
/**
 * Finalize the link between a HyperCore spot token and an ERC-20 contract on the HyperEVM.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/hypercore-less-than-greater-than-hyperevm-transfers
 */
export declare const FinalizeEvmContractRequest: v.ObjectSchema<{
    /** Action to perform. */
    readonly action: v.ObjectSchema<{
        /** Type of action. */
        readonly type: v.LiteralSchema<"finalizeEvmContract", undefined>;
        /** Token identifier to link. */
        readonly token: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
        /**
         * Verification method matching how the EVM contract was deployed:
         * - `{ create: { nonce } }`: contract deployed from an EOA — the EVM user signs with the deploy nonce.
         * - `"firstStorageSlot"`: finalizer address is stored at the contract's first storage slot.
         * - `"customStorageSlot"`: finalizer address is stored at slot `keccak256("HyperCore deployer")`.
         */
        readonly input: v.UnionSchema<[v.ObjectSchema<{
            /** Use the EVM deployment nonce of an EOA-deployed contract. */
            readonly create: v.ObjectSchema<{
                /** Nonce used to deploy the EVM contract. */
                readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
            }, undefined>;
        }, undefined>, v.LiteralSchema<"firstStorageSlot", undefined>, v.LiteralSchema<"customStorageSlot", undefined>], undefined>;
    }, undefined>;
    /** Nonce (timestamp in ms) used to prevent replay attacks. */
    readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
    /** ECDSA signature components. */
    readonly signature: v.ObjectSchema<{
        /** First 32-byte component. */
        readonly r: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>;
        /** Second 32-byte component. */
        readonly s: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>;
        /** Recovery identifier. */
        readonly v: v.PicklistSchema<[27, 28], undefined>;
    }, undefined>;
    /** Expiration time of the action. */
    readonly expiresAfter: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
}, undefined>;
export type FinalizeEvmContractRequest = v.InferOutput<typeof FinalizeEvmContractRequest>;
/**
 * Successful response without specific data or error response.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/hypercore-less-than-greater-than-hyperevm-transfers
 */
export type FinalizeEvmContractResponse = {
    /** Successful status. */
    status: "ok";
    /** Response details. */
    response: {
        /** Type of response. */
        type: "default";
    };
} | {
    /** Error status. */
    status: "err";
    /** Error message. */
    response: string;
};
import { type ExchangeConfig, type ExcludeErrorResponse, type ExtractRequestOptions } from "./_base/mod.js";
/** Schema for action fields (excludes request-level system fields). */
declare const FinalizeEvmContractActionSchema: v.ObjectSchema<{
    /** Type of action. */
    readonly type: v.LiteralSchema<"finalizeEvmContract", undefined>;
    /** Token identifier to link. */
    readonly token: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
    /**
     * Verification method matching how the EVM contract was deployed:
     * - `{ create: { nonce } }`: contract deployed from an EOA — the EVM user signs with the deploy nonce.
     * - `"firstStorageSlot"`: finalizer address is stored at the contract's first storage slot.
     * - `"customStorageSlot"`: finalizer address is stored at slot `keccak256("HyperCore deployer")`.
     */
    readonly input: v.UnionSchema<[v.ObjectSchema<{
        /** Use the EVM deployment nonce of an EOA-deployed contract. */
        readonly create: v.ObjectSchema<{
            /** Nonce used to deploy the EVM contract. */
            readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
        }, undefined>;
    }, undefined>, v.LiteralSchema<"firstStorageSlot", undefined>, v.LiteralSchema<"customStorageSlot", undefined>], undefined>;
}, undefined>;
/** Action parameters for the {@linkcode finalizeEvmContract} function. */
export type FinalizeEvmContractParameters = Omit<v.InferInput<typeof FinalizeEvmContractActionSchema>, "type">;
/** Request options for the {@linkcode finalizeEvmContract} function. */
export type FinalizeEvmContractOptions = ExtractRequestOptions<v.InferInput<typeof FinalizeEvmContractRequest>>;
/** Successful variant of {@linkcode FinalizeEvmContractResponse} without errors. */
export type FinalizeEvmContractSuccessResponse = ExcludeErrorResponse<FinalizeEvmContractResponse>;
/**
 * Finalize the link between a HyperCore spot token and an ERC-20 contract on the HyperEVM.
 *
 * Signing: L1 Action.
 *
 * @param config General configuration for Exchange API requests.
 * @param params Parameters specific to the API request.
 * @param opts Request execution options.
 * @return Successful response without specific data.
 *
 * @throws {ValidationError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 * @throws {ApiRequestError} When the API returns an unsuccessful response.
 *
 * @example Finalize from an EOA-deployed contract
 * ```ts
 * import { HttpTransport } from "@nktkas/hyperliquid";
 * import { finalizeEvmContract } from "@nktkas/hyperliquid/api/exchange";
 * import { privateKeyToAccount } from "npm:viem/accounts";
 *
 * const wallet = privateKeyToAccount("0x..."); // viem or ethers
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * await finalizeEvmContract({ transport, wallet }, {
 *   token: 200,
 *   input: { create: { nonce: 0 } },
 * });
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/hypercore-less-than-greater-than-hyperevm-transfers
 */
export declare function finalizeEvmContract(config: ExchangeConfig, params: FinalizeEvmContractParameters, opts?: FinalizeEvmContractOptions): Promise<FinalizeEvmContractSuccessResponse>;
export {};