Safe Haskell	None
Language	Haskell2010

Bcc.CLI.Sophie.Commands

Contents

CLI command types
CLI flag types

Description

Sophie CLI command types

Synopsis

data SophieCommand
- = AddressCmd AddressCmd
- | StakeAddressCmd StakeAddressCmd
- | KeyCmd KeyCmd
- | TransactionCmd TransactionCmd
- | NodeCmd NodeCmd
- | PoolCmd PoolCmd
- | QueryCmd QueryCmd
- | GovernanceCmd GovernanceCmd
- | GenesisCmd GenesisCmd
- | TextViewCmd TextViewCmd
data AddressCmd
- = AddressKeyGen AddressKeyType VerificationKeyFile SigningKeyFile
- | AddressKeyHash VerificationKeyTextOrFile (Maybe OutputFile)
- | AddressBuild PaymentVerifier (Maybe StakeVerifier) NetworkId (Maybe OutputFile)
- | AddressBuildMultiSig ScriptFile NetworkId (Maybe OutputFile)
- | AddressInfo Text (Maybe OutputFile)
data StakeAddressCmd
- = StakeAddressKeyGen VerificationKeyFile SigningKeyFile
- | StakeAddressKeyHash (VerificationKeyOrFile StakeKey) (Maybe OutputFile)
- | StakeAddressBuild (VerificationKeyOrFile StakeKey) NetworkId (Maybe OutputFile)
- | StakeRegistrationCert StakeVerifier OutputFile
- | StakeCredentialDelegationCert StakeVerifier (VerificationKeyOrHashOrFile StakePoolKey) OutputFile
- | StakeCredentialDeRegistrationCert StakeVerifier OutputFile
data KeyCmd
- = KeyGetVerificationKey SigningKeyFile VerificationKeyFile
- | KeyNonExtendedKey VerificationKeyFile VerificationKeyFile
- | KeyConvertColeKey (Maybe Text) ColeKeyType SomeKeyFile OutputFile
- | KeyConvertColeGenesisVKey VerificationKeyBase64 OutputFile
- | KeyConvertColeVestedVKey VerificationKeyBase64 OutputFile
- | KeyConvertITNStakeKey SomeKeyFile OutputFile
- | KeyConvertITNExtendedToStakeKey SomeKeyFile OutputFile
- | KeyConvertITNBip32ToStakeKey SomeKeyFile OutputFile
- | KeyConvertBccAddressSigningKey BccAddressKeyType SigningKeyFile OutputFile
data TransactionCmd
- = TxBuildRaw AnyBccEra (Maybe ScriptValidity) [(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))] [TxIn] [WitnessSigningData] [TxOutAnyEra] (Maybe (Value, [ScriptWitnessFiles WitCtxMint])) (Maybe SlotNo) (Maybe SlotNo) (Maybe Entropic) [(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))] [(StakeAddress, Entropic, Maybe (ScriptWitnessFiles WitCtxStake))] TxMetadataJsonSchema [ScriptFile] [MetadataFile] (Maybe ProtocolParamsSourceSpec) (Maybe UpdateProposalFile) TxBodyFile
- | TxBuild AnyBccEra AnyConsensusModeParams NetworkId (Maybe ScriptValidity) (Maybe Word) [(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))] [WitnessSigningData] [TxIn] [TxOutAnyEra] TxOutChangeAddress (Maybe (Value, [ScriptWitnessFiles WitCtxMint])) (Maybe SlotNo) (Maybe SlotNo) [(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))] [(StakeAddress, Entropic, Maybe (ScriptWitnessFiles WitCtxStake))] TxMetadataJsonSchema [ScriptFile] [MetadataFile] (Maybe ProtocolParamsSourceSpec) (Maybe UpdateProposalFile) TxBodyFile
- | TxSign TxBodyFile [WitnessSigningData] (Maybe NetworkId) TxFile
- | TxCreateWitness TxBodyFile WitnessSigningData (Maybe NetworkId) OutputFile
- | TxAssembleTxBodyWitness TxBodyFile [WitnessFile] OutputFile
- | TxSubmit AnyConsensusModeParams NetworkId FilePath
- | TxMintedPolicyId ScriptFile
- | TxCalculateMinFee TxBodyFile (Maybe NetworkId) ProtocolParamsSourceSpec TxInCount TxOutCount TxSophieWitnessCount TxColeWitnessCount
- | TxCalculateMinRequiredUTxO AnyBccEra ProtocolParamsSourceSpec TxOutAnyEra
- | TxHashScriptData ScriptDataOrFile
- | TxGetTxId InputTxFile
- | TxView InputTxFile
data NodeCmd
- = NodeKeyGenCold VerificationKeyFile SigningKeyFile OpCertCounterFile
- | NodeKeyGenKES VerificationKeyFile SigningKeyFile
- | NodeKeyGenVRF VerificationKeyFile SigningKeyFile
- | NodeKeyHashVRF (VerificationKeyOrFile VrfKey) (Maybe OutputFile)
- | NodeNewCounter ColdVerificationKeyOrFile Word OpCertCounterFile
- | NodeIssueOpCert (VerificationKeyOrFile KesKey) SigningKeyFile OpCertCounterFile KESPeriod OutputFile
data PoolCmd
- = PoolRegistrationCert (VerificationKeyOrFile StakePoolKey) (VerificationKeyOrFile VrfKey) Entropic Entropic Rational (VerificationKeyOrFile StakeKey) [VerificationKeyOrFile StakeKey] [StakePoolRelay] (Maybe StakePoolMetadataReference) NetworkId OutputFile
- | PoolRetirementCert (VerificationKeyOrFile StakePoolKey) EpochNo OutputFile
- | PoolGetId (VerificationKeyOrFile StakePoolKey) OutputFormat
- | PoolMetadataHash PoolMetadataFile (Maybe OutputFile)
data QueryCmd
- = QueryProtocolParameters' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryTip AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryStakePools' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryStakeDistribution' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryStakeAddressInfo AnyConsensusModeParams StakeAddress NetworkId (Maybe OutputFile)
- | QueryUTxO' AnyConsensusModeParams QueryUTxOFilter NetworkId (Maybe OutputFile)
- | QueryDebugLedgerState' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryProtocolState' AnyConsensusModeParams NetworkId (Maybe OutputFile)
- | QueryStakeSnapshot' AnyConsensusModeParams NetworkId (Hash StakePoolKey)
- | QueryPoolParams' AnyConsensusModeParams NetworkId (Hash StakePoolKey)
data GovernanceCmd
- = GovernanceMIRPayStakeAddressesCertificate MIRPot [StakeAddress] [Entropic] OutputFile
- | GovernanceMIRTransfer Entropic OutputFile TransferDirection
- | GovernanceGenesisKeyDelegationCertificate (VerificationKeyOrHashOrFile GenesisKey) (VerificationKeyOrHashOrFile GenesisDelegateKey) (VerificationKeyOrHashOrFile VrfKey) OutputFile
- | GovernanceVestedKeyDelegationCertificate (VerificationKeyOrHashOrFile VestedKey) (VerificationKeyOrHashOrFile VestedDelegateKey) (VerificationKeyOrHashOrFile VrfKey) OutputFile
- | GovernanceUpdateProposal OutputFile EpochNo [VerificationKeyFile] ProtocolParametersUpdate
data GenesisCmd
- = GenesisCreate GenesisDir Word Word Word (Maybe SystemStart) (Maybe Entropic) NetworkId
- | GenesisCreateStaked GenesisDir Word Word Word Word Word (Maybe SystemStart) (Maybe Entropic) Entropic NetworkId Word Word Word
- | GenesisKeyGenGenesis VerificationKeyFile SigningKeyFile
- | GenesisKeyGenDelegate VerificationKeyFile SigningKeyFile OpCertCounterFile
- | GenesisKeyGenVested VerificationKeyFile SigningKeyFile
- | GenesisKeyGenVestedDelegate VerificationKeyFile SigningKeyFile OpCertCounterFile
- | GenesisKeyGenUTxO VerificationKeyFile SigningKeyFile
- | GenesisCmdKeyHash VerificationKeyFile
- | GenesisVerKey VerificationKeyFile SigningKeyFile
- | GenesisTxIn VerificationKeyFile NetworkId (Maybe OutputFile)
- | GenesisAddr VerificationKeyFile NetworkId (Maybe OutputFile)
- | GenesisHashFile GenesisFile
data TextViewCmd = TextViewInfo !FilePath (Maybe OutputFile)
renderSophieCommand ∷ SophieCommand → Text
data AddressKeyType
- = AddressKeySophie
- | AddressKeySophieExtended
- | AddressKeyCole
data ColeKeyType
- = ColePaymentKey ColeKeyFormat
- | ColeGenesisKey ColeKeyFormat
- | ColeGenesisVestedKey ColeKeyFormat
- | ColeVestedKey ColeKeyFormat
- | ColeDelegateKey ColeKeyFormat
- | ColeVestedDelegateKey ColeKeyFormat
data ColeKeyFormat
- = NonLegacyColeKeyFormat
- | LegacyColeKeyFormat
data BccAddressKeyType
- = BccAddressSophiePaymentKey
- | BccAddressSophieStakeKey
- | BccAddressIcarusPaymentKey
- | BccAddressColePaymentKey
newtype GenesisDir = GenesisDir FilePath
newtype VestedDir = VestedDir FilePath
newtype TxInCount = TxInCount Int
newtype TxOutCount = TxOutCount Int
newtype TxSophieWitnessCount = TxSophieWitnessCount Int
newtype TxColeWitnessCount = TxColeWitnessCount Int
data SomeKeyFile
- = AVerificationKeyFile VerificationKeyFile
- | ASigningKeyFile SigningKeyFile
newtype OpCertCounterFile = OpCertCounterFile FilePath
newtype OutputFile = OutputFile FilePath
newtype ProtocolParamsFile = ProtocolParamsFile FilePath
data ProtocolParamsSourceSpec
- = ParamsFromGenesis !GenesisFile
- | ParamsFromFile !ProtocolParamsFile
newtype WitnessFile = WitnessFile FilePath
newtype TxBodyFile = TxBodyFile FilePath
newtype TxFile = TxFile FilePath
data InputTxFile
- = InputTxBodyFile TxBodyFile
- | InputTxFile TxFile
newtype VerificationKeyBase64 = VerificationKeyBase64 String
newtype GenesisKeyFile = GenesisKeyFile FilePath
newtype VestedKeyFile = VestedKeyFile FilePath
data MetadataFile
- = MetadataFileJSON FilePath
- | MetadataFileCBOR FilePath
newtype PoolId = PoolId String
newtype PoolMetadataFile = PoolMetadataFile {
- unPoolMetadataFile ∷ FilePath
}
newtype PrivKeyFile = PrivKeyFile FilePath
newtype BlockId = BlockId String
data WitnessSigningData = KeyWitnessSigningData !SigningKeyFile !(Maybe (Address ColeAddr))
data ColdVerificationKeyOrFile
- = ColdStakePoolVerificationKey !(VerificationKey StakePoolKey)
- | ColdGenesisDelegateVerificationKey !(VerificationKey GenesisDelegateKey)
- | ColdGenesisVestedDelegateVerificationKey !(VerificationKey GenesisVestedDelegateKey)
- | ColdVestedDelegateVerificationKey !(VerificationKey VestedDelegateKey)
- | ColdVerificationKeyFile !VerificationKeyFile

CLI command types

data SophieCommand Source #

All the CLI subcommands under "sophie".

Instances

Instances details

Show SophieCommand Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → SophieCommand → ShowS Source # show ∷ SophieCommand → String Source # showList ∷ [SophieCommand] → ShowS Source #

data AddressCmd Source #

Instances

Instances details

Show AddressCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → AddressCmd → ShowS Source # show ∷ AddressCmd → String Source # showList ∷ [AddressCmd] → ShowS Source #

data StakeAddressCmd Source #

Instances

Instances details

Show StakeAddressCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → StakeAddressCmd → ShowS Source # show ∷ StakeAddressCmd → String Source # showList ∷ [StakeAddressCmd] → ShowS Source #

data KeyCmd Source #

Instances

Instances details

Show KeyCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → KeyCmd → ShowS Source # show ∷ KeyCmd → String Source # showList ∷ [KeyCmd] → ShowS Source #

data TransactionCmd Source #

Constructors

TxBuildRaw
Fields AnyBccEra (Maybe ScriptValidity) Mark script as expected to pass or fail validation [(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))] Transaction inputs with optional spending scripts [TxIn] Transaction inputs for collateral, only key witnesses, no scripts. [WitnessSigningData] Required signers [TxOutAnyEra] (Maybe (Value, [ScriptWitnessFiles WitCtxMint])) Multi-Asset value with script witness (Maybe SlotNo) Transaction lower bound (Maybe SlotNo) Transaction upper bound (Maybe Entropic) Tx fee [(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))] Certificates with potential script witness [(StakeAddress, Entropic, Maybe (ScriptWitnessFiles WitCtxStake))] TxMetadataJsonSchema [ScriptFile] Auxillary scripts [MetadataFile] (Maybe ProtocolParamsSourceSpec) (Maybe UpdateProposalFile) TxBodyFile
TxBuild	Like `TxBuildRaw` but without the fee, and with a change output.
Fields AnyBccEra AnyConsensusModeParams NetworkId (Maybe ScriptValidity) Mark script as expected to pass or fail validation (Maybe Word) Override the required number of tx witnesses [(TxIn, Maybe (ScriptWitnessFiles WitCtxTxIn))] Required signers [WitnessSigningData] Transaction inputs with optional spending scripts [TxIn] Transaction inputs for collateral, only key witnesses, no scripts. [TxOutAnyEra] Normal outputs TxOutChangeAddress A change output (Maybe (Value, [ScriptWitnessFiles WitCtxMint])) Multi-Asset value with script witness (Maybe SlotNo) Transaction lower bound (Maybe SlotNo) Transaction upper bound [(CertificateFile, Maybe (ScriptWitnessFiles WitCtxStake))] Certificates with potential script witness [(StakeAddress, Entropic, Maybe (ScriptWitnessFiles WitCtxStake))] Withdrawals with potential script witness TxMetadataJsonSchema [ScriptFile] Auxillary scripts [MetadataFile] (Maybe ProtocolParamsSourceSpec) (Maybe UpdateProposalFile) TxBodyFile
TxSign TxBodyFile [WitnessSigningData] (Maybe NetworkId) TxFile
TxCreateWitness TxBodyFile WitnessSigningData (Maybe NetworkId) OutputFile
TxAssembleTxBodyWitness TxBodyFile [WitnessFile] OutputFile
TxSubmit AnyConsensusModeParams NetworkId FilePath
TxMintedPolicyId ScriptFile
TxCalculateMinFee TxBodyFile (Maybe NetworkId) ProtocolParamsSourceSpec TxInCount TxOutCount TxSophieWitnessCount TxColeWitnessCount
TxCalculateMinRequiredUTxO AnyBccEra ProtocolParamsSourceSpec TxOutAnyEra
TxHashScriptData ScriptDataOrFile
TxGetTxId InputTxFile
TxView InputTxFile

Instances

Instances details

Show TransactionCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → TransactionCmd → ShowS Source # show ∷ TransactionCmd → String Source # showList ∷ [TransactionCmd] → ShowS Source #

data NodeCmd Source #

Instances

Instances details

Show NodeCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → NodeCmd → ShowS Source # show ∷ NodeCmd → String Source # showList ∷ [NodeCmd] → ShowS Source #

data PoolCmd Source #

Constructors

PoolRegistrationCert
Fields (VerificationKeyOrFile StakePoolKey) Stake pool verification key. (VerificationKeyOrFile VrfKey) VRF Verification key. Entropic Pool pledge. Entropic Pool cost. Rational Pool margin. (VerificationKeyOrFile StakeKey) Reward account verification staking key. [VerificationKeyOrFile StakeKey] Pool owner verification staking key(s). [StakePoolRelay] Stake pool relays. (Maybe StakePoolMetadataReference) Stake pool metadata. NetworkId OutputFile
PoolRetirementCert
Fields (VerificationKeyOrFile StakePoolKey) Stake pool verification key. EpochNo Epoch in which to retire the stake pool. OutputFile
PoolGetId (VerificationKeyOrFile StakePoolKey) OutputFormat
PoolMetadataHash PoolMetadataFile (Maybe OutputFile)

Instances

Instances details

Show PoolCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → PoolCmd → ShowS Source # show ∷ PoolCmd → String Source # showList ∷ [PoolCmd] → ShowS Source #

data QueryCmd Source #

Instances

Instances details

Show QueryCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → QueryCmd → ShowS Source # show ∷ QueryCmd → String Source # showList ∷ [QueryCmd] → ShowS Source #

data GovernanceCmd Source #

Instances

Instances details

Show GovernanceCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → GovernanceCmd → ShowS Source # show ∷ GovernanceCmd → String Source # showList ∷ [GovernanceCmd] → ShowS Source #

data GenesisCmd Source #

Instances

Instances details

Show GenesisCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → GenesisCmd → ShowS Source # show ∷ GenesisCmd → String Source # showList ∷ [GenesisCmd] → ShowS Source #

data TextViewCmd Source #

Constructors

TextViewInfo !FilePath (Maybe OutputFile)

Instances

Instances details

Show TextViewCmd Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → TextViewCmd → ShowS Source # show ∷ TextViewCmd → String Source # showList ∷ [TextViewCmd] → ShowS Source #

renderSophieCommand ∷ SophieCommand → Text Source #

CLI flag types

data AddressKeyType Source #

Constructors

AddressKeySophie
AddressKeySophieExtended
AddressKeyCole

Instances

Instances details

Show AddressKeyType Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → AddressKeyType → ShowS Source # show ∷ AddressKeyType → String Source # showList ∷ [AddressKeyType] → ShowS Source #

data ColeKeyType Source #

Constructors

ColePaymentKey ColeKeyFormat
ColeGenesisKey ColeKeyFormat
ColeGenesisVestedKey ColeKeyFormat
ColeVestedKey ColeKeyFormat
ColeDelegateKey ColeKeyFormat
ColeVestedDelegateKey ColeKeyFormat

Instances

Instances details

Show ColeKeyType Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → ColeKeyType → ShowS Source # show ∷ ColeKeyType → String Source # showList ∷ [ColeKeyType] → ShowS Source #

data ColeKeyFormat Source #

Constructors

NonLegacyColeKeyFormat
LegacyColeKeyFormat

Instances

Instances details

Show ColeKeyFormat Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → ColeKeyFormat → ShowS Source # show ∷ ColeKeyFormat → String Source # showList ∷ [ColeKeyFormat] → ShowS Source #

data BccAddressKeyType Source #

The type of bcc-address key.

Constructors

BccAddressSophiePaymentKey
BccAddressSophieStakeKey
BccAddressIcarusPaymentKey
BccAddressColePaymentKey

Instances

Instances details

Show BccAddressKeyType Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → BccAddressKeyType → ShowS Source # show ∷ BccAddressKeyType → String Source # showList ∷ [BccAddressKeyType] → ShowS Source #

newtype GenesisDir Source #

Constructors

GenesisDir FilePath

Instances

Instances details

Show GenesisDir Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → GenesisDir → ShowS Source # show ∷ GenesisDir → String Source # showList ∷ [GenesisDir] → ShowS Source #

newtype VestedDir Source #

Constructors

VestedDir FilePath

Instances

Instances details

Show VestedDir Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → VestedDir → ShowS Source # show ∷ VestedDir → String Source # showList ∷ [VestedDir] → ShowS Source #

newtype TxInCount Source #

Constructors

TxInCount Int

Instances

Instances details

Show TxInCount Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → TxInCount → ShowS Source # show ∷ TxInCount → String Source # showList ∷ [TxInCount] → ShowS Source #

newtype TxOutCount Source #

Constructors

TxOutCount Int

Instances

Instances details

Show TxOutCount Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → TxOutCount → ShowS Source # show ∷ TxOutCount → String Source # showList ∷ [TxOutCount] → ShowS Source #

newtype TxSophieWitnessCount Source #

Constructors

TxSophieWitnessCount Int

Instances

Instances details

Show TxSophieWitnessCount Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → TxSophieWitnessCount → ShowS Source # show ∷ TxSophieWitnessCount → String Source # showList ∷ [TxSophieWitnessCount] → ShowS Source #

newtype TxColeWitnessCount Source #

Constructors

TxColeWitnessCount Int

Instances

Instances details

Show TxColeWitnessCount Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → TxColeWitnessCount → ShowS Source # show ∷ TxColeWitnessCount → String Source # showList ∷ [TxColeWitnessCount] → ShowS Source #

data SomeKeyFile Source #

Either a verification or signing key, used for conversions and other commands that make sense for both.

Constructors

AVerificationKeyFile VerificationKeyFile
ASigningKeyFile SigningKeyFile

Instances

Instances details

Show SomeKeyFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → SomeKeyFile → ShowS Source # show ∷ SomeKeyFile → String Source # showList ∷ [SomeKeyFile] → ShowS Source #

newtype OpCertCounterFile Source #

Constructors

OpCertCounterFile FilePath

Instances

Instances details

Show OpCertCounterFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → OpCertCounterFile → ShowS Source # show ∷ OpCertCounterFile → String Source # showList ∷ [OpCertCounterFile] → ShowS Source #

newtype OutputFile Source #

Constructors

OutputFile FilePath

Instances

Instances details

Show OutputFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → OutputFile → ShowS Source # show ∷ OutputFile → String Source # showList ∷ [OutputFile] → ShowS Source #

newtype ProtocolParamsFile Source #

Constructors

ProtocolParamsFile FilePath

Instances

Instances details

Eq ProtocolParamsFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods (==) ∷ ProtocolParamsFile → ProtocolParamsFile → Bool Source # (/=) ∷ ProtocolParamsFile → ProtocolParamsFile → Bool Source #
Show ProtocolParamsFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → ProtocolParamsFile → ShowS Source # show ∷ ProtocolParamsFile → String Source # showList ∷ [ProtocolParamsFile] → ShowS Source #

data ProtocolParamsSourceSpec Source #

Constructors

ParamsFromGenesis !GenesisFile	We allow an appropriately forewarned user to obtain protocol params directly from the genesis file, which allows them to avoid running the node in case they would like to estimate the fee using the blockchain's initial protocol parameters.
ParamsFromFile !ProtocolParamsFile	Obtain protocol parameters from a file structured by the 'bcc-api' `ProtocolParameters` data type.

Instances

Instances details

Show ProtocolParamsSourceSpec Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → ProtocolParamsSourceSpec → ShowS Source # show ∷ ProtocolParamsSourceSpec → String Source # showList ∷ [ProtocolParamsSourceSpec] → ShowS Source #

newtype WitnessFile Source #

Constructors

WitnessFile FilePath

Instances

Instances details

Show WitnessFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → WitnessFile → ShowS Source # show ∷ WitnessFile → String Source # showList ∷ [WitnessFile] → ShowS Source #

newtype TxBodyFile Source #

Constructors

TxBodyFile FilePath

Instances

Instances details

Show TxBodyFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → TxBodyFile → ShowS Source # show ∷ TxBodyFile → String Source # showList ∷ [TxBodyFile] → ShowS Source #

newtype TxFile Source #

Constructors

TxFile FilePath

Instances

Instances details

Show TxFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → TxFile → ShowS Source # show ∷ TxFile → String Source # showList ∷ [TxFile] → ShowS Source #

data InputTxFile Source #

Constructors

InputTxBodyFile TxBodyFile
InputTxFile TxFile

Instances

Instances details

Show InputTxFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → InputTxFile → ShowS Source # show ∷ InputTxFile → String Source # showList ∷ [InputTxFile] → ShowS Source #

newtype VerificationKeyBase64 Source #

A raw verification key given in Base64, and decoded into a ByteString.

Constructors

VerificationKeyBase64 String

Instances

Instances details

Show VerificationKeyBase64 Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → VerificationKeyBase64 → ShowS Source # show ∷ VerificationKeyBase64 → String Source # showList ∷ [VerificationKeyBase64] → ShowS Source #

newtype GenesisKeyFile Source #

Constructors

GenesisKeyFile FilePath

Instances

Instances details

Show GenesisKeyFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → GenesisKeyFile → ShowS Source # show ∷ GenesisKeyFile → String Source # showList ∷ [GenesisKeyFile] → ShowS Source #

newtype VestedKeyFile Source #

Constructors

VestedKeyFile FilePath

Instances

Instances details

Show VestedKeyFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → VestedKeyFile → ShowS Source # show ∷ VestedKeyFile → String Source # showList ∷ [VestedKeyFile] → ShowS Source #

data MetadataFile Source #

Constructors

MetadataFileJSON FilePath
MetadataFileCBOR FilePath

Instances

Instances details

Show MetadataFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → MetadataFile → ShowS Source # show ∷ MetadataFile → String Source # showList ∷ [MetadataFile] → ShowS Source #

newtype PoolId Source #

Constructors

PoolId String

Instances

Instances details

Show PoolId Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → PoolId → ShowS Source # show ∷ PoolId → String Source # showList ∷ [PoolId] → ShowS Source #

newtype PoolMetadataFile Source #

Constructors

PoolMetadataFile
Fields unPoolMetadataFile ∷ FilePath

Instances

Instances details

Show PoolMetadataFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → PoolMetadataFile → ShowS Source # show ∷ PoolMetadataFile → String Source # showList ∷ [PoolMetadataFile] → ShowS Source #

newtype PrivKeyFile Source #

Constructors

PrivKeyFile FilePath

Instances

Instances details

Show PrivKeyFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → PrivKeyFile → ShowS Source # show ∷ PrivKeyFile → String Source # showList ∷ [PrivKeyFile] → ShowS Source #

newtype BlockId Source #

Constructors

BlockId String

Instances

Instances details

Show BlockId Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → BlockId → ShowS Source # show ∷ BlockId → String Source # showList ∷ [BlockId] → ShowS Source #

data WitnessSigningData Source #

Data required to construct a witness.

Constructors

KeyWitnessSigningData
Fields !SigningKeyFile Path to a file that should contain a signing key. !(Maybe (Address ColeAddr)) An optionally specified Cole address. If specified, both the network ID and derivation path are extracted from the address and used in the construction of the Cole witness.

Instances

Instances details

Show WitnessSigningData Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → WitnessSigningData → ShowS Source # show ∷ WitnessSigningData → String Source # showList ∷ [WitnessSigningData] → ShowS Source #

data ColdVerificationKeyOrFile Source #

Either a stake pool verification key, genesis delegate verification key, or a path to a cold verification key file.

Note that a "cold verification key" refers to either a stake pool or genesis delegate verification key.

TODO: A genesis delegate extended key should also be valid here.

Constructors

ColdStakePoolVerificationKey !(VerificationKey StakePoolKey)
ColdGenesisDelegateVerificationKey !(VerificationKey GenesisDelegateKey)
ColdGenesisVestedDelegateVerificationKey !(VerificationKey GenesisVestedDelegateKey)
ColdVestedDelegateVerificationKey !(VerificationKey VestedDelegateKey)
ColdVerificationKeyFile !VerificationKeyFile

Instances

Instances details

Show ColdVerificationKeyOrFile Source #
Instance details Defined in Bcc.CLI.Sophie.Commands Methods showsPrec ∷ Int → ColdVerificationKeyOrFile → ShowS Source # show ∷ ColdVerificationKeyOrFile → String Source # showList ∷ [ColdVerificationKeyOrFile] → ShowS Source #

AddressCmd AddressCmd
StakeAddressCmd StakeAddressCmd
KeyCmd KeyCmd
TransactionCmd TransactionCmd
NodeCmd NodeCmd
PoolCmd PoolCmd
QueryCmd QueryCmd
GovernanceCmd GovernanceCmd
GenesisCmd GenesisCmd
TextViewCmd TextViewCmd

AddressKeyGen AddressKeyType VerificationKeyFile SigningKeyFile
AddressKeyHash VerificationKeyTextOrFile (Maybe OutputFile)
AddressBuild PaymentVerifier (Maybe StakeVerifier) NetworkId (Maybe OutputFile)
AddressBuildMultiSig ScriptFile NetworkId (Maybe OutputFile)
AddressInfo Text (Maybe OutputFile)

StakeAddressKeyGen VerificationKeyFile SigningKeyFile
StakeAddressKeyHash (VerificationKeyOrFile StakeKey) (Maybe OutputFile)
StakeAddressBuild (VerificationKeyOrFile StakeKey) NetworkId (Maybe OutputFile)
StakeRegistrationCert StakeVerifier OutputFile
StakeCredentialDelegationCert StakeVerifier (VerificationKeyOrHashOrFile StakePoolKey) OutputFile
StakeCredentialDeRegistrationCert StakeVerifier OutputFile

KeyGetVerificationKey SigningKeyFile VerificationKeyFile
KeyNonExtendedKey VerificationKeyFile VerificationKeyFile
KeyConvertColeKey (Maybe Text) ColeKeyType SomeKeyFile OutputFile
KeyConvertColeGenesisVKey VerificationKeyBase64 OutputFile
KeyConvertColeVestedVKey VerificationKeyBase64 OutputFile
KeyConvertITNStakeKey SomeKeyFile OutputFile
KeyConvertITNExtendedToStakeKey SomeKeyFile OutputFile
KeyConvertITNBip32ToStakeKey SomeKeyFile OutputFile
KeyConvertBccAddressSigningKey BccAddressKeyType SigningKeyFile OutputFile

NodeKeyGenCold VerificationKeyFile SigningKeyFile OpCertCounterFile
NodeKeyGenKES VerificationKeyFile SigningKeyFile
NodeKeyGenVRF VerificationKeyFile SigningKeyFile
NodeKeyHashVRF (VerificationKeyOrFile VrfKey) (Maybe OutputFile)
NodeNewCounter ColdVerificationKeyOrFile Word OpCertCounterFile
NodeIssueOpCert (VerificationKeyOrFile KesKey) SigningKeyFile OpCertCounterFile KESPeriod OutputFile

QueryProtocolParameters' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryTip AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryStakePools' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryStakeDistribution' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryStakeAddressInfo AnyConsensusModeParams StakeAddress NetworkId (Maybe OutputFile)
QueryUTxO' AnyConsensusModeParams QueryUTxOFilter NetworkId (Maybe OutputFile)
QueryDebugLedgerState' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryProtocolState' AnyConsensusModeParams NetworkId (Maybe OutputFile)
QueryStakeSnapshot' AnyConsensusModeParams NetworkId (Hash StakePoolKey)
QueryPoolParams' AnyConsensusModeParams NetworkId (Hash StakePoolKey)

GovernanceMIRPayStakeAddressesCertificate MIRPot [StakeAddress] [Entropic] OutputFile
GovernanceMIRTransfer Entropic OutputFile TransferDirection
GovernanceGenesisKeyDelegationCertificate (VerificationKeyOrHashOrFile GenesisKey) (VerificationKeyOrHashOrFile GenesisDelegateKey) (VerificationKeyOrHashOrFile VrfKey) OutputFile
GovernanceVestedKeyDelegationCertificate (VerificationKeyOrHashOrFile VestedKey) (VerificationKeyOrHashOrFile VestedDelegateKey) (VerificationKeyOrHashOrFile VrfKey) OutputFile
GovernanceUpdateProposal OutputFile EpochNo [VerificationKeyFile] ProtocolParametersUpdate

GenesisCreate GenesisDir Word Word Word (Maybe SystemStart) (Maybe Entropic) NetworkId
GenesisCreateStaked GenesisDir Word Word Word Word Word (Maybe SystemStart) (Maybe Entropic) Entropic NetworkId Word Word Word
GenesisKeyGenGenesis VerificationKeyFile SigningKeyFile
GenesisKeyGenDelegate VerificationKeyFile SigningKeyFile OpCertCounterFile
GenesisKeyGenVested VerificationKeyFile SigningKeyFile
GenesisKeyGenVestedDelegate VerificationKeyFile SigningKeyFile OpCertCounterFile
GenesisKeyGenUTxO VerificationKeyFile SigningKeyFile
GenesisCmdKeyHash VerificationKeyFile
GenesisVerKey VerificationKeyFile SigningKeyFile
GenesisTxIn VerificationKeyFile NetworkId (Maybe OutputFile)
GenesisAddr VerificationKeyFile NetworkId (Maybe OutputFile)
GenesisHashFile GenesisFile