cardano-rpc-10.0.0.0: The cardano RPC interface
Safe HaskellNone
LanguageHaskell2010

Cardano.Rpc.Server.Config

Synopsis

Documentation

data RpcConfigF (m :: Type -> Type) Source #

RPC server configuration, which is a part of cardano-node configuration.

Constructors

RpcConfig 

Fields

Instances

Instances details
Monoid (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Semigroup (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Generic (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Associated Types

type Rep (RpcConfigF Last) 
Instance details

Defined in Cardano.Rpc.Server.Config

type Rep (RpcConfigF Last) = D1 ('MetaData "RpcConfigF" "Cardano.Rpc.Server.Config" "cardano-rpc-10.0.0.0-inplace" 'False) (C1 ('MetaCons "RpcConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "isEnabled") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Bool)) :*: (S1 ('MetaSel ('Just "rpcSocketPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last SocketPath)) :*: S1 ('MetaSel ('Just "nodeSocketPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last SocketPath)))))
Show (RpcConfigF Identity) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Show (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Eq (RpcConfigF Identity) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Eq (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

type Rep (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

type Rep (RpcConfigF Last) = D1 ('MetaData "RpcConfigF" "Cardano.Rpc.Server.Config" "cardano-rpc-10.0.0.0-inplace" 'False) (C1 ('MetaCons "RpcConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "isEnabled") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Bool)) :*: (S1 ('MetaSel ('Just "rpcSocketPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last SocketPath)) :*: S1 ('MetaSel ('Just "nodeSocketPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last SocketPath)))))

makeRpcConfig :: MonadError String m => PartialRpcConfig -> m RpcConfig Source #

Build RPC Config

Uses the following defaults if the values are not provided * RPC is disabled * rpc.sock is placed in the same path as the node socket

Validates if the node socket is enabled if RPC is enabled.

nodeSocketPathToRpcSocketPath :: SocketPath -> SocketPath Source #

Convert node socket path to a default rpc socket path. By default it's rpc.sock in the same directory as node socket path.