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

Cardano.Rpc.Server.Config

Synopsis

Documentation

type RpcConfig = RpcConfigF Identity Source #

type PartialRpcConfig = RpcConfigF Last Source #

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

Methods

mempty :: RpcConfigF Last Source #

mappend :: RpcConfigF Last -> RpcConfigF Last -> RpcConfigF Last Source #

mconcat :: [RpcConfigF Last] -> RpcConfigF Last Source #

Semigroup (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Methods

(<>) :: RpcConfigF Last -> RpcConfigF Last -> RpcConfigF Last Source #

sconcat :: NonEmpty (RpcConfigF Last) -> RpcConfigF Last Source #

stimes :: Integral b => b -> RpcConfigF Last -> RpcConfigF Last Source #

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)))))

Methods

from :: RpcConfigF Last -> Rep (RpcConfigF Last) x Source #

to :: Rep (RpcConfigF Last) x -> RpcConfigF Last Source #

Show (RpcConfigF Identity) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Methods

showsPrec :: Int -> RpcConfigF Identity -> ShowS Source #

show :: RpcConfigF Identity -> String Source #

showList :: [RpcConfigF Identity] -> ShowS Source #

Show (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Methods

showsPrec :: Int -> RpcConfigF Last -> ShowS Source #

show :: RpcConfigF Last -> String Source #

showList :: [RpcConfigF Last] -> ShowS Source #

Eq (RpcConfigF Identity) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Methods

(==) :: RpcConfigF Identity -> RpcConfigF Identity -> Bool Source #

(/=) :: RpcConfigF Identity -> RpcConfigF Identity -> Bool Source #

Eq (RpcConfigF Last) Source # 
Instance details

Defined in Cardano.Rpc.Server.Config

Methods

(==) :: RpcConfigF Last -> RpcConfigF Last -> Bool Source #

(/=) :: RpcConfigF Last -> RpcConfigF Last -> Bool Source #

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.