@circle-fin/usdckit - v0.18.0
    Preparing search index...

    Function createCircleClient

    • Creates a Circle client with the specified parameters.

      Parameters

      • params: {
            apiKey: string;
            baseUrl?: string;
            chain?: Chain;
            entitySecret: string;
            logFile?: string | number;
            logLevel?:
                | "error"
                | "fatal"
                | "warn"
                | "info"
                | "debug"
                | "trace"
                | "silent";
        }

        The parameters for creating the client

        • apiKey: string

          API key for authentication

        • OptionalbaseUrl?: string

          Base URL for the API

        • Optionalchain?: Chain

          Chain configuration, defaults to ETH_SEPOLIA

        • entitySecret: string

          Entity secret for authentication

        • OptionallogFile?: string | number

          Log destination

          `1` - logs to standard output
          `2` - logs to standard error
          `'/path/to/logfile.log'` - logs to a file
        • OptionallogLevel?: "error" | "fatal" | "warn" | "info" | "debug" | "trace" | "silent"

          Log level

      Returns CircleClient

      A configured Circle client instance

      Initialize a client with using the default chain

      import { createClient } from '@circle-fin/usdckit'

      const client = createClient({
        apiKey: 'your-api-key',
        entitySecret: 'your-entity-secret',
      });

      Initialize a client with using MATIC_SEPOLIA chain

      import { createClient } from '@circle-fin/usdckit'
      import { MATIC_SEPOLIA } from '@circle-fin/usdckit/chains'

      const client = createClient({
        apiKey: 'your-api-key',
        entitySecret: 'your-entity-secret',
        chain: MATIC_SEPOLIA,
      });

      Initialize a client with logging

      import { createClient } from '@circle-fin/usdckit'

      const client = createClient({
        apiKey: 'your-api-key',
        entitySecret: 'your-entity-secret',
        logLevel: 'debug',
      });

    Settings

    Member Visibility