Type Alias CdpOptions

CdpOptions: {
    apiKeyId: string;
    apiKeySecret: string;
    basePath?: string;
    debugging?: boolean;
    expiresIn?: number;
    source?: string;
    sourceVersion?: string;
    walletSecret?: string;
}

The options for the CDP API.

Type declaration

  • apiKeyId: string

    The API key ID or the legacy API key name.

    Examples: ID format: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' Legacy name format: 'organizations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/apiKeys/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

  • apiKeySecret: string

    The API key secret, using the Ed25519 or legacy EC key format.

    Examples: Ed25519 key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==' EC key: '-----BEGIN EC PRIVATE KEY-----\n...\n...\n...==\n-----END EC PRIVATE KEY-----\n'

  • OptionalbasePath?: string

    The base path for the API.

  • Optionaldebugging?: boolean

    If true, logs API requests and responses to the console.

  • OptionalexpiresIn?: number

    Optional expiration time in seconds (defaults to 120)

  • Optionalsource?: string

    The source for the API request, used for analytics. Defaults to typescript-client.

  • OptionalsourceVersion?: string

    The version of the source for the API request, used for analytics.

  • OptionalwalletSecret?: string

    The Wallet Secret. Only needed if calling certain Wallet APIs.

Settings

Member Visibility