filecoin-pin
    Preparing search index...

    Interface PrivateKeyConfig

    Standard authentication with private key

    interface PrivateKeyConfig {
        chain?: FilecoinChain;
        dataSetMetadata?: Record<string, string>;
        privateKey: `0x${string}`;
        requiredPermissions?: Permission[];
        rpcUrl?: string;
        withCDN?: boolean;
    }

    Hierarchy

    • BaseSynapseConfig
      • PrivateKeyConfig
    Index
    chain? dataSetMetadata? privateKey requiredPermissions? rpcUrl? withCDN?
    chain?: FilecoinChain

    Target chain. Defaults to mainnet.

    dataSetMetadata?: Record<string, string>

    Default metadata to apply when creating datasets

    privateKey: `0x${string}`
    requiredPermissions?: Permission[]

    Session-key mode only: the permissions this command needs. Before doing any work, we check the session key's on-chain grants cover these. If one is missing, the command stops immediately with instructions for getting it granted (console link), rather than failing later mid-transaction. Leave unset for read-only commands — they need no permissions.

    rpcUrl?: string

    RPC endpoint for the target Filecoin network. Defaults to mainnet chain transport.

    withCDN?: boolean

    Enable CDN service for datasets

    Settings
    Member Visibility

    On This Page
    Properties