Utility Functions

/**
 * Ensures Ethereum address has 0x prefix
 * @param address - Address string with or without 0x prefix
 * @returns Address with 0x prefix guaranteed
 */
function fillAddressWith0x(address: string): `0x${string}`;

import { fillAddressWith0x } from "@ant-design/web3-common";

// Add 0x prefix to address
const address1 = fillAddressWith0x("abcd1234");
// Result: "0xabcd1234"

// Address already has prefix - returns unchanged
const address2 = fillAddressWith0x("0xef567890");
// Result: "0xef567890"

/**
 * Safely converts number to BigInt, handling undefined values
 * @param num - Number or BigInt to convert, or undefined
 * @returns BigInt value or undefined if input was undefined
 */
function parseNumberToBigint(num?: number | bigint): bigint | undefined;

import { parseNumberToBigint } from "@ant-design/web3-common";

// Convert number to BigInt
const amount1 = parseNumberToBigint(1000);
// Result: 1000n

// Handle BigInt input
const amount2 = parseNumberToBigint(500n);
// Result: 500n

// Handle undefined
const amount3 = parseNumberToBigint(undefined);
// Result: undefined

/**
 * Creates a function that generates blockchain explorer links
 * @param url - Base URL of the blockchain explorer
 * @returns Function that generates explorer links for addresses and transactions
 */
function createGetBrowserLink(url: string): (address: string, type: string) => string;

import { createGetBrowserLink } from "@ant-design/web3-common";

// Create Etherscan link generator
const getEtherscanLink = createGetBrowserLink("https://etherscan.io");

// Generate address link
const addressLink = getEtherscanLink(
  "0x742d35cc6634c0532925a3b8d6ac013bbce29cd4", 
  "address"
);
// Result: "https://etherscan.io/address/0x742d35cc6634c0532925a3b8d6ac013bbce29cd4"

// Generate transaction link
const txLink = getEtherscanLink(
  "0xabc123def456...", 
  "transaction"
);
// Result: "https://etherscan.io/tx/0xabc123def456..."

// Create Polygon scanner link generator
const getPolygonLink = createGetBrowserLink("https://polygonscan.com");

/**
 * Converts IPFS URLs to HTTP URLs for browser access
 * @param url - Asset URL, may be IPFS protocol or regular HTTP
 * @returns HTTP-accessible URL or undefined if input was undefined
 */
function getWeb3AssetUrl(url?: string): string | undefined;

/**
 * Fetches and parses JSON from a Web3 asset URL
 * @param url - Asset URL to fetch
 * @returns Promise resolving to parsed JSON data
 * @throws Error if URL is not provided or fetch fails
 */
function requestWeb3Asset<T = any>(url: string): Promise<T>;

import { getWeb3AssetUrl, requestWeb3Asset } from "@ant-design/web3-common";

// Convert IPFS URL to HTTP
const ipfsUrl = "ipfs://QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE7o";
const httpUrl = getWeb3AssetUrl(ipfsUrl);
// Result: "https://ipfs.io/ipfs/QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE7o"

// Regular HTTP URL passes through unchanged
const regularUrl = getWeb3AssetUrl("https://example.com/asset.json");
// Result: "https://example.com/asset.json"

// Handle undefined
const undefinedUrl = getWeb3AssetUrl(undefined);
// Result: undefined

// Fetch NFT metadata
try {
  const metadata = await requestWeb3Asset<{
    name: string;
    description: string;
    image: string;
  }>("https://api.example.com/nft/123");
  
  console.log(metadata.name);
} catch (error) {
  console.error("Failed to fetch metadata:", error);
}

/**
 * Mocks the global fetch function for testing purposes
 * @param expect - Expected response object that will be returned by fetch
 */
function mockFetch(expect: any): void;

import { mockFetch } from "@ant-design/web3-common";

// In test files
describe("API tests", () => {
  beforeEach(() => {
    // Mock fetch to return test data
    mockFetch({
      name: "Test NFT",
      description: "Test description",
      image: "test-image.png"
    });
  });

  it("should fetch NFT metadata", async () => {
    const result = await requestWeb3Asset("test-url");
    expect(result.name).toBe("Test NFT");
  });
});

import { 
  fillAddressWith0x,
  parseNumberToBigint,
  createGetBrowserLink,
  getWeb3AssetUrl,
  requestWeb3Asset,
  mockFetch 
} from "@ant-design/web3-common";