filecoin-pin
    Preparing search index...

    Interface ReadOnlyConfig

    Read-only authentication using an address-only signer

    This supports querying balances and status without signing transactions.

    interface ReadOnlyConfig {
        dataSetMetadata?: Record<string, string>;
        readOnly: true;
        rpcUrl?: string;
        telemetry?: TelemetryConfig;
        walletAddress: string;
        warmStorageAddress?: string;
        withCDN?: boolean;
    }

    Hierarchy

    • BaseSynapseConfig
      • ReadOnlyConfig
    Index

    Properties

    dataSetMetadata? readOnly rpcUrl? telemetry? walletAddress warmStorageAddress? withCDN?

    Properties

    dataSetMetadata?: Record<string, string>

    Default metadata to apply when creating or reusing datasets

    readOnly: true

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

    rpcUrl?: string

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

    telemetry?: TelemetryConfig

    Telemetry configuration. Defaults to enabled unless explicitly disabled.

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

    Optional override for WarmStorage contract address

    withCDN?: boolean

    Settings

    Member Visibility

    On This Page

    Properties