Copyright | © 2018-2020 IOHK |
---|---|
License | Apache-2.0 |
Safe Haskell | None |
Language | Haskell2010 |
Cardano.Wallet.Api.Types
Description
API type representations of various types. We define here pretty much all our user-facing types that are mostly composed with internal / primitive types.
This module also define required API instances (JSON, HttpApiData...) for all those types, making sure to match the specification document:
Synopsis
- data WalletStyle
- data ByronWalletStyle
- type family StyleSymbol (style :: ByronWalletStyle ) :: Symbol where ...
- type family AllowedMnemonics (style :: k) :: [ Nat ]
- fmtAllowedWords :: ByronWalletStyle -> String
-
data
ApiAsset
=
ApiAsset
{
- policyId :: ApiT TokenPolicyId
- assetName :: ApiT TokenName
- fingerprint :: ApiT TokenFingerprint
- metadata :: Maybe ApiAssetMetadata
- metadataError :: Maybe ApiMetadataError
- toApiAsset :: Either TokenMetadataError ( Maybe AssetMetadata ) -> AssetId -> ApiAsset
- data ApiAssetMetadata = ApiAssetMetadata { }
- toApiAssetMetadata :: AssetMetadata -> ApiAssetMetadata
-
data
ApiAddress
(n ::
NetworkDiscriminant
) =
ApiAddress
{
- id :: !( ApiT Address , Proxy n)
- state :: !( ApiT AddressState )
- derivationPath :: NonEmpty ( ApiT DerivationIndex )
- data ApiCredential
-
data
ApiAddressData
=
ApiAddressData
{
- address :: ! ApiAddressDataPayload
- validationLevel :: !( Maybe ( ApiT ValidationLevel ))
- data ApiAddressDataPayload
-
data
AnyAddress
=
AnyAddress
{
- payload :: ByteString
- flavour :: AnyAddressType
- network :: Int
- data AnyAddressType
-
data
ApiCertificate
- = RegisterRewardAccount { }
-
|
JoinPool
{
- rewardAccountPath :: NonEmpty ( ApiT DerivationIndex )
- pool :: ApiT PoolId
- | QuitPool { }
- data ApiDelegationAction
-
data
ApiEpochInfo
=
ApiEpochInfo
{
- epochNumber :: !( ApiT EpochNo )
- epochStartTime :: ! UTCTime
- toApiEpochInfo :: EpochNo -> Qry ApiEpochInfo
- data ApiSelectCoinsData (n :: NetworkDiscriminant )
-
data
ApiSelectCoinsPayments
(n ::
NetworkDiscriminant
) =
ApiSelectCoinsPayments
{
- payments :: NonEmpty (ApiTxOutput n)
- withdrawal :: !( Maybe ApiWithdrawalPostData )
- metadata :: !( Maybe ( ApiT TxMetadata ))
- newtype ApiSelectCoinsAction = ApiSelectCoinsAction { }
-
data
ApiMintBurnOperation
(n ::
NetworkDiscriminant
)
- = ApiMint ( ApiMintData n)
- | ApiBurn ApiBurnData
- data ApiMintData (n :: NetworkDiscriminant ) = ApiMintData { }
- newtype ApiBurnData = ApiBurnData { }
-
data
ApiCoinSelection
(n ::
NetworkDiscriminant
) =
ApiCoinSelection
{
- inputs :: ![ ApiWalletInput n]
- outputs :: ![ ApiCoinSelectionOutput n]
- change :: ![ ApiCoinSelectionChange n]
- collateral :: ![ ApiCoinSelectionCollateral n]
- withdrawals :: ![ ApiCoinSelectionWithdrawal n]
- certificates :: Maybe ( NonEmpty ApiCertificate )
- depositsTaken :: ![ Quantity "lovelace" Natural ]
- depositsReturned :: ![ Quantity "lovelace" Natural ]
- metadata :: !( Maybe ApiBase64 )
- data ApiCoinSelectionChange (n :: NetworkDiscriminant ) = ApiCoinSelectionChange { }
- data ApiCoinSelectionCollateral (n :: NetworkDiscriminant ) = ApiCoinSelectionCollateral { }
- data ApiCoinSelectionOutput (n :: NetworkDiscriminant ) = ApiCoinSelectionOutput { }
-
data
ApiCoinSelectionWithdrawal
n =
ApiCoinSelectionWithdrawal
{
- stakeAddress :: !( ApiT RewardAccount , Proxy n)
- derivationPath :: !( NonEmpty ( ApiT DerivationIndex ))
- amount :: !( Quantity "lovelace" Natural )
- type ApiBase64 = ApiBytesT ' Base64 ByteString
-
data
ApiMintBurnData
(n ::
NetworkDiscriminant
) =
ApiMintBurnData
{
- policyScriptTemplate :: !( ApiT ( Script Cosigner ))
- assetName :: !( Maybe ( ApiT TokenName ))
- operation :: !( ApiMintBurnOperation n)
-
data
ApiStakePool
=
ApiStakePool
{
- id :: !( ApiT PoolId )
- metrics :: ! ApiStakePoolMetrics
- metadata :: !( Maybe ( ApiT StakePoolMetadata ))
- cost :: !( Quantity "lovelace" Natural )
- margin :: !( Quantity "percent" Percentage )
- pledge :: !( Quantity "lovelace" Natural )
- retirement :: !( Maybe ApiEpochInfo )
- flags :: ![ ApiStakePoolFlag ]
-
data
ApiStakePoolMetrics
=
ApiStakePoolMetrics
{
- nonMyopicMemberRewards :: !( Quantity "lovelace" Natural )
- relativeStake :: !( Quantity "percent" Percentage )
- saturation :: ! Double
- producedBlocks :: !( Quantity "block" Natural )
- data ApiStakePoolFlag = Delisted
-
data
ApiWallet
=
ApiWallet
{
- id :: !( ApiT WalletId )
- addressPoolGap :: !( ApiT AddressPoolGap )
- balance :: ! ApiWalletBalance
- assets :: ! ApiWalletAssetsBalance
- delegation :: ! ApiWalletDelegation
- name :: !( ApiT WalletName )
- passphrase :: !( Maybe ApiWalletPassphraseInfo )
- state :: !( ApiT SyncProgress )
- tip :: ! ApiBlockReference
- data ApiWalletBalance = ApiWalletBalance { }
- data ApiWalletAssetsBalance = ApiWalletAssetsBalance { }
- data ApiWalletMode
-
newtype
ApiWalletPassphrase
=
ApiWalletPassphrase
{
- passphrase :: ApiT ( Passphrase "lenient")
- newtype ApiWalletPassphraseInfo = ApiWalletPassphraseInfo { }
- newtype ApiWalletUtxoSnapshot = ApiWalletUtxoSnapshot { }
- data ApiWalletUtxoSnapshotEntry = ApiWalletUtxoSnapshotEntry { }
- data ApiUtxoStatistics = ApiUtxoStatistics { }
- toApiUtxoStatistics :: UTxOStatistics -> ApiUtxoStatistics
-
data
WalletPostData
=
WalletPostData
{
- addressPoolGap :: !( Maybe ( ApiT AddressPoolGap ))
- mnemonicSentence :: !( ApiMnemonicT ( AllowedMnemonics ' Shelley ))
- mnemonicSecondFactor :: !( Maybe ( ApiMnemonicT ( AllowedMnemonics 'SndFactor)))
- name :: !( ApiT WalletName )
- passphrase :: !( ApiT ( Passphrase "user"))
-
newtype
WalletPutData
=
WalletPutData
{
- name :: Maybe ( ApiT WalletName )
- newtype SettingsPutData = SettingsPutData { }
- newtype WalletPutPassphraseData = WalletPutPassphraseData ( Either WalletPutPassphraseOldPassphraseData WalletPutPassphraseMnemonicData )
-
data
WalletPutPassphraseOldPassphraseData
=
WalletPutPassphraseOldPassphraseData
{
- oldPassphrase :: !( ApiT ( Passphrase "user"))
- newPassphrase :: !( ApiT ( Passphrase "user"))
-
data
WalletPutPassphraseMnemonicData
=
WalletPutPassphraseMnemonicData
{
- mnemonicSentence :: !( ApiMnemonicT ( AllowedMnemonics ' Shelley ))
- mnemonicSecondFactor :: !( Maybe ( ApiMnemonicT ( AllowedMnemonics 'SndFactor)))
- newPassphrase :: !( ApiT ( Passphrase "user"))
-
data
ApiSignTransactionPostData
=
ApiSignTransactionPostData
{
- transaction :: !( ApiT SealedTx )
- passphrase :: !( ApiT ( Passphrase "lenient"))
-
data
PostTransactionOldData
(n ::
NetworkDiscriminant
) =
PostTransactionOldData
{
- payments :: !( NonEmpty (ApiTxOutput n))
- passphrase :: !( ApiT ( Passphrase "lenient"))
- withdrawal :: !( Maybe ApiWithdrawalPostData )
- metadata :: !( Maybe TxMetadataWithSchema )
- timeToLive :: !( Maybe ( Quantity "second" NominalDiffTime ))
-
data
PostTransactionFeeOldData
(n ::
NetworkDiscriminant
) =
PostTransactionFeeOldData
{
- payments :: !( NonEmpty (ApiTxOutput n))
- withdrawal :: !( Maybe ApiWithdrawalPostData )
- metadata :: !( Maybe TxMetadataWithSchema )
- timeToLive :: !( Maybe ( Quantity "second" NominalDiffTime ))
- newtype ApiSerialisedTransaction = ApiSerialisedTransaction { }
-
data
ApiTransaction
(n ::
NetworkDiscriminant
) =
ApiTransaction
{
- id :: !( ApiT ( Hash "Tx"))
- amount :: !( Quantity "lovelace" Natural )
- fee :: !( Quantity "lovelace" Natural )
- depositTaken :: !( Quantity "lovelace" Natural )
- depositReturned :: !( Quantity "lovelace" Natural )
- insertedAt :: !( Maybe ApiBlockReference )
- pendingSince :: !( Maybe ApiBlockReference )
- expiresAt :: !( Maybe ApiSlotReference )
- depth :: !( Maybe ( Quantity "block" Natural ))
- direction :: !( ApiT Direction )
- inputs :: ![ ApiTxInput n]
- outputs :: ![ApiTxOutput n]
- collateral :: ![ ApiTxCollateral n]
- collateralOutputs :: !( ApiAsArray "collateral_outputs" ( Maybe (ApiTxOutput n)))
- withdrawals :: ![ ApiWithdrawal n]
- status :: !( ApiT TxStatus )
- metadata :: !( Maybe TxMetadataWithSchema )
- scriptValidity :: !( Maybe ( ApiT TxScriptValidity ))
-
data
ApiWithdrawalPostData
- = SelfWithdrawal
- | ExternalWithdrawal ( ApiMnemonicT '[15, 18, 21, 24])
- newtype ApiMaintenanceAction = ApiMaintenanceAction { }
- newtype ApiMaintenanceActionPostData = ApiMaintenanceActionPostData { }
- data MaintenanceAction = GcStakePools
-
data
ApiFee
=
ApiFee
{
- estimatedMin :: !( Quantity "lovelace" Natural )
- estimatedMax :: !( Quantity "lovelace" Natural )
- minimumCoins :: ![ Quantity "lovelace" Natural ]
- deposit :: !( Quantity "lovelace" Natural )
- data ApiTxCollateral (n :: NetworkDiscriminant ) = ApiTxCollateral { }
- newtype ApiTxId = ApiTxId { }
- data ApiTxInput (n :: NetworkDiscriminant ) = ApiTxInput { }
-
newtype
ApiTxMetadata
=
ApiTxMetadata
{
- getApiTxMetadata :: Maybe ( ApiT TxMetadata )
- data AddressAmount addr = AddressAmount { }
- data AddressAmountNoAssets addr = AddressAmountNoAssets { }
- newtype ApiAddressInspect = ApiAddressInspect { }
- newtype ApiAddressInspectData = ApiAddressInspectData { }
-
data
ApiErrorCode
- = AddressAlreadyExists
- | AlreadyWithdrawing
- | AssetNameTooLong
- | AssetNotPresent
- | BadRequest
- | BalanceTxByronNotSupported
- | BalanceTxConflictingNetworks
- | BalanceTxExistingCollateral
- | BalanceTxExistingKeyWitnesses
- | BalanceTxExistingReturnCollateral
- | BalanceTxExistingTotalCollateral
- | BalanceTxInternalError
- | BalanceTxMaxSizeLimitExceeded
- | BalanceTxUnderestimatedFee
- | BalanceTxZeroAdaOutput
- | CannotCoverFee
- | CreatedInvalidTransaction
- | CreatedMultiaccountTransaction
- | CreatedMultidelegationTransaction
- | CreatedWrongPolicyScriptTemplate
- | ExistingKeyWitnesses
- | ForeignTransaction
- | HardenedDerivationRequired
- | InputsDepleted
- | InsufficientCollateral
- | InvalidCoinSelection
- | InvalidWalletType
- | InvalidValidityBounds
- | KeyNotFoundForAddress
- | MalformedTxPayload
- | MethodNotAllowed
- | MinWithdrawalWrong
- | MintOrBurnAssetQuantityOutOfBounds
- | MissingPolicyPublicKey
- | MissingWitnessesInTransaction
- | NetworkMisconfigured
- | NetworkQueryFailed
- | NetworkUnreachable
- | NoRootKey
- | NoSuchPool
- | NoSuchTransaction
- | NoSuchWallet
- | NonNullRewards
- | NotAcceptable
- | NotDelegatingTo
- | NotEnoughMoney
- | NotFound
- | NotImplemented
- | NotSynced
- | NothingToMigrate
- | OutputTokenBundleSizeExceedsLimit
- | OutputTokenQuantityExceedsLimit
- | PastHorizon
- | PoolAlreadyJoined
- | QueryParamMissing
- | RedeemerInvalidData
- | RedeemerScriptFailure
- | RedeemerTargetNotFound
- | RejectedByCoreNode
- | SharedWalletCannotUpdateKey
- | SharedWalletKeyAlreadyExists
- | SharedWalletNoDelegationTemplate
- | SharedWalletNoSuchCosigner
- | SharedWalletNotPending
- | SharedWalletPending
- | SharedWalletScriptTemplateInvalid
- | SoftDerivationRequired
- | StartTimeLaterThanEndTime
- | TokensMintedButNotSpentOrBurned
- | TransactionAlreadyBalanced
- | TransactionAlreadyInLedger
- | TransactionIsTooBig
- | TranslationError
- | UnableToAssignInputOutput
- | UnableToDetermineCurrentEpoch
- | UnexpectedError
- | UnresolvedInputs
- | UnsupportedMediaType
- | UtxoTooSmall
- | WalletAlreadyExists
- | WalletNotResponding
- | WithdrawalNotWorth
- | WrongEncryptionPassphrase
- | WrongMnemonic
- | ValidityIntervalNotInsideScriptTimelock
-
data
ApiNetworkInformation
=
ApiNetworkInformation
{
- syncProgress :: !( ApiT SyncProgress )
- nextEpoch :: !( Maybe ApiEpochInfo )
- nodeTip :: ! ApiBlockReference
- networkTip :: !( Maybe ApiSlotReference )
- nodeEra :: ! ApiEra
- networkInfo :: ! ApiNetworkInfo
- walletMode :: ! ApiWalletMode
-
data
ApiEra
- = ApiByron
- | ApiShelley
- | ApiAllegra
- | ApiMary
- | ApiAlonzo
- | ApiBabbage
- toApiEra :: AnyCardanoEra -> ApiEra
- fromApiEra :: ApiEra -> AnyCardanoEra
- data ApiNtpStatus = ApiNtpStatus { }
- data NtpSyncingStatus
- newtype ApiNetworkClock = ApiNetworkClock { }
- data ApiSlotReference = ApiSlotReference { }
-
data
ApiSlotId
=
ApiSlotId
{
- epochNumber :: !( ApiT EpochNo )
- slotNumber :: !( ApiT SlotInEpoch )
-
data
ApiBlockReference
=
ApiBlockReference
{
- absoluteSlotNumber :: !( ApiT SlotNo )
- slotId :: ! ApiSlotId
- time :: ! UTCTime
- block :: ! ApiBlockInfo
- newtype ApiBlockInfo = ApiBlockInfo { }
-
data
ApiStakeKeys
(n ::
NetworkDiscriminant
) =
ApiStakeKeys
{
- _ours :: ![ ApiOurStakeKey n]
- _foreign :: ![ ApiForeignStakeKey n]
- _none :: ! ApiNullStakeKey
-
data
ApiOurStakeKey
(n ::
NetworkDiscriminant
) =
ApiOurStakeKey
{
- _index :: ! Natural
- _key :: !( ApiT RewardAccount , Proxy n)
- _stake :: !( Quantity "lovelace" Natural )
- _rewardBalance :: !( Quantity "lovelace" Natural )
- _delegation :: ! ApiWalletDelegation
-
data
ApiForeignStakeKey
(n ::
NetworkDiscriminant
) =
ApiForeignStakeKey
{
- _key :: !( ApiT RewardAccount , Proxy n)
- _stake :: !( Quantity "lovelace" Natural )
- _rewardBalance :: !( Quantity "lovelace" Natural )
- newtype ApiNullStakeKey = ApiNullStakeKey { }
- newtype Iso8601Time = Iso8601Time { }
- newtype MinWithdrawal = MinWithdrawal { }
-
data
ApiNetworkParameters
=
ApiNetworkParameters
{
- genesisBlockHash :: !( ApiT ( Hash "Genesis"))
- blockchainStartTime :: !( ApiT StartTime )
- slotLength :: !( Quantity "second" NominalDiffTime )
- epochLength :: !( Quantity "slot" Word32 )
- securityParameter :: !( Quantity "block" Word32 )
- activeSlotCoefficient :: !( Quantity "percent" Double )
- decentralizationLevel :: !( Quantity "percent" Percentage )
- desiredPoolNumber :: ! Word16
- minimumUtxoValue :: !( Quantity "lovelace" Natural )
- maximumTokenBundleSize :: !( Quantity "byte" Natural )
- eras :: ! ApiEraInfo
- maximumCollateralInputCount :: ! Word16
- minimumCollateralPercentage :: ! Natural
- executionUnitPrices :: !( Maybe ExecutionUnitPrices )
-
data
ApiNetworkInfo
=
ApiNetworkInfo
{
- networkId :: ! Text
- protocolMagic :: ! Integer
- toApiNetworkParameters :: Monad m => NetworkParameters -> TxConstraints -> ( EpochNo -> m ApiEpochInfo ) -> m ApiNetworkParameters
-
data
ApiEraInfo
=
ApiEraInfo
{
- byron :: !( Maybe ApiEpochInfo )
- shelley :: !( Maybe ApiEpochInfo )
- allegra :: !( Maybe ApiEpochInfo )
- mary :: !( Maybe ApiEpochInfo )
- alonzo :: !( Maybe ApiEpochInfo )
- babbage :: !( Maybe ApiEpochInfo )
-
data
ApiWalletDelegation
=
ApiWalletDelegation
{
- active :: ! ApiWalletDelegationNext
- next :: ![ ApiWalletDelegationNext ]
- data ApiWalletDelegationStatus
-
data
ApiWalletDelegationNext
=
ApiWalletDelegationNext
{
- status :: ! ApiWalletDelegationStatus
- target :: !( Maybe ( ApiT PoolId ))
- changesAt :: !( Maybe ApiEpochInfo )
- data ApiPoolId
- newtype ApiWalletMigrationPlanPostData (n :: NetworkDiscriminant ) = ApiWalletMigrationPlanPostData { }
-
data
ApiWalletMigrationPostData
(n ::
NetworkDiscriminant
) (s ::
Symbol
) =
ApiWalletMigrationPostData
{
- passphrase :: !( ApiT ( Passphrase s))
- addresses :: !( NonEmpty ( ApiT Address , Proxy n))
- data ApiWalletMigrationBalance = ApiWalletMigrationBalance { }
-
data
ApiWalletMigrationPlan
(n ::
NetworkDiscriminant
) =
ApiWalletMigrationPlan
{
- selections :: !( NonEmpty ( ApiCoinSelection n))
- totalFee :: Quantity "lovelace" Natural
- balanceLeftover :: ApiWalletMigrationBalance
- balanceSelected :: ApiWalletMigrationBalance
-
data
ApiWithdrawal
n =
ApiWithdrawal
{
- stakeAddress :: !( ApiT RewardAccount , Proxy n)
- amount :: !( Quantity "lovelace" Natural )
-
data
ApiWalletSignData
=
ApiWalletSignData
{
- metadata :: ApiT TxMetadata
- passphrase :: ApiT ( Passphrase "lenient")
-
data
ApiVerificationKeyShelley
=
ApiVerificationKeyShelley
{
- getApiVerificationKey :: ( ByteString , Role )
- hashed :: VerificationKeyHashing
- data ApiPolicyKey = ApiPolicyKey { }
- newtype ApiPolicyId = ApiPolicyId { }
-
newtype
ApiPostPolicyIdData
=
ApiPostPolicyIdData
{
- policyScriptTemplate :: ApiT ( Script Cosigner )
-
newtype
ApiPostPolicyKeyData
=
ApiPostPolicyKeyData
{
- passphrase :: ApiT ( Passphrase "user")
-
data
ApiVerificationKeyShared
=
ApiVerificationKeyShared
{
- getApiVerificationKey :: ( ByteString , Role )
- hashed :: VerificationKeyHashing
- data ApiScriptTemplateEntry = ApiScriptTemplateEntry { }
-
data
XPubOrSelf
- = SomeAccountKey XPub
- | Self
- data VerificationKeyHashing
-
data
ApiAccountKey
=
ApiAccountKey
{
- getApiAccountKey :: ByteString
- format :: KeyFormat
- purpose :: Index ' Hardened ' PurposeK
-
data
ApiAccountKeyShared
=
ApiAccountKeyShared
{
- getApiAccountKey :: ByteString
- format :: KeyFormat
- purpose :: Index ' Hardened ' PurposeK
-
data
KeyFormat
- = Extended
- | NonExtended
-
data
ApiPostAccountKeyData
=
ApiPostAccountKeyData
{
- passphrase :: ApiT ( Passphrase "user")
- format :: KeyFormat
-
data
ApiPostAccountKeyDataWithPurpose
=
ApiPostAccountKeyDataWithPurpose
{
- passphrase :: ApiT ( Passphrase "user")
- format :: KeyFormat
- purpose :: Maybe ( ApiT DerivationIndex )
-
data
ApiConstructTransaction
(n ::
NetworkDiscriminant
) =
ApiConstructTransaction
{
- transaction :: !( ApiT SealedTx )
- coinSelection :: !( ApiCoinSelection n)
- fee :: !( Quantity "lovelace" Natural )
-
data
ApiConstructTransactionData
(n ::
NetworkDiscriminant
) =
ApiConstructTransactionData
{
- payments :: !( Maybe ( ApiPaymentDestination n))
- withdrawal :: !( Maybe ApiWithdrawalPostData )
- metadata :: !( Maybe TxMetadataWithSchema )
- mintBurn :: !( Maybe ( NonEmpty ( ApiMintBurnData n)))
- delegations :: !( Maybe ( NonEmpty ApiMultiDelegationAction ))
- validityInterval :: !( Maybe ApiValidityInterval )
-
data
ApiMultiDelegationAction
- = Joining !( ApiT PoolId ) ! ApiStakeKeyIndex
- | Leaving ! ApiStakeKeyIndex
- newtype ApiStakeKeyIndex = ApiStakeKeyIndex ( ApiT DerivationIndex )
-
data
ApiPaymentDestination
(n ::
NetworkDiscriminant
)
- = ApiPaymentAddresses !( NonEmpty ( AddressAmount ( ApiAddressIdT n)))
- | ApiPaymentAll !( NonEmpty ( ApiT Address , Proxy n))
-
data
ApiValidityInterval
=
ApiValidityInterval
{
- invalidBefore :: !( Maybe ApiValidityBound )
- invalidHereafter :: !( Maybe ApiValidityBound )
-
data
ApiValidityBound
- = ApiValidityBoundUnspecified
- | ApiValidityBoundAsTimeFromNow !( Quantity "second" NominalDiffTime )
- | ApiValidityBoundAsSlot !( Quantity "slot" Word64 )
-
data
ApiBalanceTransactionPostData
(n ::
NetworkDiscriminant
) =
ApiBalanceTransactionPostData
{
- transaction :: !( ApiT SealedTx )
- inputs :: ![ ApiExternalInput n]
- redeemers :: ![ ApiRedeemer n]
- data ApiExternalInput (n :: NetworkDiscriminant ) = ApiExternalInput { }
-
data
ApiRedeemer
(n ::
NetworkDiscriminant
)
- = ApiRedeemerSpending ApiRedeemerData ( ApiT TxIn )
- | ApiRedeemerMinting ApiRedeemerData ( ApiT TokenPolicyId )
- | ApiRedeemerRewarding ApiRedeemerData StakeAddress
-
data
ApiDecodedTransaction
(n ::
NetworkDiscriminant
) =
ApiDecodedTransaction
{
- id :: !( ApiT ( Hash "Tx"))
- fee :: !( Quantity "lovelace" Natural )
- inputs :: ![ ApiTxInputGeneral n]
- outputs :: ![ ApiTxOutputGeneral n]
- collateral :: ![ ApiTxInputGeneral n]
- collateralOutputs :: !( ApiAsArray "collateral_outputs" ( Maybe ( ApiTxOutputGeneral n)))
- withdrawals :: ![ ApiWithdrawalGeneral n]
- mint :: ! ApiAssetMintBurn
- burn :: ! ApiAssetMintBurn
- certificates :: ![ ApiAnyCertificate n]
- depositsTaken :: ![ Quantity "lovelace" Natural ]
- depositsReturned :: ![ Quantity "lovelace" Natural ]
- metadata :: ! ApiTxMetadata
- scriptValidity :: !( Maybe ( ApiT TxScriptValidity ))
- validityInterval :: !( Maybe ValidityIntervalExplicit )
- data ApiWalletInput (n :: NetworkDiscriminant ) = ApiWalletInput { }
-
data
ApiTxInputGeneral
(n ::
NetworkDiscriminant
)
- = ExternalInput ( ApiT TxIn )
- | WalletInput ( ApiWalletInput n)
- data ResourceContext
-
data
ApiWithdrawalGeneral
(n ::
NetworkDiscriminant
) =
ApiWithdrawalGeneral
{
- stakeAddress :: !( ApiT RewardAccount , Proxy n)
- amount :: !( Quantity "lovelace" Natural )
- context :: ! ResourceContext
- data ApiWalletOutput (n :: NetworkDiscriminant ) = ApiWalletOutput { }
-
data
ApiTxOutputGeneral
(n ::
NetworkDiscriminant
)
- = ExternalOutput (ApiTxOutput n)
- | WalletOutput ( ApiWalletOutput n)
- data ApiAnyCertificate n
-
data
ApiExternalCertificate
(n ::
NetworkDiscriminant
)
-
=
RegisterRewardAccountExternal
{
- rewardAccount :: !( ApiT RewardAccount , Proxy n)
-
|
JoinPoolExternal
{
- rewardAccount :: !( ApiT RewardAccount , Proxy n)
- pool :: ApiT PoolId
-
|
QuitPoolExternal
{
- rewardAccount :: !( ApiT RewardAccount , Proxy n)
-
=
RegisterRewardAccountExternal
{
-
data
ApiRegisterPool
=
ApiRegisterPool
{
- poolId :: !( ApiT PoolId )
- poolOwners :: ![ ApiT PoolOwner ]
- poolMargin :: !( Quantity "percent" Percentage )
- poolCost :: !( Quantity "lovelace" Natural )
- poolPledge :: !( Quantity "lovelace" Natural )
- poolMetadata :: Maybe ( ApiT StakePoolMetadataUrl , ApiT StakePoolMetadataHash )
- data ApiDeregisterPool = ApiDeregisterPool { }
-
data
ApiAssetMintBurn
=
ApiAssetMintBurn
{
- tokens :: ![ ApiTokens ]
- walletPolicyKeyHash :: !( Maybe ApiPolicyKey )
- walletPolicyKeyIndex :: !( Maybe ( ApiT DerivationIndex ))
-
data
ApiTokenAmountFingerprint
=
ApiTokenAmountFingerprint
{
- assetName :: !( ApiT TokenName )
- quantity :: ! Natural
- fingerprint :: !( ApiT TokenFingerprint )
-
data
ApiTokens
=
ApiTokens
{
- policyId :: !( ApiT TokenPolicyId )
- policyScript :: !( ApiT AnyScript )
- assets :: !( NonEmpty ApiTokenAmountFingerprint )
-
data
ApiByronWallet
=
ApiByronWallet
{
- id :: !( ApiT WalletId )
- balance :: ! ApiByronWalletBalance
- assets :: ! ApiWalletAssetsBalance
- discovery :: ! ApiWalletDiscovery
- name :: !( ApiT WalletName )
- passphrase :: !( Maybe ApiWalletPassphraseInfo )
- state :: !( ApiT SyncProgress )
- tip :: ! ApiBlockReference
- data ApiByronWalletBalance = ApiByronWalletBalance { }
-
data
ByronWalletPostData
mw =
ByronWalletPostData
{
- mnemonicSentence :: !( ApiMnemonicT mw)
- name :: !( ApiT WalletName )
- passphrase :: !( ApiT ( Passphrase "user"))
-
data
SomeByronWalletPostData
- = RandomWalletFromMnemonic ( ByronWalletPostData ( AllowedMnemonics ' Random ))
- | RandomWalletFromXPrv ByronWalletFromXPrvPostData
- | SomeIcarusWallet ( ByronWalletPostData ( AllowedMnemonics ' Icarus ))
- | SomeTrezorWallet ( ByronWalletPostData ( AllowedMnemonics ' Trezor ))
- | SomeLedgerWallet ( ByronWalletPostData ( AllowedMnemonics ' Ledger ))
- | SomeAccount AccountPostData
-
data
ByronWalletFromXPrvPostData
=
ByronWalletFromXPrvPostData
{
- name :: !( ApiT WalletName )
- encryptedRootPrivateKey :: !( ApiT XPrv )
- passphraseHash :: !( ApiT PassphraseHash )
-
data
ByronWalletPutPassphraseData
=
ByronWalletPutPassphraseData
{
- oldPassphrase :: !( Maybe ( ApiT ( Passphrase "lenient")))
- newPassphrase :: !( ApiT ( Passphrase "user"))
-
data
ApiPostRandomAddressData
=
ApiPostRandomAddressData
{
- passphrase :: !( ApiT ( Passphrase "lenient"))
- addressIndex :: !( Maybe ( ApiT ( Index ' Hardened ' AddressK )))
- data ApiWalletDiscovery
- class KnownDiscovery s where
- newtype ApiPutAddressesData (n :: NetworkDiscriminant ) = ApiPutAddressesData { }
-
data
AccountPostData
=
AccountPostData
{
- name :: !( ApiT WalletName )
- accountPublicKey :: ! ApiAccountPublicKey
- addressPoolGap :: !( Maybe ( ApiT AddressPoolGap ))
- newtype ApiAccountPublicKey = ApiAccountPublicKey { }
- newtype WalletOrAccountPostData = WalletOrAccountPostData { }
-
class
EncodeAddress
(n ::
NetworkDiscriminant
)
where
- encodeAddress :: Address -> Text
- class DecodeAddress (n :: NetworkDiscriminant ) where
- class EncodeStakeAddress (n :: NetworkDiscriminant ) where
- class DecodeStakeAddress (n :: NetworkDiscriminant ) where
- newtype ApiSharedWallet = ApiSharedWallet { }
-
data
ApiPendingSharedWallet
=
ApiPendingSharedWallet
{
- id :: !( ApiT WalletId )
- name :: !( ApiT WalletName )
- accountIndex :: !( ApiT DerivationIndex )
- addressPoolGap :: !( ApiT AddressPoolGap )
- paymentScriptTemplate :: ! ScriptTemplate
- delegationScriptTemplate :: !( Maybe ScriptTemplate )
-
data
ApiActiveSharedWallet
=
ApiActiveSharedWallet
{
- id :: !( ApiT WalletId )
- name :: !( ApiT WalletName )
- accountIndex :: !( ApiT DerivationIndex )
- addressPoolGap :: !( ApiT AddressPoolGap )
- passphrase :: !( Maybe ApiWalletPassphraseInfo )
- paymentScriptTemplate :: ! ScriptTemplate
- delegationScriptTemplate :: !( Maybe ScriptTemplate )
- delegation :: ! ApiWalletDelegation
- balance :: ! ApiWalletBalance
- assets :: ! ApiWalletAssetsBalance
- state :: !( ApiT SyncProgress )
- tip :: ! ApiBlockReference
- newtype ApiSharedWalletPostData = ApiSharedWalletPostData { }
-
data
ApiSharedWalletPostDataFromMnemonics
=
ApiSharedWalletPostDataFromMnemonics
{
- name :: !( ApiT WalletName )
- mnemonicSentence :: !( ApiMnemonicT ( AllowedMnemonics ' Shelley ))
- mnemonicSecondFactor :: !( Maybe ( ApiMnemonicT ( AllowedMnemonics 'SndFactor)))
- passphrase :: !( ApiT ( Passphrase "user"))
- accountIndex :: !( ApiT DerivationIndex )
- paymentScriptTemplate :: ! ApiScriptTemplateEntry
- delegationScriptTemplate :: !( Maybe ApiScriptTemplateEntry )
- scriptValidation :: !( Maybe ( ApiT ValidationLevel ))
-
data
ApiSharedWalletPostDataFromAccountPubX
=
ApiSharedWalletPostDataFromAccountPubX
{
- name :: !( ApiT WalletName )
- accountPublicKey :: ! ApiAccountPublicKey
- accountIndex :: !( ApiT DerivationIndex )
- paymentScriptTemplate :: ! ApiScriptTemplateEntry
- delegationScriptTemplate :: !( Maybe ApiScriptTemplateEntry )
- scriptValidation :: !( Maybe ( ApiT ValidationLevel ))
-
data
ApiSharedWalletPatchData
=
ApiSharedWalletPatchData
{
- cosigner :: !( ApiT Cosigner )
- accountPublicKey :: ! ApiAccountPublicKey
-
newtype
ApiT
a =
ApiT
{
- getApiT :: a
- newtype ApiMnemonicT (sizes :: [ Nat ]) = ApiMnemonicT { }
-
newtype
ApiBytesT
(base ::
Base
) bs =
ApiBytesT
{
- getApiBytesT :: bs
- type family ApiAddressT (n :: k) :: Type
- type family ApiStakeKeysT (n :: k) :: Type
- type family ApiPutAddressesDataT (n :: k) :: Type
- type family ApiAddressIdT (n :: k) :: Type
- type family ApiCoinSelectionT (n :: k) :: Type
- type family ApiSelectCoinsDataT (n :: k) :: Type
- type family ApiTransactionT (n :: k) :: Type
- type family ApiConstructTransactionT (n :: k) :: Type
- type family ApiConstructTransactionDataT (n :: k) :: Type
- type family PostTransactionOldDataT (n :: k) :: Type
- type family PostTransactionFeeOldDataT (n :: k) :: Type
- type family ApiWalletMigrationPlanPostDataT (n :: k) :: Type
- type family ApiWalletMigrationPostDataT (n :: k1) (s :: k2) :: Type
- type family ApiBalanceTransactionPostDataT (n :: k) :: Type
- type family ApiDecodedTransactionT (n :: k) :: Type
- coinToQuantity :: Integral n => Coin -> Quantity "lovelace" n
- coinFromQuantity :: Integral n => Quantity "lovelace" n -> Coin
- defaultRecordTypeOptions :: Options
- strictRecordTypeOptions :: Options
- data HealthStatusSMASH = HealthStatusSMASH { }
- data HealthCheckSMASH
- newtype ApiHealthCheck = ApiHealthCheck { }
- newtype ApiAsArray (s :: Symbol ) a = ApiAsArray a
- data Base
Wallet Styles
data WalletStyle Source #
Instances
type AllowedMnemonics ' Shelley Source # | |
Defined in Cardano.Wallet.Api.Types |
data ByronWalletStyle Source #
Instances
type family StyleSymbol (style :: ByronWalletStyle ) :: Symbol where ... Source #
Equations
StyleSymbol ' Random = "random" | |
StyleSymbol ' Icarus = "icarus" | |
StyleSymbol ' Trezor = "trezor" | |
StyleSymbol ' Ledger = "ledger" |
type family AllowedMnemonics (style :: k) :: [ Nat ] Source #
Instances
type AllowedMnemonics ' Random Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type AllowedMnemonics ' Icarus Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type AllowedMnemonics ' Trezor Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type AllowedMnemonics ' Ledger Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type AllowedMnemonics ' Shelley Source # | |
Defined in Cardano.Wallet.Api.Types |
API Types
Constructors
ApiAsset | |
Fields
|
toApiAsset :: Either TokenMetadataError ( Maybe AssetMetadata ) -> AssetId -> ApiAsset Source #
data ApiAssetMetadata Source #
Constructors
ApiAssetMetadata | |
Instances
data ApiAddress (n :: NetworkDiscriminant ) Source #
Constructors
ApiAddress | |
Fields
|
Instances
data ApiCredential Source #
Constructors
CredentialExtendedPubKey ByteString | |
CredentialPubKey ByteString | |
CredentialKeyHash ByteString | |
CredentialScript ( Script KeyHash ) |
Instances
data ApiAddressData Source #
Constructors
ApiAddressData | |
Fields
|
Instances
data ApiAddressDataPayload Source #
Constructors
AddrEnterprise ApiCredential | |
AddrRewardAccount ApiCredential | |
AddrBase ApiCredential ApiCredential |
Instances
data AnyAddress Source #
Constructors
AnyAddress | |
Fields
|
Instances
data AnyAddressType Source #
Constructors
EnterpriseDelegating | |
RewardAccount |
Instances
Bounded AnyAddressType Source # | |
Defined in Cardano.Wallet.Api.Types |
|
Enum AnyAddressType Source # | |
Defined in Cardano.Wallet.Api.Types Methods succ :: AnyAddressType -> AnyAddressType Source # pred :: AnyAddressType -> AnyAddressType Source # toEnum :: Int -> AnyAddressType Source # fromEnum :: AnyAddressType -> Int Source # enumFrom :: AnyAddressType -> [ AnyAddressType ] Source # enumFromThen :: AnyAddressType -> AnyAddressType -> [ AnyAddressType ] Source # enumFromTo :: AnyAddressType -> AnyAddressType -> [ AnyAddressType ] Source # enumFromThenTo :: AnyAddressType -> AnyAddressType -> AnyAddressType -> [ AnyAddressType ] Source # |
|
Eq AnyAddressType Source # | |
Defined in Cardano.Wallet.Api.Types Methods (==) :: AnyAddressType -> AnyAddressType -> Bool Source # (/=) :: AnyAddressType -> AnyAddressType -> Bool Source # |
|
Show AnyAddressType Source # | |
Defined in Cardano.Wallet.Api.Types |
data ApiCertificate Source #
Constructors
RegisterRewardAccount | |
Fields |
|
JoinPool | |
Fields
|
|
QuitPool | |
Fields |
Instances
data ApiDelegationAction Source #
Instances
data ApiEpochInfo Source #
Constructors
ApiEpochInfo | |
Fields
|
Instances
toApiEpochInfo :: EpochNo -> Qry ApiEpochInfo Source #
data ApiSelectCoinsData (n :: NetworkDiscriminant ) Source #
Constructors
ApiSelectForPayment ( ApiSelectCoinsPayments n) | |
ApiSelectForDelegation ApiSelectCoinsAction |
Instances
data ApiSelectCoinsPayments (n :: NetworkDiscriminant ) Source #
Constructors
ApiSelectCoinsPayments | |
Fields
|
Instances
newtype ApiSelectCoinsAction Source #
Constructors
ApiSelectCoinsAction | |
Fields |
Instances
data ApiMintBurnOperation (n :: NetworkDiscriminant ) Source #
A user may choose to either mint tokens or burn tokens with each operation.
Constructors
ApiMint ( ApiMintData n) |
Mint tokens. |
ApiBurn ApiBurnData |
Burn tokens. |
Instances
data ApiMintData (n :: NetworkDiscriminant ) Source #
The format of a minting request: mint "amount" and send it to the "address".
Constructors
ApiMintData | |
Fields
|
Instances
newtype ApiBurnData Source #
The format of a burn request: burn "amount". The user can only specify the type of tokens to burn (policyId, assetName), and the amount, the exact tokens selected are up to the implementation.
Constructors
ApiBurnData | |
Instances
data ApiCoinSelection (n :: NetworkDiscriminant ) Source #
Constructors
ApiCoinSelection | |
Fields
|
Instances
data ApiCoinSelectionChange (n :: NetworkDiscriminant ) Source #
Constructors
ApiCoinSelectionChange | |
Instances
data ApiCoinSelectionCollateral (n :: NetworkDiscriminant ) Source #
Constructors
ApiCoinSelectionCollateral | |
Instances
data ApiCoinSelectionOutput (n :: NetworkDiscriminant ) Source #
Constructors
ApiCoinSelectionOutput | |
Instances
data ApiCoinSelectionWithdrawal n Source #
Constructors
ApiCoinSelectionWithdrawal | |
Fields
|
Instances
data ApiMintBurnData (n :: NetworkDiscriminant ) Source #
Core minting and burning request information.
Assets are minted and burned under a "policy". The policy defines under what circumstances a token may be minted and burned. The policy is the hash of a serialized script that contains verification keys and timelocks combined in conditions, possibly nested, to accommodate non-trivial time conditions. In the non-multisig case the script regulating minting/burning will contain a verification key via cosigner#0 of the wallet with optional time predicates. In the multisig case the script regulating minting/burning will contain verification keys of signers (via cosigner#N) with optional time predicates. The used key derivation index is the same for all engaged derivation keys and ix=0 is assumed to be used. The verification key derivation is performed according to CIP 1855.
Constructors
ApiMintBurnData | |
Fields
|
Instances
data ApiStakePool Source #
Constructors
ApiStakePool | |
Fields
|
Instances
data ApiStakePoolMetrics Source #
Constructors
ApiStakePoolMetrics | |
Fields
|
Instances
data ApiStakePoolFlag Source #
Constructors
Delisted |
Instances
Constructors
ApiWallet | |
Fields
|
Instances
data ApiWalletBalance Source #
Constructors
ApiWalletBalance | |
Instances
data ApiWalletAssetsBalance Source #
Constructors
ApiWalletAssetsBalance | |
Instances
data ApiWalletMode Source #
Instances
newtype ApiWalletPassphrase Source #
Constructors
ApiWalletPassphrase | |
Fields
|
Instances
newtype ApiWalletPassphraseInfo Source #
Constructors
ApiWalletPassphraseInfo | |
Fields |
Instances
newtype ApiWalletUtxoSnapshot Source #
Constructors
ApiWalletUtxoSnapshot | |
Fields |
Instances
data ApiWalletUtxoSnapshotEntry Source #
Constructors
ApiWalletUtxoSnapshotEntry | |
Instances
data ApiUtxoStatistics Source #
Constructors
ApiUtxoStatistics | |
Instances
data WalletPostData Source #
Constructors
WalletPostData | |
Fields
|
Instances
Eq WalletPostData Source # | |
Defined in Cardano.Wallet.Api.Types Methods (==) :: WalletPostData -> WalletPostData -> Bool Source # (/=) :: WalletPostData -> WalletPostData -> Bool Source # |
|
Show WalletPostData Source # | |
Defined in Cardano.Wallet.Api.Types |
|
Generic WalletPostData Source # | |
Defined in Cardano.Wallet.Api.Types Methods from :: WalletPostData -> Rep WalletPostData x Source # to :: Rep WalletPostData x -> WalletPostData Source # |
|
ToJSON WalletPostData Source # | |
Defined in Cardano.Wallet.Api.Types Methods toJSON :: WalletPostData -> Value Source # toEncoding :: WalletPostData -> Encoding Source # toJSONList :: [ WalletPostData ] -> Value Source # toEncodingList :: [ WalletPostData ] -> Encoding Source # |
|
FromJSON WalletPostData Source # | |
Defined in Cardano.Wallet.Api.Types Methods parseJSON :: Value -> Parser WalletPostData Source # parseJSONList :: Value -> Parser [ WalletPostData ] Source # |
|
type Rep WalletPostData Source # | |
Defined in Cardano.Wallet.Api.Types |
newtype WalletPutData Source #
Constructors
WalletPutData | |
Fields
|
Instances
newtype SettingsPutData Source #
Constructors
SettingsPutData | |
Instances
newtype WalletPutPassphraseData Source #
Constructors
WalletPutPassphraseData ( Either WalletPutPassphraseOldPassphraseData WalletPutPassphraseMnemonicData ) |
Instances
data WalletPutPassphraseOldPassphraseData Source #
Constructors
WalletPutPassphraseOldPassphraseData | |
Fields
|
Instances
data WalletPutPassphraseMnemonicData Source #
Constructors
WalletPutPassphraseMnemonicData | |
Fields
|
Instances
Eq WalletPutPassphraseMnemonicData Source # | |
Defined in Cardano.Wallet.Api.Types |
|
Show WalletPutPassphraseMnemonicData Source # | |
Defined in Cardano.Wallet.Api.Types |
|
Generic WalletPutPassphraseMnemonicData Source # | |
Defined in Cardano.Wallet.Api.Types |
|
ToJSON WalletPutPassphraseMnemonicData Source # | |
Defined in Cardano.Wallet.Api.Types Methods toJSON :: WalletPutPassphraseMnemonicData -> Value Source # toEncoding :: WalletPutPassphraseMnemonicData -> Encoding Source # toJSONList :: [ WalletPutPassphraseMnemonicData ] -> Value Source # toEncodingList :: [ WalletPutPassphraseMnemonicData ] -> Encoding Source # |
|
FromJSON WalletPutPassphraseMnemonicData Source # | |
Defined in Cardano.Wallet.Api.Types Methods parseJSON :: Value -> Parser WalletPutPassphraseMnemonicData Source # parseJSONList :: Value -> Parser [ WalletPutPassphraseMnemonicData ] Source # |
|
type Rep WalletPutPassphraseMnemonicData Source # | |
Defined in Cardano.Wallet.Api.Types |
data ApiSignTransactionPostData Source #
Constructors
ApiSignTransactionPostData | |
Fields
|
Instances
data PostTransactionOldData (n :: NetworkDiscriminant ) Source #
Legacy transaction API.
Constructors
PostTransactionOldData | |
Fields
|
Instances
data PostTransactionFeeOldData (n :: NetworkDiscriminant ) Source #
Legacy transaction API.
Constructors
PostTransactionFeeOldData | |
Fields
|
Instances
newtype ApiSerialisedTransaction Source #
Constructors
ApiSerialisedTransaction | |
Fields |
Instances
data ApiTransaction (n :: NetworkDiscriminant ) Source #
Constructors
ApiTransaction | |
Fields
|
Instances
data ApiWithdrawalPostData Source #
Constructors
SelfWithdrawal | |
ExternalWithdrawal ( ApiMnemonicT '[15, 18, 21, 24]) |
Instances
newtype ApiMaintenanceAction Source #
Constructors
ApiMaintenanceAction | |
Fields |
Instances
newtype ApiMaintenanceActionPostData Source #
Constructors
ApiMaintenanceActionPostData | |
Fields |
Instances
data MaintenanceAction Source #
Constructors
GcStakePools |
Instances
Eq MaintenanceAction Source # | |
Defined in Cardano.Wallet.Api.Types Methods (==) :: MaintenanceAction -> MaintenanceAction -> Bool Source # (/=) :: MaintenanceAction -> MaintenanceAction -> Bool Source # |
|
Show MaintenanceAction Source # | |
Defined in Cardano.Wallet.Api.Types |
|
Generic MaintenanceAction Source # | |
Defined in Cardano.Wallet.Api.Types Methods from :: MaintenanceAction -> Rep MaintenanceAction x Source # to :: Rep MaintenanceAction x -> MaintenanceAction Source # |
|
ToJSON MaintenanceAction Source # | |
Defined in Cardano.Wallet.Api.Types Methods toJSON :: MaintenanceAction -> Value Source # toEncoding :: MaintenanceAction -> Encoding Source # toJSONList :: [ MaintenanceAction ] -> Value Source # toEncodingList :: [ MaintenanceAction ] -> Encoding Source # |
|
FromJSON MaintenanceAction Source # | |
Defined in Cardano.Wallet.Api.Types Methods parseJSON :: Value -> Parser MaintenanceAction Source # parseJSONList :: Value -> Parser [ MaintenanceAction ] Source # |
|
type Rep MaintenanceAction Source # | |
Constructors
ApiFee | |
Fields
|
Instances
Eq ApiFee Source # | |
Show ApiFee Source # | |
Generic ApiFee Source # | |
ToJSON ApiFee Source # | |
FromJSON ApiFee Source # | |
type Rep ApiFee Source # | |
Defined in Cardano.Wallet.Api.Types
type
Rep
ApiFee
=
D1
('
MetaData
"ApiFee" "Cardano.Wallet.Api.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" '
False
) (
C1
('
MetaCons
"ApiFee" '
PrefixI
'
True
) ((
S1
('
MetaSel
('
Just
"estimatedMin") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
(
Quantity
"lovelace"
Natural
))
:*:
S1
('
MetaSel
('
Just
"estimatedMax") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
(
Quantity
"lovelace"
Natural
)))
:*:
(
S1
('
MetaSel
('
Just
"minimumCoins") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
[
Quantity
"lovelace"
Natural
])
:*:
S1
('
MetaSel
('
Just
"deposit") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
(
Quantity
"lovelace"
Natural
)))))
|
data ApiTxCollateral (n :: NetworkDiscriminant ) Source #
Constructors
ApiTxCollateral | |
Instances
Instances
Eq ApiTxId Source # | |
Show ApiTxId Source # | |
Generic ApiTxId Source # | |
NFData ApiTxId Source # | |
Defined in Cardano.Wallet.Api.Types |
|
ToJSON ApiTxId Source # | |
FromJSON ApiTxId Source # | |
ToHttpApiData ApiTxId Source # | |
Defined in Cardano.Wallet.Api.Types Methods toUrlPiece :: ApiTxId -> Text Source # toEncodedUrlPiece :: ApiTxId -> Builder Source # toHeader :: ApiTxId -> ByteString Source # toQueryParam :: ApiTxId -> Text Source # |
|
FromHttpApiData ApiTxId Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type Rep ApiTxId Source # | |
Defined in Cardano.Wallet.Api.Types |
data ApiTxInput (n :: NetworkDiscriminant ) Source #
Instances
newtype ApiTxMetadata Source #
Constructors
ApiTxMetadata | |
Fields
|
Instances
data AddressAmount addr Source #
Constructors
AddressAmount | |
Instances
data AddressAmountNoAssets addr Source #
Constructors
AddressAmountNoAssets | |
Instances
newtype ApiAddressInspect Source #
Constructors
ApiAddressInspect | |
Fields |
Instances
newtype ApiAddressInspectData Source #
Constructors
ApiAddressInspectData | |
Fields |
Instances
data ApiErrorCode Source #
Error codes returned by the API, in the form of snake_cased strings
Constructors
Instances
Eq ApiErrorCode Source # | |
Defined in Cardano.Wallet.Api.Types Methods (==) :: ApiErrorCode -> ApiErrorCode -> Bool Source # (/=) :: ApiErrorCode -> ApiErrorCode -> Bool Source # |
|
Data ApiErrorCode Source # | |
Defined in Cardano.Wallet.Api.Types Methods gfoldl :: ( forall d b. Data d => c (d -> b) -> d -> c b) -> ( forall g. g -> c g) -> ApiErrorCode -> c ApiErrorCode Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ApiErrorCode Source # toConstr :: ApiErrorCode -> Constr Source # dataTypeOf :: ApiErrorCode -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ApiErrorCode ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ApiErrorCode ) Source # gmapT :: ( forall b. Data b => b -> b) -> ApiErrorCode -> ApiErrorCode Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> ApiErrorCode -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> ApiErrorCode -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> ApiErrorCode -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> ApiErrorCode -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> ApiErrorCode -> m ApiErrorCode Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> ApiErrorCode -> m ApiErrorCode Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> ApiErrorCode -> m ApiErrorCode Source # |
|
Show ApiErrorCode Source # | |
Defined in Cardano.Wallet.Api.Types |
|
Generic ApiErrorCode Source # | |
Defined in Cardano.Wallet.Api.Types Methods from :: ApiErrorCode -> Rep ApiErrorCode x Source # to :: Rep ApiErrorCode x -> ApiErrorCode Source # |
|
NFData ApiErrorCode Source # | |
Defined in Cardano.Wallet.Api.Types Methods rnf :: ApiErrorCode -> () Source # |
|
ToJSON ApiErrorCode Source # | |
Defined in Cardano.Wallet.Api.Types Methods toJSON :: ApiErrorCode -> Value Source # toEncoding :: ApiErrorCode -> Encoding Source # toJSONList :: [ ApiErrorCode ] -> Value Source # toEncodingList :: [ ApiErrorCode ] -> Encoding Source # |
|
type Rep ApiErrorCode Source # | |
Defined in Cardano.Wallet.Api.Types
type
Rep
ApiErrorCode
=
D1
('
MetaData
"ApiErrorCode" "Cardano.Wallet.Api.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" '
False
) ((((((
C1
('
MetaCons
"AddressAlreadyExists" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"AlreadyWithdrawing" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"AssetNameTooLong" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"AssetNotPresent" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"BadRequest" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))
:+:
((
C1
('
MetaCons
"BalanceTxByronNotSupported" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"BalanceTxConflictingNetworks" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"BalanceTxExistingCollateral" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"BalanceTxExistingKeyWitnesses" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"BalanceTxExistingReturnCollateral" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))))
:+:
(((
C1
('
MetaCons
"BalanceTxExistingTotalCollateral" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"BalanceTxInternalError" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"BalanceTxMaxSizeLimitExceeded" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"BalanceTxUnderestimatedFee" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"BalanceTxZeroAdaOutput" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))
:+:
((
C1
('
MetaCons
"CannotCoverFee" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"CreatedInvalidTransaction" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"CreatedMultiaccountTransaction" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))
:+:
(
C1
('
MetaCons
"CreatedMultidelegationTransaction" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"CreatedWrongPolicyScriptTemplate" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"ExistingKeyWitnesses" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))))
:+:
((((
C1
('
MetaCons
"ForeignTransaction" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"HardenedDerivationRequired" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"InputsDepleted" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"InsufficientCollateral" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"InvalidCoinSelection" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))
:+:
((
C1
('
MetaCons
"InvalidWalletType" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"InvalidValidityBounds" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"KeyNotFoundForAddress" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"MalformedTxPayload" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"MethodNotAllowed" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))))
:+:
(((
C1
('
MetaCons
"MinWithdrawalWrong" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"MintOrBurnAssetQuantityOutOfBounds" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"MissingPolicyPublicKey" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"MissingWitnessesInTransaction" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"NetworkMisconfigured" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))
:+:
((
C1
('
MetaCons
"NetworkQueryFailed" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"NetworkUnreachable" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"NoRootKey" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))
:+:
(
C1
('
MetaCons
"NoSuchPool" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"NoSuchTransaction" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"NoSuchWallet" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))))))
:+:
(((((
C1
('
MetaCons
"NonNullRewards" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"NotAcceptable" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"NotDelegatingTo" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"NotEnoughMoney" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"NotFound" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))
:+:
((
C1
('
MetaCons
"NotImplemented" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"NotSynced" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"NothingToMigrate" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"OutputTokenBundleSizeExceedsLimit" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"OutputTokenQuantityExceedsLimit" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))))
:+:
(((
C1
('
MetaCons
"PastHorizon" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"PoolAlreadyJoined" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"QueryParamMissing" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"RedeemerInvalidData" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"RedeemerScriptFailure" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))
:+:
((
C1
('
MetaCons
"RedeemerTargetNotFound" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"RejectedByCoreNode" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"SharedWalletCannotUpdateKey" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))
:+:
(
C1
('
MetaCons
"SharedWalletKeyAlreadyExists" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"SharedWalletNoDelegationTemplate" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"SharedWalletNoSuchCosigner" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))))
:+:
((((
C1
('
MetaCons
"SharedWalletNotPending" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"SharedWalletPending" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"SharedWalletScriptTemplateInvalid" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"SoftDerivationRequired" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"StartTimeLaterThanEndTime" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))
:+:
((
C1
('
MetaCons
"TokensMintedButNotSpentOrBurned" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"TransactionAlreadyBalanced" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"TransactionAlreadyInLedger" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))
:+:
(
C1
('
MetaCons
"TransactionIsTooBig" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"TranslationError" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"UnableToAssignInputOutput" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))))
:+:
(((
C1
('
MetaCons
"UnableToDetermineCurrentEpoch" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"UnexpectedError" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
:+:
(
C1
('
MetaCons
"UnresolvedInputs" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"UnsupportedMediaType" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"UtxoTooSmall" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))
:+:
((
C1
('
MetaCons
"WalletAlreadyExists" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"WalletNotResponding" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"WithdrawalNotWorth" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)))
:+:
(
C1
('
MetaCons
"WrongEncryptionPassphrase" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
(
C1
('
MetaCons
"WrongMnemonic" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"ValidityIntervalNotInsideScriptTimelock" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))))))))
|
data ApiNetworkInformation Source #
Constructors
ApiNetworkInformation | |
Fields
|
Instances
Constructors
ApiByron | |
ApiShelley | |
ApiAllegra | |
ApiMary | |
ApiAlonzo | |
ApiBabbage |
Instances
toApiEra :: AnyCardanoEra -> ApiEra Source #
fromApiEra :: ApiEra -> AnyCardanoEra Source #
data ApiNtpStatus Source #
Constructors
ApiNtpStatus | |
Instances
data NtpSyncingStatus Source #
Instances
newtype ApiNetworkClock Source #
Constructors
ApiNetworkClock | |
Fields |
Instances
data ApiSlotReference Source #
Constructors
ApiSlotReference | |
Instances
Constructors
ApiSlotId | |
Fields
|
Instances
Eq ApiSlotId Source # | |
Show ApiSlotId Source # | |
Generic ApiSlotId Source # | |
NFData ApiSlotId Source # | |
Defined in Cardano.Wallet.Api.Types |
|
ToJSON ApiSlotId Source # | |
FromJSON ApiSlotId Source # | |
type Rep ApiSlotId Source # | |
Defined in Cardano.Wallet.Api.Types
type
Rep
ApiSlotId
=
D1
('
MetaData
"ApiSlotId" "Cardano.Wallet.Api.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" '
False
) (
C1
('
MetaCons
"ApiSlotId" '
PrefixI
'
True
) (
S1
('
MetaSel
('
Just
"epochNumber") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
(
ApiT
EpochNo
))
:*:
S1
('
MetaSel
('
Just
"slotNumber") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
(
ApiT
SlotInEpoch
))))
|
data ApiBlockReference Source #
Constructors
ApiBlockReference | |
Fields
|
Instances
newtype ApiBlockInfo Source #
Constructors
ApiBlockInfo | |
Instances
data ApiStakeKeys (n :: NetworkDiscriminant ) Source #
Collection of stake keys associated with a wallet.
Constructors
ApiStakeKeys | |
Fields
|
Instances
data ApiOurStakeKey (n :: NetworkDiscriminant ) Source #
A stake key belonging to the current wallet.
Constructors
ApiOurStakeKey | |
Fields
|
Instances
data ApiForeignStakeKey (n :: NetworkDiscriminant ) Source #
A stake key found in the wallet UTxO, but which isn't ours.
We could provide the current delegation status for foreign stake keys.
Constructors
ApiForeignStakeKey | |
Fields
|
Instances
newtype ApiNullStakeKey Source #
For describing how much stake is associated with no stake key.
Constructors
ApiNullStakeKey | |
Instances
newtype Iso8601Time Source #
Defines a point in time that can be formatted as and parsed from an ISO 8601-compliant string.
Constructors
Iso8601Time | |
Fields |
Instances
newtype MinWithdrawal Source #
Constructors
MinWithdrawal | |
Fields |
Instances
data ApiNetworkParameters Source #
Constructors
ApiNetworkParameters | |
Fields
|
Instances
data ApiNetworkInfo Source #
Constructors
ApiNetworkInfo | |
Fields
|
Instances
toApiNetworkParameters :: Monad m => NetworkParameters -> TxConstraints -> ( EpochNo -> m ApiEpochInfo ) -> m ApiNetworkParameters Source #
data ApiEraInfo Source #
Constructors
ApiEraInfo | |
Fields
|
Instances
data ApiWalletDelegation Source #
Constructors
ApiWalletDelegation | |
Fields
|
Instances
data ApiWalletDelegationStatus Source #
Constructors
NotDelegating | |
Delegating |
Instances
data ApiWalletDelegationNext Source #
Constructors
ApiWalletDelegationNext | |
Fields
|
Instances
Constructors
ApiPoolIdPlaceholder | |
ApiPoolId PoolId |
Instances
Eq ApiPoolId Source # | |
Show ApiPoolId Source # | |
Generic ApiPoolId Source # | |
ToHttpApiData ApiPoolId Source # | |
Defined in Cardano.Wallet.Api.Types Methods toUrlPiece :: ApiPoolId -> Text Source # toEncodedUrlPiece :: ApiPoolId -> Builder Source # toHeader :: ApiPoolId -> ByteString Source # toQueryParam :: ApiPoolId -> Text Source # |
|
FromHttpApiData ApiPoolId Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type Rep ApiPoolId Source # | |
Defined in Cardano.Wallet.Api.Types
type
Rep
ApiPoolId
=
D1
('
MetaData
"ApiPoolId" "Cardano.Wallet.Api.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" '
False
) (
C1
('
MetaCons
"ApiPoolIdPlaceholder" '
PrefixI
'
False
) (
U1
::
Type
->
Type
)
:+:
C1
('
MetaCons
"ApiPoolId" '
PrefixI
'
False
) (
S1
('
MetaSel
('
Nothing
::
Maybe
Symbol
) '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedLazy
) (
Rec0
PoolId
)))
|
newtype ApiWalletMigrationPlanPostData (n :: NetworkDiscriminant ) Source #
Instances
data ApiWalletMigrationPostData (n :: NetworkDiscriminant ) (s :: Symbol ) Source #
Constructors
ApiWalletMigrationPostData | |
Fields
|
Instances
data ApiWalletMigrationBalance Source #
Constructors
ApiWalletMigrationBalance | |
Instances
data ApiWalletMigrationPlan (n :: NetworkDiscriminant ) Source #
Constructors
ApiWalletMigrationPlan | |
Fields
|
Instances
data ApiWithdrawal n Source #
Constructors
ApiWithdrawal | |
Fields
|
Instances
data ApiWalletSignData Source #
Constructors
ApiWalletSignData | |
Fields
|
Instances
data ApiVerificationKeyShelley Source #
Constructors
ApiVerificationKeyShelley | |
Fields
|
Instances
data ApiPolicyKey Source #
Constructors
ApiPolicyKey | |
Fields |
Instances
newtype ApiPolicyId Source #
Constructors
ApiPolicyId | |
Fields |
Instances
newtype ApiPostPolicyIdData Source #
Constructors
ApiPostPolicyIdData | |
Fields
|
Instances
newtype ApiPostPolicyKeyData Source #
Constructors
ApiPostPolicyKeyData | |
Fields
|
Instances
data ApiVerificationKeyShared Source #
Constructors
ApiVerificationKeyShared | |
Fields
|
Instances
data ApiScriptTemplateEntry Source #
Constructors
ApiScriptTemplateEntry | |
Instances
data XPubOrSelf Source #
Constructors
SomeAccountKey XPub | |
Self |
Instances
data VerificationKeyHashing Source #
Constructors
WithHashing | |
WithoutHashing |
Instances
data ApiAccountKey Source #
Constructors
ApiAccountKey | |
Fields
|
Instances
data ApiAccountKeyShared Source #
Constructors
ApiAccountKeyShared | |
Fields
|
Instances
Constructors
Extended | |
NonExtended |
Instances
Eq KeyFormat Source # | |
Show KeyFormat Source # | |
Generic KeyFormat Source # | |
NFData KeyFormat Source # | |
Defined in Cardano.Wallet.Api.Types |
|
ToJSON KeyFormat Source # | |
FromJSON KeyFormat Source # | |
ToHttpApiData KeyFormat Source # | |
Defined in Cardano.Wallet.Api.Types Methods toUrlPiece :: KeyFormat -> Text Source # toEncodedUrlPiece :: KeyFormat -> Builder Source # toHeader :: KeyFormat -> ByteString Source # toQueryParam :: KeyFormat -> Text Source # |
|
FromHttpApiData KeyFormat Source # | |
Defined in Cardano.Wallet.Api.Types |
|
ToText KeyFormat Source # | |
FromText KeyFormat Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type Rep KeyFormat Source # | |
Defined in Cardano.Wallet.Api.Types |
data ApiPostAccountKeyData Source #
Constructors
ApiPostAccountKeyData | |
Fields
|
Instances
data ApiPostAccountKeyDataWithPurpose Source #
Constructors
ApiPostAccountKeyDataWithPurpose | |
Fields
|
Instances
data ApiConstructTransaction (n :: NetworkDiscriminant ) Source #
Constructors
ApiConstructTransaction | |
Fields
|
Instances
data ApiConstructTransactionData (n :: NetworkDiscriminant ) Source #
Input parameters for transaction construction.
Constructors
ApiConstructTransactionData | |
Fields
|
Instances
data ApiMultiDelegationAction Source #
Stake pool delegation certificates.
Constructors
Joining !( ApiT PoolId ) ! ApiStakeKeyIndex |
Delegate given staking index to a pool, possibly registering the stake key at the same time. |
Leaving ! ApiStakeKeyIndex |
Undelegate the given staking index from its pool. |
Instances
newtype ApiStakeKeyIndex Source #
Index of the stake key.
Constructors
ApiStakeKeyIndex ( ApiT DerivationIndex ) |
Instances
data ApiPaymentDestination (n :: NetworkDiscriminant ) Source #
Constructors
ApiPaymentAddresses !( NonEmpty ( AddressAmount ( ApiAddressIdT n))) |
Pay amounts to one or more addresses. |
ApiPaymentAll !( NonEmpty ( ApiT Address , Proxy n)) |
Migrate all money to one or more addresses. |
Instances
data ApiValidityInterval Source #
Times where transactions are valid.
Constructors
ApiValidityInterval | |
Fields
|
Instances
data ApiValidityBound Source #
One side of the validity interval.
Constructors
ApiValidityBoundUnspecified |
Use the default. |
ApiValidityBoundAsTimeFromNow !( Quantity "second" NominalDiffTime ) |
Time from transaction construction (not submission). |
ApiValidityBoundAsSlot !( Quantity "slot" Word64 ) |
Absolute slot number. |
Instances
data ApiBalanceTransactionPostData (n :: NetworkDiscriminant ) Source #
Constructors
ApiBalanceTransactionPostData | |
Fields
|
Instances
data ApiExternalInput (n :: NetworkDiscriminant ) Source #
Constructors
ApiExternalInput | |
Instances
data ApiRedeemer (n :: NetworkDiscriminant ) Source #
Constructors
ApiRedeemerSpending ApiRedeemerData ( ApiT TxIn ) | |
ApiRedeemerMinting ApiRedeemerData ( ApiT TokenPolicyId ) | |
ApiRedeemerRewarding ApiRedeemerData StakeAddress |
Instances
data ApiDecodedTransaction (n :: NetworkDiscriminant ) Source #
Constructors
ApiDecodedTransaction | |
Fields
|
Instances
data ApiWalletInput (n :: NetworkDiscriminant ) Source #
Constructors
ApiWalletInput | |
Instances
data ApiTxInputGeneral (n :: NetworkDiscriminant ) Source #
Constructors
ExternalInput ( ApiT TxIn ) | |
WalletInput ( ApiWalletInput n) |
Instances
data ResourceContext Source #
Instances
Eq ResourceContext Source # | |
Defined in Cardano.Wallet.Api.Types Methods (==) :: ResourceContext -> ResourceContext -> Bool Source # (/=) :: ResourceContext -> ResourceContext -> Bool Source # |
|
Show ResourceContext Source # | |
Defined in Cardano.Wallet.Api.Types |
|
Generic ResourceContext Source # | |
Defined in Cardano.Wallet.Api.Types Methods from :: ResourceContext -> Rep ResourceContext x Source # to :: Rep ResourceContext x -> ResourceContext Source # |
|
NFData ResourceContext Source # | |
Defined in Cardano.Wallet.Api.Types Methods rnf :: ResourceContext -> () Source # |
|
type Rep ResourceContext Source # | |
Defined in Cardano.Wallet.Api.Types |
data ApiWithdrawalGeneral (n :: NetworkDiscriminant ) Source #
Constructors
ApiWithdrawalGeneral | |
Fields
|
Instances
data ApiWalletOutput (n :: NetworkDiscriminant ) Source #
Constructors
ApiWalletOutput | |
Instances
data ApiTxOutputGeneral (n :: NetworkDiscriminant ) Source #
Constructors
ExternalOutput (ApiTxOutput n) | |
WalletOutput ( ApiWalletOutput n) |
Instances
data ApiAnyCertificate n Source #
Constructors
Instances
data ApiExternalCertificate (n :: NetworkDiscriminant ) Source #
Constructors
RegisterRewardAccountExternal | |
Fields
|
|
JoinPoolExternal | |
Fields
|
|
QuitPoolExternal | |
Fields
|
Instances
data ApiRegisterPool Source #
Constructors
ApiRegisterPool | |
Fields
|
Instances
data ApiDeregisterPool Source #
Constructors
ApiDeregisterPool | |
Instances
data ApiAssetMintBurn Source #
Constructors
ApiAssetMintBurn | |
Fields
|
Instances
data ApiTokenAmountFingerprint Source #
Constructors
ApiTokenAmountFingerprint | |
Fields
|
Instances
Constructors
ApiTokens | |
Fields
|
Instances
Eq ApiTokens Source # | |
Show ApiTokens Source # | |
Generic ApiTokens Source # | |
NFData ApiTokens Source # | |
Defined in Cardano.Wallet.Api.Types |
|
ToJSON ApiTokens Source # | |
FromJSON ApiTokens Source # | |
type Rep ApiTokens Source # | |
Defined in Cardano.Wallet.Api.Types
type
Rep
ApiTokens
=
D1
('
MetaData
"ApiTokens" "Cardano.Wallet.Api.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" '
False
) (
C1
('
MetaCons
"ApiTokens" '
PrefixI
'
True
) (
S1
('
MetaSel
('
Just
"policyId") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
(
ApiT
TokenPolicyId
))
:*:
(
S1
('
MetaSel
('
Just
"policyScript") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
(
ApiT
AnyScript
))
:*:
S1
('
MetaSel
('
Just
"assets") '
NoSourceUnpackedness
'
SourceStrict
'
DecidedStrict
) (
Rec0
(
NonEmpty
ApiTokenAmountFingerprint
)))))
|
API Types (Byron)
data ApiByronWallet Source #
Constructors
ApiByronWallet | |
Fields
|
Instances
data ApiByronWalletBalance Source #
Constructors
ApiByronWalletBalance | |
Instances
data ByronWalletPostData mw Source #
Constructors
ByronWalletPostData | |
Fields
|
Instances
data SomeByronWalletPostData Source #
Constructors
Instances
data ByronWalletFromXPrvPostData Source #
Constructors
ByronWalletFromXPrvPostData | |
Fields
|
Instances
data ByronWalletPutPassphraseData Source #
Constructors
ByronWalletPutPassphraseData | |
Fields
|
Instances
data ApiPostRandomAddressData Source #
Constructors
ApiPostRandomAddressData | |
Fields
|
Instances
data ApiWalletDiscovery Source #
Constructors
DiscoveryRandom | |
DiscoverySequential |
Instances
class KnownDiscovery s where Source #
Methods
Instances
KnownDiscovery ( RndState network :: Type ) Source # | |
Defined in Cardano.Wallet.Api.Types Methods |
|
KnownDiscovery ( SeqState network key :: Type ) Source # | |
Defined in Cardano.Wallet.Api.Types Methods |
newtype ApiPutAddressesData (n :: NetworkDiscriminant ) Source #
Constructors
ApiPutAddressesData | |
Instances
API Types (Hardware)
data AccountPostData Source #
Constructors
AccountPostData | |
Fields
|
Instances
newtype ApiAccountPublicKey Source #
Constructors
ApiAccountPublicKey | |
Instances
newtype WalletOrAccountPostData Source #
Constructors
WalletOrAccountPostData | |
Fields |
Instances
User-Facing Address Encoding/Decoding
class EncodeAddress (n :: NetworkDiscriminant ) where Source #
An abstract class to allow encoding of addresses depending on the target backend used.
Methods
encodeAddress :: Address -> Text Source #
Instances
EncodeAddress ' Mainnet => EncodeAddress (' Staging pm) Source # | |
Defined in Cardano.Wallet.Api.Types Methods encodeAddress :: Address -> Text Source # |
class DecodeAddress (n :: NetworkDiscriminant ) where Source #
An abstract class to allow decoding of addresses depending on the target backend used.
Methods
decodeAddress :: Text -> Either TextDecodingError Address Source #
Instances
DecodeAddress ' Mainnet => DecodeAddress (' Staging pm) Source # | |
Defined in Cardano.Wallet.Api.Types Methods decodeAddress :: Text -> Either TextDecodingError Address Source # |
class EncodeStakeAddress (n :: NetworkDiscriminant ) where Source #
Methods
Instances
EncodeStakeAddress ' Mainnet => EncodeStakeAddress (' Staging pm) Source # | |
Defined in Cardano.Wallet.Api.Types Methods |
class DecodeStakeAddress (n :: NetworkDiscriminant ) where Source #
Methods
decodeStakeAddress :: Text -> Either TextDecodingError RewardAccount Source #
Instances
DecodeStakeAddress ' Mainnet => DecodeStakeAddress (' Staging pm) Source # | |
Defined in Cardano.Wallet.Api.Types Methods decodeStakeAddress :: Text -> Either TextDecodingError RewardAccount Source # |
Shared Wallets
data ApiPendingSharedWallet Source #
Constructors
ApiPendingSharedWallet | |
Fields
|
Instances
data ApiActiveSharedWallet Source #
Constructors
ApiActiveSharedWallet | |
Fields
|
Instances
data ApiSharedWalletPostDataFromMnemonics Source #
Constructors
ApiSharedWalletPostDataFromMnemonics | |
Fields
|
Instances
data ApiSharedWalletPostDataFromAccountPubX Source #
Constructors
ApiSharedWalletPostDataFromAccountPubX | |
Fields
|
Instances
data ApiSharedWalletPatchData Source #
Constructors
ApiSharedWalletPatchData | |
Fields
|
Instances
Polymorphic Types
Polymorphic wrapper type to put around primitive types and, 3rd party lib types to avoid defining orphan instances and/or, undesirable instances on primitive types. It helps to keep a nice separation of concerns between the API layer and other modules.
Instances
newtype ApiMnemonicT (sizes :: [ Nat ]) Source #
Representation of mnemonics at the API-level, using a polymorphic type in the lengths of mnemonics that are supported (and an underlying purpose). In practice, mnemonics correspond to passphrases or seeds, and although they're nice to manipulate as mnemonics from a user-perspective, carrying around a list of words doesn't really make sense for the business logic, which prefers manipulating scrubbed bytes directly.
data MyWallet { mnemonic :: ApiMnemonicT '[15,18,21,24] }
Note that the given
Nat
s **have** to be valid mnemonic sizes, otherwise the
underlying code won't even compile, with not-so-friendly error messages.
Also, the internal representation holds a
[Text]
which contains the list of
mnemonic words that was parsed. This is only to be able to implement the
ToJSON
instances and roundtrip, which is a very dubious argument. In
practice, we'll NEVER peek at the mnemonic, output them and whatnot.
Constructors
ApiMnemonicT | |
Fields |
Instances
newtype ApiBytesT (base :: Base ) bs Source #
Polymorphic wrapper for byte arrays, parameterised by the desired string encoding.
Constructors
ApiBytesT | |
Fields
|
Instances
Type families
type family ApiAddressT (n :: k) :: Type Source #
Instances
type ApiAddressT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiAddressT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiStakeKeysT (n :: k) :: Type Source #
Instances
type ApiStakeKeysT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiStakeKeysT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiPutAddressesDataT (n :: k) :: Type Source #
Instances
type ApiPutAddressesDataT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiPutAddressesDataT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiAddressIdT (n :: k) :: Type Source #
Instances
type ApiAddressIdT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiAddressIdT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiCoinSelectionT (n :: k) :: Type Source #
Instances
type ApiCoinSelectionT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiCoinSelectionT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiSelectCoinsDataT (n :: k) :: Type Source #
Instances
type ApiSelectCoinsDataT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiSelectCoinsDataT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiTransactionT (n :: k) :: Type Source #
Instances
type ApiTransactionT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiTransactionT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiConstructTransactionT (n :: k) :: Type Source #
Instances
type ApiConstructTransactionT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiConstructTransactionT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiConstructTransactionDataT (n :: k) :: Type Source #
Instances
type ApiConstructTransactionDataT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiConstructTransactionDataT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family PostTransactionOldDataT (n :: k) :: Type Source #
Instances
type PostTransactionOldDataT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type PostTransactionOldDataT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family PostTransactionFeeOldDataT (n :: k) :: Type Source #
Instances
type PostTransactionFeeOldDataT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type PostTransactionFeeOldDataT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiWalletMigrationPlanPostDataT (n :: k) :: Type Source #
Instances
type ApiWalletMigrationPlanPostDataT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
type family ApiWalletMigrationPostDataT (n :: k1) (s :: k2) :: Type Source #
Instances
type ApiWalletMigrationPostDataT (n :: NetworkDiscriminant ) (s :: Symbol ) Source # | |
Defined in Cardano.Wallet.Api.Types
type
ApiWalletMigrationPostDataT
(n ::
NetworkDiscriminant
) (s ::
Symbol
) =
ApiWalletMigrationPostData
n s
|
type family ApiBalanceTransactionPostDataT (n :: k) :: Type Source #
Instances
type ApiBalanceTransactionPostDataT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiBalanceTransactionPostDataT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
type family ApiDecodedTransactionT (n :: k) :: Type Source #
Instances
type ApiDecodedTransactionT (n :: NetworkDiscriminant ) Source # | |
Defined in Cardano.Wallet.Api.Types |
|
type ApiDecodedTransactionT Value Source # | |
Defined in Cardano.Wallet.Api.Client |
API Type Conversions
Others
data HealthStatusSMASH Source #
Parses the SMASH HealthCheck type from the SMASH API.
Constructors
HealthStatusSMASH | |
Instances
data HealthCheckSMASH Source #
Dscribes the health status of the SMASH server.
Constructors
Available | |
Unavailable | |
Unreachable | |
NoSmashConfigured |
Instances
newtype ApiHealthCheck Source #
Constructors
ApiHealthCheck | |
Fields |
Instances
newtype ApiAsArray (s :: Symbol ) a Source #
A wrapper that allows any type to be serialized as a JSON array.
The number of items permitted in the array is dependent on the wrapped type.
Constructors
ApiAsArray a |
Instances
Re-exports
The different bases that can be used.
See RFC4648 for details. In particular, Base64 can be standard or URL-safe . URL-safe encoding is often used in other specifications without padding characters.
RFC 2045 defines a separate Base64 encoding, which is not supported. This format requires a newline at least every 76 encoded characters, which works around limitations of older email programs that could not handle long lines. Be aware that other languages, such as Ruby, encode the RFC 2045 version by default. To decode their output, remove all newlines before decoding.
Examples
A quick example to show the differences:
>>>
let input = "Is 3 > 2?" :: ByteString
>>>
let convertedTo base = convertToBase base input :: ByteString
>>>
convertedTo Base16
"49732033203e20323f">>>
convertedTo Base32
"JFZSAMZAHYQDEPY=">>>
convertedTo Base64
"SXMgMyA+IDI/">>>
convertedTo Base64URLUnpadded
"SXMgMyA-IDI_">>>
convertedTo Base64OpenBSD
"QVKeKw.8GBG9"