filecoin-pin
    Preparing search index...

    Interface SignerConfig

    Signer-based authentication with ethers Signer

    interface SignerConfig {
        dataSetMetadata?: Record<string, string>;
        network: "mainnet" | "calibration";
        readOnly?: boolean;
        rpcUrl?: string;
        signer: Signer;
        telemetry?: TelemetryConfig;
        warmStorageAddress?: string;
        withCDN?: boolean;
    }

    Hierarchy

    • BaseSynapseConfig
      • SignerConfig
    Index

    Properties

    dataSetMetadata? network readOnly? rpcUrl? signer telemetry? warmStorageAddress? withCDN?

    Properties

    dataSetMetadata?: Record<string, string>

    Default metadata to apply when creating or reusing datasets

    network: "mainnet" | "calibration"

    Target Filecoin network (required for signer mode to determine default RPC)

    readOnly?: boolean

    Optional flag for read-only auth (address-only signer)

    rpcUrl?: string

    RPC endpoint for the target Filecoin network. Defaults to calibration.

    signer: Signer
    telemetry?: TelemetryConfig

    Telemetry configuration. Defaults to enabled unless explicitly disabled.

    {
       *   sentryInitOptions: {
       *     enabled: false, // if want to disable telemetry.
       *   },
       *   sentrySetTags: {
       *     appName: "${your-app-name}",
       *   },
       * }
    warmStorageAddress?: string

    Optional override for WarmStorage contract address

    withCDN?: boolean

    Settings

    Member Visibility

    On This Page

    Properties