@neynar/nodejs-sdk/build/api/apis/onchain-api.d.ts

SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)

/**
 * Neynar API
 * The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
 *
 * The version of the OpenAPI document: 3.115.0
 * Contact: team@neynar.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { BalanceResponse } from '../models';
import type { CreateX402Signature200Response } from '../models';
import type { CreateX402SignatureRequest } from '../models';
import type { DeployFungibleResponse } from '../models';
import type { FetchFungibleTrades200Response } from '../models';
import type { FetchTrendingFungibles200Response } from '../models';
import type { FungiblesResponseSchema } from '../models';
import type { MintNft200Response } from '../models';
import type { MintNftRequest } from '../models';
import type { RegisterUserOnChainReqBody } from '../models';
import type { RegisterUserOnChainResponse } from '../models';
import type { RelevantFungibleOwnersResponse } from '../models';
import type { SimulateNftMintResponse } from '../models';
import type { TransactionSendFungiblesReqBody } from '../models';
import type { TransactionSendFungiblesResponse } from '../models';
/**
 * OnchainApi - axios parameter creator
 * @export
 */
export declare const OnchainApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Create a signature for a given x402 resource using the specified wallet.
     * @summary Create x402 signature
     * @param {string} xWalletId Wallet ID to use for transactions
     * @param {string} xApiKey
     * @param {CreateX402SignatureRequest} createX402SignatureRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<CreateX402Signature200Response>} A promise that resolves to a `CreateX402Signature200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-x402-signature)
     *
     */
    createX402Signature: (xWalletId: string, xApiKey: string, createX402SignatureRequest: CreateX402SignatureRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Creates a new token. This is an allowlisted API, reach out if you want access.
     * @summary Deploy fungible
     * @param {string} owner Ethereum address of the one who is creating the token
     * @param {string} symbol Symbol/Ticker for the token
     * @param {string} name Name of the token
     * @param {File | null} [metadataMedia] Media file associated with the token.  Supported formats are image/jpeg, image/gif and image/png
     * @param {string} [metadataDescription] Description of the token
     * @param {DeployFungibleMetadataNsfwEnum} [metadataNsfw] Indicates if the token is NSFW (Not Safe For Work).
     * @param {string} [metadataWebsiteLink] Website link related to the token
     * @param {string} [metadataTwitter] Twitter profile link
     * @param {string} [metadataDiscord] Discord server link
     * @param {string} [metadataTelegram] Telegram link
     * @param {DeployFungibleNetworkEnum} [network] Network/Chain name
     * @param {DeployFungibleFactoryEnum} [factory] Factory name - wow -&gt; [wow.xyz](https://wow.xyz) - clanker -&gt; [clanker.world](https://www.clanker.world)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-fungible)
     *
     */
    deployFungible: (owner: string, symbol: string, name: string, metadataMedia?: File | null, metadataDescription?: string, metadataNsfw?: DeployFungibleMetadataNsfwEnum, metadataWebsiteLink?: string, metadataTwitter?: string, metadataDiscord?: string, metadataTelegram?: string, network?: DeployFungibleNetworkEnum, factory?: DeployFungibleFactoryEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get recent trades for a specific fungible within a timeframe. Returns trades ordered by timestamp (most recent first).
     * @summary Get fungible trades
     * @param {FetchFungibleTradesNetworkEnum} network
     * @param {string} address Contract address
     * @param {FetchFungibleTradesTimeWindowEnum} [timeWindow] Time window for trades e.g. \&quot;1h\&quot;, \&quot;6h\&quot;, \&quot;12h\&quot;, \&quot;24h\&quot;, \&quot;7d\&quot;
     * @param {number | null} [minAmountUsd] Minimum USD amount to filter trades
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FetchFungibleTrades200Response>} A promise that resolves to a `FetchFungibleTrades200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungible-trades)
     *
     */
    fetchFungibleTrades: (network: FetchFungibleTradesNetworkEnum, address: string, timeWindow?: FetchFungibleTradesTimeWindowEnum, minAmountUsd?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Fetch details for fungible assets identified by fungible identifiers.
     * @summary Fetch fungibles
     * @param {string} fungibles Comma-separated fungible identifiers
     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
     * @param {number | null} [viewerFid] Optional FID of the viewer to personalize cast count filtering
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FungiblesResponseSchema>} A promise that resolves to a `FungiblesResponseSchema` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungibles)
     *
     */
    fetchFungibles: (fungibles: string, xNeynarExperimental?: boolean, viewerFid?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
     * @summary Relevant owners
     * @param {string} contractAddress Contract address of the fungible asset
     * @param {FetchRelevantFungibleOwnersNetworkEnum} network Network of the fungible asset.
     * @param {number} [viewerFid] If you provide a viewer_fid, the response will include token holders from the user\&#39;s network, respecting their mutes and blocks and including viewer_context; if not provided, the response will show top token holders across the network—both sets can be combined to generate a longer list if desired.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-fungible-owners)
     *
     */
    fetchRelevantFungibleOwners: (contractAddress: string, network: FetchRelevantFungibleOwnersNetworkEnum, viewerFid?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Fetch trending fungibles based on buy activity from watched addresses. Returns fungibles ranked by USD buy volume and buy count within the specified time window.
     * @summary Trending fungibles
     * @param {FetchTrendingFungiblesNetworkEnum} network
     * @param {FetchTrendingFungiblesTimeWindowEnum} [timeWindow] Time window for trending calculations e.g. \&quot;1h\&quot;, \&quot;6h\&quot;, \&quot;12h\&quot;, \&quot;24h\&quot;, \&quot;7d\&quot;
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FetchTrendingFungibles200Response>} A promise that resolves to a `FetchTrendingFungibles200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-trending-fungibles)
     *
     */
    fetchTrendingFungibles: (network: FetchTrendingFungiblesNetworkEnum, timeWindow?: FetchTrendingFungiblesTimeWindowEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Fetches the token balances of a user given their FID
     * @summary Token balance
     * @param {number} fid FID of the user to fetch
     * @param {Array<FetchUserBalanceNetworksEnum>} networks Comma separated list of networks to fetch balances for
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-balance)
     *
     */
    fetchUserBalance: (fid: number, networks: Array<FetchUserBalanceNetworksEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Mints an NFT to one or more recipients on a specified network and contract, using a configured server wallet. Contact us to set up your wallet configuration if you don\'t have one.
     * @summary Mint NFT(s)
     * @param {string} xWalletId Wallet ID to use for transactions
     * @param {MintNftRequest} mintNftRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
     *
     */
    mintNft: (xWalletId: string, mintNftRequest: MintNftRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction. Requires x-wallet-id header.
     * @summary Register Farcaster account onchain
     * @param {string} xWalletId Wallet ID to use for transactions
     * @param {RegisterUserOnChainReqBody} registerUserOnChainReqBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account-onchain)
     *
     */
    registerAccountOnchain: (xWalletId: string, registerUserOnChainReqBody: RegisterUserOnChainReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
     * @summary Send fungibles
     * @param {string} xWalletId Wallet ID to use for transactions
     * @param {TransactionSendFungiblesReqBody} transactionSendFungiblesReqBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
     *
     */
    sendFungiblesToUsers: (xWalletId: string, transactionSendFungiblesReqBody: TransactionSendFungiblesReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
     * @summary Simulate NFT mint calldata
     * @param {string} recipients JSON array of recipients (same structure as POST).
     * @param {string} nftContractAddress Ethereum address
     * @param {SimulateNftMintNetworkEnum} network Network to mint on.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
     *
     */
    simulateNftMint: (recipients: string, nftContractAddress: string, network: SimulateNftMintNetworkEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * OnchainApi - functional programming interface
 * @export
 */
export declare const OnchainApiFp: (configuration?: Configuration) => {
    /**
     * Create a signature for a given x402 resource using the specified wallet.
     * @summary Create x402 signature
     * @param {string} xWalletId Wallet ID to use for transactions
     * @param {string} xApiKey
     * @param {CreateX402SignatureRequest} createX402SignatureRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<CreateX402Signature200Response>} A promise that resolves to a `CreateX402Signature200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-x402-signature)
     *
     */
    createX402Signature(xWalletId: string, xApiKey: string, createX402SignatureRequest: CreateX402SignatureRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateX402Signature200Response>>;
    /**
     * Creates a new token. This is an allowlisted API, reach out if you want access.
     * @summary Deploy fungible
     * @param {string} owner Ethereum address of the one who is creating the token
     * @param {string} symbol Symbol/Ticker for the token
     * @param {string} name Name of the token
     * @param {File | null} [metadataMedia] Media file associated with the token.  Supported formats are image/jpeg, image/gif and image/png
     * @param {string} [metadataDescription] Description of the token
     * @param {DeployFungibleMetadataNsfwEnum} [metadataNsfw] Indicates if the token is NSFW (Not Safe For Work).
     * @param {string} [metadataWebsiteLink] Website link related to the token
     * @param {string} [metadataTwitter] Twitter profile link
     * @param {string} [metadataDiscord] Discord server link
     * @param {string} [metadataTelegram] Telegram link
     * @param {DeployFungibleNetworkEnum} [network] Network/Chain name
     * @param {DeployFungibleFactoryEnum} [factory] Factory name - wow -&gt; [wow.xyz](https://wow.xyz) - clanker -&gt; [clanker.world](https://www.clanker.world)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-fungible)
     *
     */
    deployFungible(owner: string, symbol: string, name: string, metadataMedia?: File | null, metadataDescription?: string, metadataNsfw?: DeployFungibleMetadataNsfwEnum, metadataWebsiteLink?: string, metadataTwitter?: string, metadataDiscord?: string, metadataTelegram?: string, network?: DeployFungibleNetworkEnum, factory?: DeployFungibleFactoryEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployFungibleResponse>>;
    /**
     * Get recent trades for a specific fungible within a timeframe. Returns trades ordered by timestamp (most recent first).
     * @summary Get fungible trades
     * @param {FetchFungibleTradesNetworkEnum} network
     * @param {string} address Contract address
     * @param {FetchFungibleTradesTimeWindowEnum} [timeWindow] Time window for trades e.g. \&quot;1h\&quot;, \&quot;6h\&quot;, \&quot;12h\&quot;, \&quot;24h\&quot;, \&quot;7d\&quot;
     * @param {number | null} [minAmountUsd] Minimum USD amount to filter trades
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FetchFungibleTrades200Response>} A promise that resolves to a `FetchFungibleTrades200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungible-trades)
     *
     */
    fetchFungibleTrades(network: FetchFungibleTradesNetworkEnum, address: string, timeWindow?: FetchFungibleTradesTimeWindowEnum, minAmountUsd?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchFungibleTrades200Response>>;
    /**
     * Fetch details for fungible assets identified by fungible identifiers.
     * @summary Fetch fungibles
     * @param {string} fungibles Comma-separated fungible identifiers
     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
     * @param {number | null} [viewerFid] Optional FID of the viewer to personalize cast count filtering
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FungiblesResponseSchema>} A promise that resolves to a `FungiblesResponseSchema` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungibles)
     *
     */
    fetchFungibles(fungibles: string, xNeynarExperimental?: boolean, viewerFid?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FungiblesResponseSchema>>;
    /**
     * Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
     * @summary Relevant owners
     * @param {string} contractAddress Contract address of the fungible asset
     * @param {FetchRelevantFungibleOwnersNetworkEnum} network Network of the fungible asset.
     * @param {number} [viewerFid] If you provide a viewer_fid, the response will include token holders from the user\&#39;s network, respecting their mutes and blocks and including viewer_context; if not provided, the response will show top token holders across the network—both sets can be combined to generate a longer list if desired.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-fungible-owners)
     *
     */
    fetchRelevantFungibleOwners(contractAddress: string, network: FetchRelevantFungibleOwnersNetworkEnum, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelevantFungibleOwnersResponse>>;
    /**
     * Fetch trending fungibles based on buy activity from watched addresses. Returns fungibles ranked by USD buy volume and buy count within the specified time window.
     * @summary Trending fungibles
     * @param {FetchTrendingFungiblesNetworkEnum} network
     * @param {FetchTrendingFungiblesTimeWindowEnum} [timeWindow] Time window for trending calculations e.g. \&quot;1h\&quot;, \&quot;6h\&quot;, \&quot;12h\&quot;, \&quot;24h\&quot;, \&quot;7d\&quot;
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FetchTrendingFungibles200Response>} A promise that resolves to a `FetchTrendingFungibles200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-trending-fungibles)
     *
     */
    fetchTrendingFungibles(network: FetchTrendingFungiblesNetworkEnum, timeWindow?: FetchTrendingFungiblesTimeWindowEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchTrendingFungibles200Response>>;
    /**
     * Fetches the token balances of a user given their FID
     * @summary Token balance
     * @param {number} fid FID of the user to fetch
     * @param {Array<FetchUserBalanceNetworksEnum>} networks Comma separated list of networks to fetch balances for
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-balance)
     *
     */
    fetchUserBalance(fid: number, networks: Array<FetchUserBalanceNetworksEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BalanceResponse>>;
    /**
     * Mints an NFT to one or more recipients on a specified network and contract, using a configured server wallet. Contact us to set up your wallet configuration if you don\'t have one.
     * @summary Mint NFT(s)
     * @param {string} xWalletId Wallet ID to use for transactions
     * @param {MintNftRequest} mintNftRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
     *
     */
    mintNft(xWalletId: string, mintNftRequest: MintNftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MintNft200Response>>;
    /**
     * Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction. Requires x-wallet-id header.
     * @summary Register Farcaster account onchain
     * @param {string} xWalletId Wallet ID to use for transactions
     * @param {RegisterUserOnChainReqBody} registerUserOnChainReqBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account-onchain)
     *
     */
    registerAccountOnchain(xWalletId: string, registerUserOnChainReqBody: RegisterUserOnChainReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegisterUserOnChainResponse>>;
    /**
     * Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
     * @summary Send fungibles
     * @param {string} xWalletId Wallet ID to use for transactions
     * @param {TransactionSendFungiblesReqBody} transactionSendFungiblesReqBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
     *
     */
    sendFungiblesToUsers(xWalletId: string, transactionSendFungiblesReqBody: TransactionSendFungiblesReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionSendFungiblesResponse>>;
    /**
     * Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
     * @summary Simulate NFT mint calldata
     * @param {string} recipients JSON array of recipients (same structure as POST).
     * @param {string} nftContractAddress Ethereum address
     * @param {SimulateNftMintNetworkEnum} network Network to mint on.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
     *
     */
    simulateNftMint(recipients: string, nftContractAddress: string, network: SimulateNftMintNetworkEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimulateNftMintResponse>>;
};
/**
 * OnchainApi - factory interface
 * @export
 */
export declare const OnchainApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Create a signature for a given x402 resource using the specified wallet.
     * @summary Create x402 signature
     * @param {OnchainApiCreateX402SignatureRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<CreateX402Signature200Response>} A promise that resolves to a `CreateX402Signature200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-x402-signature)
     *
     */
    createX402Signature(requestParameters: OnchainApiCreateX402SignatureRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateX402Signature200Response>;
    /**
     * Creates a new token. This is an allowlisted API, reach out if you want access.
     * @summary Deploy fungible
     * @param {OnchainApiDeployFungibleRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-fungible)
     *
     */
    deployFungible(requestParameters: OnchainApiDeployFungibleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeployFungibleResponse>;
    /**
     * Get recent trades for a specific fungible within a timeframe. Returns trades ordered by timestamp (most recent first).
     * @summary Get fungible trades
     * @param {OnchainApiFetchFungibleTradesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FetchFungibleTrades200Response>} A promise that resolves to a `FetchFungibleTrades200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungible-trades)
     *
     */
    fetchFungibleTrades(requestParameters: OnchainApiFetchFungibleTradesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchFungibleTrades200Response>;
    /**
     * Fetch details for fungible assets identified by fungible identifiers.
     * @summary Fetch fungibles
     * @param {OnchainApiFetchFungiblesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FungiblesResponseSchema>} A promise that resolves to a `FungiblesResponseSchema` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungibles)
     *
     */
    fetchFungibles(requestParameters: OnchainApiFetchFungiblesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FungiblesResponseSchema>;
    /**
     * Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
     * @summary Relevant owners
     * @param {OnchainApiFetchRelevantFungibleOwnersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-fungible-owners)
     *
     */
    fetchRelevantFungibleOwners(requestParameters: OnchainApiFetchRelevantFungibleOwnersRequest, options?: RawAxiosRequestConfig): AxiosPromise<RelevantFungibleOwnersResponse>;
    /**
     * Fetch trending fungibles based on buy activity from watched addresses. Returns fungibles ranked by USD buy volume and buy count within the specified time window.
     * @summary Trending fungibles
     * @param {OnchainApiFetchTrendingFungiblesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FetchTrendingFungibles200Response>} A promise that resolves to a `FetchTrendingFungibles200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-trending-fungibles)
     *
     */
    fetchTrendingFungibles(requestParameters: OnchainApiFetchTrendingFungiblesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchTrendingFungibles200Response>;
    /**
     * Fetches the token balances of a user given their FID
     * @summary Token balance
     * @param {OnchainApiFetchUserBalanceRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-balance)
     *
     */
    fetchUserBalance(requestParameters: OnchainApiFetchUserBalanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<BalanceResponse>;
    /**
     * Mints an NFT to one or more recipients on a specified network and contract, using a configured server wallet. Contact us to set up your wallet configuration if you don\'t have one.
     * @summary Mint NFT(s)
     * @param {OnchainApiMintNftRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
     *
     */
    mintNft(requestParameters: OnchainApiMintNftRequest, options?: RawAxiosRequestConfig): AxiosPromise<MintNft200Response>;
    /**
     * Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction. Requires x-wallet-id header.
     * @summary Register Farcaster account onchain
     * @param {OnchainApiRegisterAccountOnchainRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account-onchain)
     *
     */
    registerAccountOnchain(requestParameters: OnchainApiRegisterAccountOnchainRequest, options?: RawAxiosRequestConfig): AxiosPromise<RegisterUserOnChainResponse>;
    /**
     * Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
     * @summary Send fungibles
     * @param {OnchainApiSendFungiblesToUsersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
     *
     */
    sendFungiblesToUsers(requestParameters: OnchainApiSendFungiblesToUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionSendFungiblesResponse>;
    /**
     * Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
     * @summary Simulate NFT mint calldata
     * @param {OnchainApiSimulateNftMintRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
     *
     */
    simulateNftMint(requestParameters: OnchainApiSimulateNftMintRequest, options?: RawAxiosRequestConfig): AxiosPromise<SimulateNftMintResponse>;
};
/**
 * OnchainApi - interface
 * @export
 * @interface OnchainApi
 */
export interface OnchainApiInterface {
    /**
     * Create a signature for a given x402 resource using the specified wallet.
     * @summary Create x402 signature
     * @param {OnchainApiCreateX402SignatureRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<CreateX402Signature200Response>} A promise that resolves to a `CreateX402Signature200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-x402-signature)
     *
     */
    createX402Signature(requestParameters: OnchainApiCreateX402SignatureRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateX402Signature200Response>;
    /**
     * Creates a new token. This is an allowlisted API, reach out if you want access.
     * @summary Deploy fungible
     * @param {OnchainApiDeployFungibleRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-fungible)
     *
     */
    deployFungible(requestParameters: OnchainApiDeployFungibleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeployFungibleResponse>;
    /**
     * Get recent trades for a specific fungible within a timeframe. Returns trades ordered by timestamp (most recent first).
     * @summary Get fungible trades
     * @param {OnchainApiFetchFungibleTradesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<FetchFungibleTrades200Response>} A promise that resolves to a `FetchFungibleTrades200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungible-trades)
     *
     */
    fetchFungibleTrades(requestParameters: OnchainApiFetchFungibleTradesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchFungibleTrades200Response>;
    /**
     * Fetch details for fungible assets identified by fungible identifiers.
     * @summary Fetch fungibles
     * @param {OnchainApiFetchFungiblesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<FungiblesResponseSchema>} A promise that resolves to a `FungiblesResponseSchema` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungibles)
     *
     */
    fetchFungibles(requestParameters: OnchainApiFetchFungiblesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FungiblesResponseSchema>;
    /**
     * Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
     * @summary Relevant owners
     * @param {OnchainApiFetchRelevantFungibleOwnersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-fungible-owners)
     *
     */
    fetchRelevantFungibleOwners(requestParameters: OnchainApiFetchRelevantFungibleOwnersRequest, options?: RawAxiosRequestConfig): AxiosPromise<RelevantFungibleOwnersResponse>;
    /**
     * Fetch trending fungibles based on buy activity from watched addresses. Returns fungibles ranked by USD buy volume and buy count within the specified time window.
     * @summary Trending fungibles
     * @param {OnchainApiFetchTrendingFungiblesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<FetchTrendingFungibles200Response>} A promise that resolves to a `FetchTrendingFungibles200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-trending-fungibles)
     *
     */
    fetchTrendingFungibles(requestParameters: OnchainApiFetchTrendingFungiblesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchTrendingFungibles200Response>;
    /**
     * Fetches the token balances of a user given their FID
     * @summary Token balance
     * @param {OnchainApiFetchUserBalanceRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-balance)
     *
     */
    fetchUserBalance(requestParameters: OnchainApiFetchUserBalanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<BalanceResponse>;
    /**
     * Mints an NFT to one or more recipients on a specified network and contract, using a configured server wallet. Contact us to set up your wallet configuration if you don\'t have one.
     * @summary Mint NFT(s)
     * @param {OnchainApiMintNftRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
     *
     */
    mintNft(requestParameters: OnchainApiMintNftRequest, options?: RawAxiosRequestConfig): AxiosPromise<MintNft200Response>;
    /**
     * Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction. Requires x-wallet-id header.
     * @summary Register Farcaster account onchain
     * @param {OnchainApiRegisterAccountOnchainRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account-onchain)
     *
     */
    registerAccountOnchain(requestParameters: OnchainApiRegisterAccountOnchainRequest, options?: RawAxiosRequestConfig): AxiosPromise<RegisterUserOnChainResponse>;
    /**
     * Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
     * @summary Send fungibles
     * @param {OnchainApiSendFungiblesToUsersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
     *
     */
    sendFungiblesToUsers(requestParameters: OnchainApiSendFungiblesToUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionSendFungiblesResponse>;
    /**
     * Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
     * @summary Simulate NFT mint calldata
     * @param {OnchainApiSimulateNftMintRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OnchainApiInterface
     * @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
     *
     */
    simulateNftMint(requestParameters: OnchainApiSimulateNftMintRequest, options?: RawAxiosRequestConfig): AxiosPromise<SimulateNftMintResponse>;
}
/**
 * Request parameters for createX402Signature operation in OnchainApi.
 * @export
 * @interface OnchainApiCreateX402SignatureRequest
 */
export interface OnchainApiCreateX402SignatureRequest {
    /**
     * Wallet ID to use for transactions
     *
     *
     * @globalHeader
     * @type {string}
     * @memberof OnchainApiCreateX402Signature
     */
    readonly xWalletId: string;
    /**
     *
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiCreateX402Signature
     */
    readonly xApiKey: string;
    /**
     *
     *
     *
     *
     * @type {CreateX402SignatureRequest}
     * @memberof OnchainApiCreateX402Signature
     */
    readonly createX402SignatureRequest: CreateX402SignatureRequest;
}
/**
 * Request parameters for deployFungible operation in OnchainApi.
 * @export
 * @interface OnchainApiDeployFungibleRequest
 */
export interface OnchainApiDeployFungibleRequest {
    /**
     * Ethereum address of the one who is creating the token
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly owner: string;
    /**
     * Symbol/Ticker for the token
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly symbol: string;
    /**
     * Name of the token
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly name: string;
    /**
     * Media file associated with the token.  Supported formats are image/jpeg, image/gif and image/png
     *
     *
     *
     * @type {File}
     * @memberof OnchainApiDeployFungible
     */
    readonly metadataMedia?: File | null;
    /**
     * Description of the token
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly metadataDescription?: string;
    /**
     * Indicates if the token is NSFW (Not Safe For Work).
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly metadataNsfw?: DeployFungibleMetadataNsfwEnum;
    /**
     * Website link related to the token
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly metadataWebsiteLink?: string;
    /**
     * Twitter profile link
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly metadataTwitter?: string;
    /**
     * Discord server link
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly metadataDiscord?: string;
    /**
     * Telegram link
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly metadataTelegram?: string;
    /**
     * Network/Chain name
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly network?: DeployFungibleNetworkEnum;
    /**
     * Factory name - wow -&gt; [wow.xyz](https://wow.xyz) - clanker -&gt; [clanker.world](https://www.clanker.world)
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiDeployFungible
     */
    readonly factory?: DeployFungibleFactoryEnum;
}
/**
 * Request parameters for fetchFungibleTrades operation in OnchainApi.
 * @export
 * @interface OnchainApiFetchFungibleTradesRequest
 */
export interface OnchainApiFetchFungibleTradesRequest {
    /**
     *
     *
     *
     *
     * @type {'base'}
     * @memberof OnchainApiFetchFungibleTrades
     */
    readonly network: FetchFungibleTradesNetworkEnum;
    /**
     * Contract address
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiFetchFungibleTrades
     */
    readonly address: string;
    /**
     * Time window for trades e.g. \&quot;1h\&quot;, \&quot;6h\&quot;, \&quot;12h\&quot;, \&quot;24h\&quot;, \&quot;7d\&quot;
     *
     *
     *
     * @type {'1h' | '6h' | '12h' | '24h' | '7d'}
     * @memberof OnchainApiFetchFungibleTrades
     */
    readonly timeWindow?: FetchFungibleTradesTimeWindowEnum;
    /**
     * Minimum USD amount to filter trades
     *
     *
     *
     * @type {number}
     * @memberof OnchainApiFetchFungibleTrades
     */
    readonly minAmountUsd?: number | null;
}
/**
 * Request parameters for fetchFungibles operation in OnchainApi.
 * @export
 * @interface OnchainApiFetchFungiblesRequest
 */
export interface OnchainApiFetchFungiblesRequest {
    /**
     * Comma-separated fungible identifiers
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiFetchFungibles
     */
    readonly fungibles: string;
    /**
     * Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
     *
     *
     * @globalHeader
     * @type {boolean}
     * @memberof OnchainApiFetchFungibles
     */
    readonly xNeynarExperimental?: boolean;
    /**
     * Optional FID of the viewer to personalize cast count filtering
     *
     *
     *
     * @type {number}
     * @memberof OnchainApiFetchFungibles
     */
    readonly viewerFid?: number | null;
}
/**
 * Request parameters for fetchRelevantFungibleOwners operation in OnchainApi.
 * @export
 * @interface OnchainApiFetchRelevantFungibleOwnersRequest
 */
export interface OnchainApiFetchRelevantFungibleOwnersRequest {
    /**
     * Contract address of the fungible asset
     *
     *
     *
     * @type {string}
     * @memberof OnchainApiFetchRelevantFungibleOwners
     */
    readonly contractAddress: string;
    /**
     * Network of the fungible asset.
     *
     *
     *
     * @type {'ethereum' | 'optimism' | 'base' | 'arbitrum' | 'solana'}
     * @memberof OnchainApiFetchRelevantFungibleOwners
     */
    readonly network: FetchRelevantFungibleOwnersNetworkEnum;
    /**
     * If you provide a viewer_fid, the response will include token holders from the user\&#39;s network, respecting their mutes and blocks and including viewer_context; if not provided, the response will show top token holders across the network—both sets can be combined to generate a longer list if desired.
     *
     *
     *
     * @type {number}
     * @memberof OnchainApiFetchRelevantFungibleOwners
     */
    readonly viewerFid?: number;
}
/**
 * Request parameters for fetchTrendingFungibles operation in OnchainApi.
 * @export
 * @interface OnchainApiFetchTrendingFungiblesRequest
 */
export interface OnchainApiFetchTrendingFungiblesRequest {
    /**
     *
     *
     *
     *
     * @type {'base'}
     * @memberof OnchainApiFetchTrendingFungibles
     */
    readonly network: FetchTrendingFungiblesNetworkEnum;
    /**
     * Time window for trending calculations e.g. \&quot;1h\&quot;, \&quot;6h\&quot;, \&quot;12h\&quot;, \&quot;24h\&quot;, \&quot;7d\&quot;
     *
     *
     *
     * @type {'1h' | '6h' | '12h' | '24h' | '7d'}
     * @memberof Oncha