Modulesolana-haskell-sdk-1.3.0.0GHC2021

Network.Solana.RPC.HTTP.Types

This module defines shared types used in Solana RPC responses and configuration payloads. It includes generic RPC response envelopes, context metadata, and configuration options for request customization.

These types are reused across many Solana JSON-RPC methods and should be imported wherever Solana RPC requests or responses are constructed or parsed.

4 types
2 values

Packagesolana-haskell-sdk-1.3.0.0
Exports6
LanguageGHC2021
LicenceApache-2.0
SourceTypes.hs

RPCResponse

3 declarations

typetype Slot = Word64

Alias for a Solana slot number.

datadata Context

Contains contextual information returned with most Solana RPC responses.

Includes API version and the slot at which the response is valid.

Constructors

Context
- apiVersion :: Maybe Text
  API version string reported by the node (e.g. "2.1.16"); Nothing when the node omits it, as older nodes and some RPC proxies do.
- contextSlot :: Slot
  The slot at which the data in the response is valid.

Instances4Show, Generic, FromJSON, Rep

Show ContextDefined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types
Generic ContextDefined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types
FromJSON ContextDefined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types
type Rep Context = D1 ('MetaData "Context" "Network.Solana.RPC.HTTP.Types" "solana-haskell-sdk-1.3.0.0-JMJNnl7jmEh90dthY33ZzW" 'False) (C1 ('MetaCons "Context" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "contextSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Slot)))Defined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types

datadata RPCResponse a

Generic wrapper for Solana RPC responses that include a context and a value.

Many Solana RPC methods return a response shaped like:

{ "context": { ... }, "value": <data> }

Constructors

RPCResponse
- context :: Context
  Metadata about the cluster state at the time of the response.
- value :: a
  The actual value returned by the RPC method.

Instances2Show, FromJSON

Show a => Show (RPCResponse a)Defined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types
FromJSON a => FromJSON (RPCResponse a)Defined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types

ConfigurationObject

3 declarations

datadata ConfigurationObject

Configuration options used to customize Solana RPC requests.

Many RPC methods accept a configuration object to control encoding, commitment level, preflight behavior, and more.

Constructors

ConfigurationObject
- commitment :: Maybe String
  Optional commitment level (e.g. "finalized", "confirmed").
- encoding :: Maybe String
  Desired encoding for returned data (e.g. "base58", "base64", "jsonParsed"). Account data returned as "base64+zstd" is not decoded by AccountData and is rejected.
- dataSlice :: Maybe Object
  Optional partial data slice configuration.
- skipPreflight :: Maybe Bool
  Whether to skip preflight checks (use with caution).
- preflightCommitment :: Maybe String
  Commitment level used during preflight simulation.
- maxRetries :: Maybe Int
  Maximum number of retry attempts for transaction submission.
- minContextSlot :: Maybe Int
  Minimum slot that the RPC response must be based on.
- searchTransactionHistory :: Maybe Bool
  Whether to search older confirmed transaction history.
- maxSupportedTransactionVersion :: Maybe Int
  The maximum transaction version to return in responses. Required to fetch blocks or transactions containing versioned (v0) transactions; omitting it causes the RPC to reject them with error -32015.

Instances4Show, Generic, ToJSON, Rep

Show ConfigurationObjectDefined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types
Generic ConfigurationObjectDefined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types
ToJSON ConfigurationObjectDefined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types
type Rep ConfigurationObject = D1 ('MetaData "ConfigurationObject" "Network.Solana.RPC.HTTP.Types" "solana-haskell-sdk-1.3.0.0-JMJNnl7jmEh90dthY33ZzW" 'False) (C1 ('MetaCons "ConfigurationObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "commitment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "encoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String))) :*: (S1 ('MetaSel ('Just "dataSlice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Object)) :*: S1 ('MetaSel ('Just "skipPreflight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "preflightCommitment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "minContextSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "searchTransactionHistory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "maxSupportedTransactionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))))Defined in solana-haskell-sdk-1.3.0.0 · Network.Solana.RPC.HTTP.Types

valuedefaultConfigObject :: ConfigurationObject

A default configuration object with all fields set to Nothing.

Use this as a base and override fields selectively.

valuecfgJustEncodingBase64 :: ConfigurationObject

A basic configuration object that only sets the encoding to "base64".

Useful for methods that require base64-encoded input or output.