Copyright	© 2018-2020 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Wallet

Contents

Development
WalletLayer
Capabilities
Interface
- Wallet
Shared Wallet
- Address
- Payment
- Migration
- Delegation
- Fee Estimation
- Transaction
- Root Key
Utilities
Logging

Description

Provides wallet layer functions that are used by API layer. Uses both Cardano.Wallet.DB and Cardano.Wallet.Network to realize its role as being intermediary between the three.

Functions of the wallet layer are often parameterized with variables following the convention below:

s : A s tate used to keep track of known addresses. Typically, possible values for this parameter are described in AddressDiscovery sub-modules. For instance SeqState or Rnd State .
k : A k ey derivation scheme intrinsically connected to the underlying discovery state s . This describes how the hierarchical structure of a wallet is defined as well as the relationship between secret keys and public addresses.

Synopsis

data WalletLayer m s (k :: Depth -> Type -> Type ) = WalletLayer ( Tracer m WalletWorkerLog ) ( Block , NetworkParameters ) ( NetworkLayer m Block ) ( TransactionLayer k SealedTx ) ( DBLayer m s k)
type HasDBLayer m s k = HasType ( DBLayer m s k)
dbLayer :: forall m s k ctx. HasDBLayer m s k ctx => Lens' ctx ( DBLayer m s k)
type HasLogger m msg = HasType ( Tracer m msg)
logger :: forall m msg ctx. HasLogger m msg ctx => Lens' ctx ( Tracer m msg)
type HasNetworkLayer m = HasType ( NetworkLayer m Block )
networkLayer :: forall m ctx. HasNetworkLayer m ctx => Lens' ctx ( NetworkLayer m Block )
type HasTransactionLayer k = HasType ( TransactionLayer k SealedTx )
transactionLayer :: forall k ctx. HasTransactionLayer k ctx => Lens' ctx ( TransactionLayer k SealedTx )
type HasGenesisData = HasType ( Block , NetworkParameters )
genesisData :: forall ctx. HasGenesisData ctx => Lens' ctx ( Block , NetworkParameters )
createWallet :: forall ctx m s k. ( MonadUnliftIO m, MonadTime m, HasGenesisData ctx, HasDBLayer m s k ctx, IsOurs s Address , IsOurs s RewardAccount ) => ctx -> WalletId -> WalletName -> s -> ExceptT ErrWalletAlreadyExists m WalletId
createIcarusWallet :: forall ctx s k n. ( HasGenesisData ctx, HasDBLayer IO s k ctx, PaymentAddress n k, k ~ IcarusKey , s ~ SeqState n k, Typeable n) => ctx -> WalletId -> WalletName -> (k ' RootK XPrv , Passphrase "encryption") -> ExceptT ErrWalletAlreadyExists IO WalletId
attachPrivateKeyFromPwd :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> (k ' RootK XPrv , Passphrase "user") -> ExceptT ErrNoSuchWallet IO ()
attachPrivateKeyFromPwdHash :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> (k ' RootK XPrv , PassphraseHash ) -> ExceptT ErrNoSuchWallet IO ()
getWalletUtxoSnapshot :: forall ctx s k. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, HasTransactionLayer k ctx) => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO [( TokenBundle , Coin )]
listUtxoStatistics :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ExceptT ErrListUTxOStatistics IO UTxOStatistics
readWallet :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO ( Wallet s, WalletMetadata , Set Tx )
deleteWallet :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO ()
restoreWallet :: forall ctx s k. ( HasNetworkLayer IO ctx, HasDBLayer IO s k ctx, HasLogger IO WalletWorkerLog ctx, IsOurs s Address , IsOurs s RewardAccount , AddressBookIso s, MaybeLight s) => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO ()
updateWallet :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ( WalletMetadata -> WalletMetadata ) -> ExceptT ErrNoSuchWallet IO ()
updateWalletPassphraseWithOldPassphrase :: forall ctx s k. ( HasDBLayer IO s k ctx, WalletKey k) => ctx -> WalletId -> ( Passphrase "user", Passphrase "user") -> ExceptT ErrUpdatePassphrase IO ()
updateWalletPassphraseWithMnemonic :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> (k ' RootK XPrv , Passphrase "user") -> ExceptT ErrUpdatePassphrase IO ()
walletSyncProgress :: forall ctx s. HasNetworkLayer IO ctx => ctx -> Wallet s -> IO SyncProgress
fetchRewardBalance :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> IO Coin
manageRewardBalance :: forall ctx s k (n :: NetworkDiscriminant ). ( HasLogger IO WalletWorkerLog ctx, HasNetworkLayer IO ctx, HasDBLayer IO s k ctx, Typeable s, Typeable n) => Proxy n -> ctx -> WalletId -> IO ()
rollbackBlocks :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> Slot -> ExceptT ErrNoSuchWallet IO ChainPoint
checkWalletIntegrity :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> GenesisParameters -> ExceptT ErrCheckWalletIntegrity IO ()
readNextWithdrawal :: forall ctx k. ( HasTransactionLayer k ctx, HasNetworkLayer IO ctx) => ctx -> AnyCardanoEra -> Coin -> IO Coin
readRewardAccount :: forall ctx s k (n :: NetworkDiscriminant ) shelley. ( HasDBLayer IO s k ctx, shelley ~ SeqState n ShelleyKey , Typeable n, Typeable s) => ctx -> WalletId -> ExceptT ErrReadRewardAccount IO ( RewardAccount , XPub , NonEmpty DerivationIndex )
someRewardAccount :: ToRewardAccount k => SomeMnemonic -> ( XPrv , RewardAccount , NonEmpty DerivationIndex )
readPolicyPublicKey :: forall ctx s k (n :: NetworkDiscriminant ) shelley. ( HasDBLayer IO s k ctx, shelley ~ SeqState n ShelleyKey , Typeable n, Typeable s) => ctx -> WalletId -> ExceptT ErrReadPolicyPublicKey IO ( XPub , NonEmpty DerivationIndex )
writePolicyPublicKey :: forall ctx s (n :: NetworkDiscriminant ). ( HasDBLayer IO s ShelleyKey ctx, s ~ SeqState n ShelleyKey ) => ctx -> WalletId -> Passphrase "user" -> ExceptT ErrWritePolicyPublicKey IO ( ShelleyKey ' PolicyK XPub )
queryRewardBalance :: forall ctx. HasNetworkLayer IO ctx => ctx -> RewardAccount -> ExceptT ErrFetchRewards IO Coin
newtype ErrWalletAlreadyExists = ErrWalletAlreadyExists WalletId
newtype ErrNoSuchWallet = ErrNoSuchWallet WalletId
newtype ErrListUTxOStatistics = ErrListUTxOStatisticsNoSuchWallet ErrNoSuchWallet
data ErrUpdatePassphrase
- = ErrUpdatePassphraseNoSuchWallet ErrNoSuchWallet
- | ErrUpdatePassphraseWithRootKey ErrWithRootKey
newtype ErrFetchRewards = ErrFetchRewardsReadRewardAccount ErrReadRewardAccount
data ErrCheckWalletIntegrity
- = ErrCheckWalletIntegrityNoSuchWallet ErrNoSuchWallet
- | ErrCheckIntegrityDifferentGenesis ( Hash "Genesis") ( Hash "Genesis")
newtype ErrWalletNotResponding = ErrWalletNotResponding WalletId
data ErrReadRewardAccount
- = ErrReadRewardAccountNotAShelleyWallet
- | ErrReadRewardAccountNoSuchWallet ErrNoSuchWallet
data ErrReadPolicyPublicKey
- = ErrReadPolicyPublicKeyNotAShelleyWallet
- | ErrReadPolicyPublicKeyNoSuchWallet ErrNoSuchWallet
- | ErrReadPolicyPublicKeyAbsent
data ErrWritePolicyPublicKey
- = ErrWritePolicyPublicKeyNoSuchWallet ErrNoSuchWallet
- | ErrWritePolicyPublicKeyWithRootKey ErrWithRootKey
data ErrGetPolicyId
- = ErrGetPolicyIdReadPolicyPubliKey ErrReadPolicyPublicKey
- | ErrGetPolicyIdWrongMintingBurningTemplate
updateCosigner :: forall ctx s k n. (s ~ SharedState n k, MkKeyFingerprint k Address , SoftDerivation k, Typeable n, WalletKey k, HasDBLayer IO s k ctx, k ~ SharedKey ) => ctx -> WalletId -> k ' AccountK XPub -> Cosigner -> CredentialType -> ExceptT ErrAddCosignerKey IO ()
data ErrAddCosignerKey
- = ErrAddCosignerKeyNoSuchWallet ErrNoSuchWallet
- | ErrAddCosignerKey ErrAddCosigner
data ErrConstructSharedWallet
- = ErrConstructSharedWalletWrongScriptTemplate ErrScriptTemplate
- | ErrConstructSharedWalletInvalidIndex ( ErrInvalidDerivationIndex ' Hardened ' AccountK )
normalizeSharedAddress :: forall n k. ( SupportsDiscovery n k, k ~ SharedKey ) => SharedState n k -> Address -> Maybe Address
constructSharedTransaction :: forall ctx s k (n :: NetworkDiscriminant ). ( HasTransactionLayer k ctx, HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, k ~ SharedKey , s ~ SharedState n k) => ctx -> WalletId -> AnyCardanoEra -> TransactionCtx -> SelectionOf TxOut -> ExceptT ErrConstructTx IO SealedTx
createRandomAddress :: forall ctx s k n. ( HasDBLayer IO s k ctx, PaymentAddress n k, RndStateLike s, k ~ ByronKey , AddressBookIso s) => ctx -> WalletId -> Passphrase "user" -> Maybe ( Index ' Hardened ' AddressK ) -> ExceptT ErrCreateRandomAddress IO ( Address , NonEmpty DerivationIndex )
importRandomAddresses :: forall ctx s k. ( HasDBLayer IO s k ctx, RndStateLike s, k ~ ByronKey , AddressBookIso s) => ctx -> WalletId -> [ Address ] -> ExceptT ErrImportRandomAddress IO ()
listAddresses :: forall ctx s k. ( HasDBLayer IO s k ctx, CompareDiscovery s, KnownAddresses s) => ctx -> WalletId -> (s -> Address -> Maybe Address ) -> ExceptT ErrNoSuchWallet IO [( Address , AddressState , NonEmpty DerivationIndex )]
normalizeDelegationAddress :: forall s k n. ( DelegationAddress n k, s ~ SeqState n k) => s -> Address -> Maybe Address
lookupTxIns :: forall ctx s k. ( HasDBLayer IO s k ctx, IsOurs s Address ) => ctx -> WalletId -> [ TxIn ] -> ExceptT ErrDecodeTx IO [( TxIn , Maybe ( TxOut , NonEmpty DerivationIndex ))]
lookupTxOuts :: forall ctx s k. ( HasDBLayer IO s k ctx, IsOurs s Address ) => ctx -> WalletId -> [ TxOut ] -> ExceptT ErrDecodeTx IO [( TxOut , Maybe ( NonEmpty DerivationIndex ))]
data ErrCreateRandomAddress
- = ErrIndexAlreadyExists ( Index ' Hardened ' AddressK )
- | ErrCreateAddrNoSuchWallet ErrNoSuchWallet
- | ErrCreateAddrWithRootKey ErrWithRootKey
- | ErrCreateAddressNotAByronWallet
data ErrImportRandomAddress
- = ErrImportAddrNoSuchWallet ErrNoSuchWallet
- | ErrImportAddr ErrImportAddress
- | ErrImportAddressNotAByronWallet
newtype ErrImportAddress = ErrAddrDoesNotBelong Address
newtype ErrDecodeTx = ErrDecodeTxNoSuchWallet ErrNoSuchWallet
getTxExpiry :: TimeInterpreter ( ExceptT PastHorizonException IO ) -> Maybe NominalDiffTime -> IO SlotNo
data SelectAssetsParams s result = SelectAssetsParams {
- outputs :: [ TxOut ]
- pendingTxs :: Set Tx
- randomSeed :: Maybe StdGenSeed
- txContext :: TransactionCtx
- utxoAvailableForCollateral :: Map WalletUTxO TokenBundle
- utxoAvailableForInputs :: UTxOSelection WalletUTxO
- wallet :: Wallet s
- selectionStrategy :: SelectionStrategy
}
selectAssets :: forall ctx m s k result. ( BoundedAddressLength k, HasTransactionLayer k ctx, HasLogger m WalletWorkerLog ctx, MonadRandom m) => ctx -> AnyCardanoEra -> ProtocolParameters -> SelectAssetsParams s result -> (s -> Selection -> result) -> ExceptT ErrSelectAssets m result
readWalletUTxOIndex :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO ( UTxOIndex WalletUTxO , Wallet s, Set Tx )
assignChangeAddresses :: forall s. GenChange s => ArgGenChange s -> Selection -> s -> ( SelectionOf TxOut , s)
assignChangeAddressesAndUpdateDb :: forall ctx s k. ( GenChange s, HasDBLayer IO s k ctx, AddressBookIso s) => ctx -> WalletId -> ArgGenChange s -> Selection -> ExceptT ErrSignPayment IO ( SelectionOf TxOut )
assignChangeAddressesWithoutDbUpdate :: forall ctx s k. ( GenChange s, HasDBLayer IO s k ctx) => ctx -> WalletId -> ArgGenChange s -> Selection -> ExceptT ErrConstructTx IO ( SelectionOf TxOut )
selectionToUnsignedTx :: forall s input output change withdrawal. ( IsOurs s Address , input ~ ( TxIn , TxOut , NonEmpty DerivationIndex ), output ~ TxOut , change ~ TxChange ( NonEmpty DerivationIndex ), withdrawal ~ ( RewardAccount , Coin , NonEmpty DerivationIndex )) => Withdrawal -> SelectionOf TxOut -> s -> UnsignedTx input output change withdrawal
buildAndSignTransaction :: forall ctx s k. ( HasTransactionLayer k ctx, HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, IsOwned s k) => ctx -> WalletId -> AnyCardanoEra -> ((k ' RootK XPrv , Passphrase "encryption") -> ( XPrv , Passphrase "encryption")) -> Passphrase "user" -> TransactionCtx -> SelectionOf TxOut -> ExceptT ErrSignPayment IO ( Tx , TxMeta , UTCTime , SealedTx )
signTransaction :: forall k. ( WalletKey k, HardDerivation k, Bounded ( Index ( AddressIndexDerivationType k) ' AddressK )) => TransactionLayer k SealedTx -> AnyCardanoEra -> ( Address -> Maybe (k ' AddressK XPrv , Passphrase "encryption")) -> (k ' RootK XPrv , Passphrase "encryption") -> UTxO -> SealedTx -> SealedTx
constructTransaction :: forall ctx s k (n :: NetworkDiscriminant ). ( HasTransactionLayer k ctx, HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, Typeable s, Typeable n) => ctx -> WalletId -> AnyCardanoEra -> TransactionCtx -> SelectionOf TxOut -> ExceptT ErrConstructTx IO SealedTx
constructTxMeta :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> TransactionCtx -> [( TxIn , Coin )] -> [ TxOut ] -> ExceptT ErrSubmitTransaction IO TxMeta
data ErrSelectAssets
- = ErrSelectAssetsPrepareOutputsError ( SelectionOutputError WalletSelectionContext )
- | ErrSelectAssetsNoSuchWallet ErrNoSuchWallet
- | ErrSelectAssetsAlreadyWithdrawing Tx
- | ErrSelectAssetsSelectionError ( SelectionError WalletSelectionContext )
data ErrSignPayment
- = ErrSignPaymentMkTx ErrMkTransaction
- | ErrSignPaymentNoSuchWallet ErrNoSuchWallet
- | ErrSignPaymentWithRootKey ErrWithRootKey
- | ErrSignPaymentIncorrectTTL PastHorizonException
data ErrNotASequentialWallet = ErrNotASequentialWallet
data ErrWithdrawalNotWorth = ErrWithdrawalNotWorth
data ErrConstructTx
- = ErrConstructTxWrongPayload
- | ErrConstructTxBody ErrMkTransaction
- | ErrConstructTxNoSuchWallet ErrNoSuchWallet
- | ErrConstructTxReadRewardAccount ErrReadRewardAccount
- | ErrConstructTxIncorrectTTL PastHorizonException
- | ErrConstructTxMultidelegationNotSupported
- | ErrConstructTxMultiaccountNotSupported
- | ErrConstructTxWrongMintingBurningTemplate
- | ErrConstructTxAssetNameTooLong
- | ErrConstructTxMintOrBurnAssetQuantityOutOfBounds
- | ErrConstructTxWrongValidityBounds
- | ErrConstructTxValidityIntervalNotWithinScriptTimelock
- | ErrConstructTxSharedWalletPending
- | ErrConstructTxNotImplemented String
newtype ErrMintBurnAssets = ErrMintBurnNotImplemented Text
data ErrBalanceTx
- = ErrBalanceTxUpdateError ErrUpdateSealedTx
- | ErrBalanceTxSelectAssets ErrSelectAssets
- | ErrBalanceTxMaxSizeLimitExceeded
- | ErrBalanceTxExistingCollateral
- | ErrBalanceTxExistingTotalCollateral
- | ErrBalanceTxExistingReturnCollateral
- | ErrBalanceTxConflictingNetworks
- | ErrBalanceTxAssignRedeemers ErrAssignRedeemers
- | ErrBalanceTxInternalError ErrBalanceTxInternalError
- | ErrBalanceTxZeroAdaOutput
- | ErrByronTxNotSupported
data ErrBalanceTxInternalError
- = ErrUnderestimatedFee Coin SealedTx
- | ErrFailedBalancing Value
newtype ErrUpdateSealedTx = ErrExistingKeyWitnesses Int
data ErrCannotJoin
- = ErrAlreadyDelegating PoolId
- | ErrNoSuchPool PoolId
data ErrCannotQuit
- = ErrNotDelegatingOrAboutTo
- | ErrNonNullRewards Coin
data ErrSubmitTransaction
- = ErrSubmitTransactionNoSuchWallet ErrNoSuchWallet
- | ErrSubmitTransactionForeignWallet
- | ErrSubmitTransactionPartiallySignedOrNoSignedTx Int Int
- | ErrSubmitTransactionMultidelegationNotSupported
createMigrationPlan :: forall ctx k s. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, HasTransactionLayer k ctx) => ctx -> AnyCardanoEra -> WalletId -> Withdrawal -> ExceptT ErrCreateMigrationPlan IO MigrationPlan
migrationPlanToSelectionWithdrawals :: MigrationPlan -> Withdrawal -> NonEmpty Address -> Maybe ( NonEmpty ( SelectionWithoutChange , Withdrawal ))
type SelectionWithoutChange = SelectionOf Void
data ErrCreateMigrationPlan
- = ErrCreateMigrationPlanEmpty
- | ErrCreateMigrationPlanNoSuchWallet ErrNoSuchWallet
data PoolRetirementEpochInfo = PoolRetirementEpochInfo {
- currentEpoch :: EpochNo
- retirementEpoch :: EpochNo
}
joinStakePool :: forall ctx s k. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, HasLogger IO WalletWorkerLog ctx) => ctx -> EpochNo -> Set PoolId -> PoolId -> PoolLifeCycleStatus -> WalletId -> ExceptT ErrStakePoolDelegation IO ( DelegationAction , Maybe Coin )
quitStakePool :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> Withdrawal -> ExceptT ErrStakePoolDelegation IO DelegationAction
guardJoin :: Set PoolId -> WalletDelegation -> PoolId -> Maybe PoolRetirementEpochInfo -> Either ErrCannotJoin ()
guardQuit :: WalletDelegation -> Withdrawal -> Coin -> Either ErrCannotQuit ()
data ErrStakePoolDelegation
- = ErrStakePoolDelegationNoSuchWallet ErrNoSuchWallet
- | ErrStakePoolJoin ErrCannotJoin
- | ErrStakePoolQuit ErrCannotQuit
data FeeEstimation = FeeEstimation {
- estMinFee :: Word64
- estMaxFee :: Word64
}
estimateFee :: forall m. Monad m => ExceptT ErrSelectAssets m Coin -> ExceptT ErrSelectAssets m FeeEstimation
calcMinimumDeposit :: forall ctx s k. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx) => ctx -> WalletId -> ExceptT ErrSelectAssets IO Coin
calcMinimumCoinValues :: forall ctx k f. ( HasTransactionLayer k ctx, HasNetworkLayer IO ctx, Applicative f) => ctx -> AnyCardanoEra -> f TxOut -> IO (f Coin )
forgetTx :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> Hash "Tx" -> ExceptT ErrRemoveTx IO ()
listTransactions :: forall ctx s k. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx) => ctx -> WalletId -> Maybe Coin -> Maybe UTCTime -> Maybe UTCTime -> SortOrder -> ExceptT ErrListTransactions IO [ TransactionInfo ]
listAssets :: forall s k ctx. ( HasDBLayer IO s k ctx, IsOurs s Address ) => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO ( Set AssetId )
getTransaction :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> Hash "Tx" -> ExceptT ErrGetTransaction IO TransactionInfo
submitExternalTx :: forall ctx k. ( HasNetworkLayer IO ctx, HasTransactionLayer k ctx, HasLogger IO TxSubmitLog ctx) => ctx -> SealedTx -> ExceptT ErrPostTx IO Tx
submitTx :: forall ctx s k. ( HasNetworkLayer IO ctx, HasDBLayer IO s k ctx, HasLogger IO WalletWorkerLog ctx) => ctx -> WalletId -> ( Tx , TxMeta , SealedTx ) -> ExceptT ErrSubmitTx IO ()
balanceTransaction :: forall era m s k ctx. ( HasTransactionLayer k ctx, GenChange s, MonadRandom m, HasLogger m WalletWorkerLog ctx, IsShelleyBasedEra era, BoundedAddressLength k) => ctx -> ArgGenChange s -> ( ProtocolParameters , ProtocolParameters ) -> TimeInterpreter ( Either PastHorizonException ) -> ( UTxOIndex WalletUTxO , Wallet s, Set Tx ) -> PartialTx era -> ExceptT ErrBalanceTx m ( Tx era)
data PartialTx era = PartialTx {
- tx :: Tx era
- inputs :: [( TxIn , TxOut , Maybe ( Hash "Datum"))]
- redeemers :: [ Redeemer ]
}
data LocalTxSubmissionConfig = LocalTxSubmissionConfig {
- rateLimit :: DiffTime
- blockInterval :: Word64
}
defaultLocalTxSubmissionConfig :: LocalTxSubmissionConfig
runLocalTxSubmissionPool :: forall ctx s k m. ( MonadUnliftIO m, MonadMonotonicTime m, HasLogger IO WalletWorkerLog ctx, HasNetworkLayer m ctx, HasDBLayer m s k ctx) => LocalTxSubmissionConfig -> ctx -> WalletId -> m ()
data ErrMkTransaction
- = ErrMkTransactionNoSuchWallet WalletId
- | ErrMkTransactionTxBodyError Text
- | ErrMkTransactionInvalidEra AnyCardanoEra
- | ErrMkTransactionJoinStakePool ErrCannotJoin
- | ErrMkTransactionQuitStakePool ErrCannotQuit
- | ErrMkTransactionIncorrectTTL PastHorizonException
data ErrSubmitTx
- = ErrSubmitTxNetwork ErrPostTx
- | ErrSubmitTxNoSuchWallet ErrNoSuchWallet
- | ErrSubmitTxImpossible ErrNoSuchTransaction
data ErrRemoveTx
- = ErrRemoveTxNoSuchWallet ErrNoSuchWallet
- | ErrRemoveTxNoSuchTransaction ErrNoSuchTransaction
- | ErrRemoveTxAlreadyInLedger ( Hash "Tx")
newtype ErrPostTx = ErrPostTxValidationError Text
data ErrListTransactions
- = ErrListTransactionsNoSuchWallet ErrNoSuchWallet
- | ErrListTransactionsStartTimeLaterThanEndTime ErrStartTimeLaterThanEndTime
- | ErrListTransactionsMinWithdrawalWrong
- | ErrListTransactionsPastHorizonException PastHorizonException
data ErrGetTransaction
- = ErrGetTransactionNoSuchWallet ErrNoSuchWallet
- | ErrGetTransactionNoSuchTransaction ErrNoSuchTransaction
data ErrNoSuchTransaction = ErrNoSuchTransaction WalletId ( Hash "Tx")
data ErrStartTimeLaterThanEndTime = ErrStartTimeLaterThanEndTime {
- errStartTime :: UTCTime
- errEndTime :: UTCTime
}
data ErrWitnessTx
- = ErrWitnessTxSignTx ErrSignTx
- | ErrWitnessTxNoSuchWallet ErrNoSuchWallet
- | ErrWitnessTxWithRootKey ErrWithRootKey
- | ErrWitnessTxIncorrectTTL PastHorizonException
withRootKey :: forall ctx s k e a. HasDBLayer IO s k ctx => ctx -> WalletId -> Passphrase "user" -> ( ErrWithRootKey -> e) -> (k ' RootK XPrv -> PassphraseScheme -> ExceptT e IO a) -> ExceptT e IO a
derivePublicKey :: forall ctx s k. ( HasDBLayer IO s k ctx, SoftDerivation k, GetAccount s k) => ctx -> WalletId -> Role -> DerivationIndex -> ExceptT ErrDerivePublicKey IO (k ' AddressK XPub )
getAccountPublicKeyAtIndex :: forall ctx s k. ( HasDBLayer IO s k ctx, WalletKey k, GetPurpose k) => ctx -> WalletId -> Passphrase "user" -> DerivationIndex -> Maybe DerivationIndex -> ExceptT ErrReadAccountPublicKey IO (k ' AccountK XPub )
readAccountPublicKey :: forall ctx s k. ( HasDBLayer IO s k ctx, GetAccount s k) => ctx -> WalletId -> ExceptT ErrReadAccountPublicKey IO (k ' AccountK XPub )
signMetadataWith :: forall ctx s k n. ( HasDBLayer IO s k ctx, HardDerivation k, AddressIndexDerivationType k ~ ' Soft , WalletKey k, s ~ SeqState n k) => ctx -> WalletId -> Passphrase "user" -> ( Role , DerivationIndex ) -> TxMetadata -> ExceptT ErrSignMetadataWith IO ( Signature TxMetadata )
data ErrWithRootKey
- = ErrWithRootKeyNoRootKey WalletId
- | ErrWithRootKeyWrongPassphrase WalletId ErrWrongPassphrase
- | ErrWithRootKeyWrongMnemonic WalletId
data ErrWrongPassphrase
- = ErrWrongPassphrase
- | ErrPassphraseSchemeUnsupported PassphraseScheme
data ErrSignMetadataWith
- = ErrSignMetadataWithRootKey ErrWithRootKey
- | ErrSignMetadataWithNoSuchWallet ErrNoSuchWallet
- | ErrSignMetadataWithInvalidIndex ( ErrInvalidDerivationIndex ' Soft ' AddressK )
data ErrDerivePublicKey
- = ErrDerivePublicKeyNoSuchWallet ErrNoSuchWallet
- | ErrDerivePublicKeyInvalidIndex ( ErrInvalidDerivationIndex ' Soft ' AddressK )
data ErrReadAccountPublicKey
- = ErrReadAccountPublicKeyNoSuchWallet ErrNoSuchWallet
- | ErrReadAccountPublicKeyInvalidAccountIndex ( ErrInvalidDerivationIndex ' Hardened ' AccountK )
- | ErrReadAccountPublicKeyInvalidPurposeIndex ( ErrInvalidDerivationIndex ' Hardened ' PurposeK )
- | ErrReadAccountPublicKeyRootKey ErrWithRootKey
data ErrInvalidDerivationIndex derivation level = ErrIndexOutOfBound ( Index derivation level) ( Index derivation level) DerivationIndex
throttle :: ( MonadUnliftIO m, MonadMonotonicTime m) => DiffTime -> ( Time -> a -> m ()) -> m (a -> m ())
guardHardIndex :: Monad m => DerivationIndex -> ExceptT ( ErrInvalidDerivationIndex ' Hardened level) m ( Index ' Hardened whatever)
withNoSuchWallet :: Monad m => WalletId -> m ( Maybe a) -> ExceptT ErrNoSuchWallet m a
posAndNegFromCardanoValue :: Value -> ( TokenBundle , TokenBundle )
data WalletWorkerLog
- = MsgWallet WalletLog
- | MsgWalletFollow WalletFollowLog
- | MsgChainFollow ChainFollowLog
data WalletFollowLog
- = MsgDiscoveredDelegationCert SlotNo DelegationCertificate
- | MsgCheckpoint BlockHeader
- | MsgDiscoveredTxs [( Tx , TxMeta )]
- | MsgDiscoveredTxsContent [( Tx , TxMeta )]
data WalletLog
- = MsgSelectionStart Int [ TxOut ]
- | MsgSelectionForBalancingStart Int (BuildableInAnyEra PartialTx )
- | MsgSelectionError ( SelectionError WalletSelectionContext )
- | MsgSelectionReportSummarized SelectionReportSummarized
- | MsgSelectionReportDetailed SelectionReportDetailed
- | MsgMigrationUTxOBefore UTxOStatistics
- | MsgMigrationUTxOAfter UTxOStatistics
- | MsgRewardBalanceQuery BlockHeader
- | MsgRewardBalanceResult ( Either ErrFetchRewards Coin )
- | MsgRewardBalanceNoSuchWallet ErrNoSuchWallet
- | MsgRewardBalanceExited
- | MsgTxSubmit TxSubmitLog
- | MsgIsStakeKeyRegistered Bool
data TxSubmitLog
- = MsgSubmitTx Tx TxMeta SealedTx ( BracketLog' ( Either ErrSubmitTx ()))
- | MsgSubmitExternalTx ( Hash "Tx") ( BracketLog' ( Either ErrPostTx Tx ))
- | MsgRetryPostTx ( Hash "Tx") ( BracketLog' ( Either ErrPostTx ()))
- | MsgProcessPendingPool BracketLog

Development

Naming Conventions

Components inside a particular context ctx can be called via dedicated lenses (see Cardano.Wallet#Capabilities). These components are extracted from the context in a where clause according to the following naming convention:

db = ctx ^. dbLayer @s \ k@ for the DBLayer .
tr = ctx ^. logger for the Logger.
nw = ctx ^. networkLayer for the NetworkLayer .
tl = ctx ^. transactionLayer \ k@ for the TransactionLayer .
re = ctx ^. workerRegistry for the WorkerRegistry .

TroubleShooting

• Overlapping instances for HasType (DBLayer IO s k) ctx
    arising from a use of ‘myFunction’
  Matching instances:

Occurs when a particular function is missing a top-level constraint (because it uses another function that demands such constraint). Here, myFunction needs its surrounding context ctx to have a DBLayer but the constraint is missing from its host function.

Fix : Add " HasDBLayer s k " as a class-constraint to the surrounding function.

• Overlapping instances for HasType (DBLayer IO s t0 k0) ctx
    arising from a use of ‘myFunction’
  Matching givens (or their superclasses):

Occurs when a function is called in a context where type-level parameters can be inferred. Here, myFunction is called but it is unclear whether the parameter t0 and k0 of its context are the same as the ones from the function at the call-site.

Fix : Add type-applications at the call-site " myFunction @ctx @s \ k@"

WalletLayer

data WalletLayer m s (k :: Depth -> Type -> Type ) Source #

Constructors

WalletLayer ( Tracer m WalletWorkerLog ) ( Block , NetworkParameters ) ( NetworkLayer m Block ) ( TransactionLayer k SealedTx ) ( DBLayer m s k)

Instances

Instances details

Generic ( WalletLayer m s k) Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ( WalletLayer m s k) :: Type -> Type Source # Methods from :: WalletLayer m s k -> Rep ( WalletLayer m s k) x Source # to :: Rep ( WalletLayer m s k) x -> WalletLayer m s k Source #
type Rep ( WalletLayer m s k) Source #
Instance details Defined in Cardano.Wallet type Rep ( WalletLayer m s k) = D1 (' MetaData "WalletLayer" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "WalletLayer" ' PrefixI ' False ) (( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Tracer m WalletWorkerLog )) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Block , NetworkParameters ))) :: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( NetworkLayer m Block )) :: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( TransactionLayer k SealedTx )) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( DBLayer m s k))))))

Capabilities

Each function in the wallet layer is defined in function of a non-specialized context ctx . That context may require some extra capabilities via class-constraints in the function signature. Capabilities are expressed in the form of a " HasXXX " class-constraints sometimes with extra type parameters.

For example:

listWallets
    :: forall ctx s k.
        ( HasDBLayer s k ctx
        )
    => ctx
    -> IO [WalletId]

Requires that the given context has an access to a database layer DBLayer parameterized over the wallet state, a network target and a key derivation scheme. Components are pulled from the context generically (i.e. the concrete ctx must derive Generic ) using their associated type. The concrete ctx is therefore expected to be a product-type of all the necessary components.

One can build an interface using only a subset of the wallet layer capabilities and functions, for instance, something to fiddle with wallets and their metadata does not require any networking layer.

type HasDBLayer m s k = HasType ( DBLayer m s k) Source #

dbLayer :: forall m s k ctx. HasDBLayer m s k ctx => Lens' ctx ( DBLayer m s k) Source #

type HasLogger m msg = HasType ( Tracer m msg) Source #

logger :: forall m msg ctx. HasLogger m msg ctx => Lens' ctx ( Tracer m msg) Source #

type HasNetworkLayer m = HasType ( NetworkLayer m Block ) Source #

This module is only interested in one block-, and tx-type. This constraint hides that choice, for some ease of use.

networkLayer :: forall m ctx. HasNetworkLayer m ctx => Lens' ctx ( NetworkLayer m Block ) Source #

type HasTransactionLayer k = HasType ( TransactionLayer k SealedTx ) Source #

transactionLayer :: forall k ctx. HasTransactionLayer k ctx => Lens' ctx ( TransactionLayer k SealedTx ) Source #

type HasGenesisData = HasType ( Block , NetworkParameters ) Source #

genesisData :: forall ctx. HasGenesisData ctx => Lens' ctx ( Block , NetworkParameters ) Source #

Interface

Wallet

createWallet :: forall ctx m s k. ( MonadUnliftIO m, MonadTime m, HasGenesisData ctx, HasDBLayer m s k ctx, IsOurs s Address , IsOurs s RewardAccount ) => ctx -> WalletId -> WalletName -> s -> ExceptT ErrWalletAlreadyExists m WalletId Source #

Initialise and store a new wallet, returning its ID.

createIcarusWallet :: forall ctx s k n. ( HasGenesisData ctx, HasDBLayer IO s k ctx, PaymentAddress n k, k ~ IcarusKey , s ~ SeqState n k, Typeable n) => ctx -> WalletId -> WalletName -> (k ' RootK XPrv , Passphrase "encryption") -> ExceptT ErrWalletAlreadyExists IO WalletId Source #

Initialise and store a new legacy Icarus wallet. These wallets are intrinsically sequential, but, in the incentivized testnet, we only have access to the a snapshot of the MainNet.

To work-around this, we scan the genesis block with an arbitrary big gap and resort to a default gap afterwards.

attachPrivateKeyFromPwd :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> (k ' RootK XPrv , Passphrase "user") -> ExceptT ErrNoSuchWallet IO () Source #

attachPrivateKeyFromPwdHash :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> (k ' RootK XPrv , PassphraseHash ) -> ExceptT ErrNoSuchWallet IO () Source #

The hash here is the output of Scrypt function with the following parameters: - logN = 14 - r = 8 - p = 1 - bytesNumber = 64

getWalletUtxoSnapshot :: forall ctx s k. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, HasTransactionLayer k ctx) => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO [( TokenBundle , Coin )] Source #

listUtxoStatistics :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ExceptT ErrListUTxOStatistics IO UTxOStatistics Source #

List the wallet's UTxO statistics.

readWallet :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO ( Wallet s, WalletMetadata , Set Tx ) Source #

Retrieve the wallet state for the wallet with the given ID.

deleteWallet :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO () Source #

Remove an existing wallet. Note that there's no particular work to be done regarding the restoration worker as it will simply terminate on the next tick when noticing that the corresponding wallet is gone.

restoreWallet :: forall ctx s k. ( HasNetworkLayer IO ctx, HasDBLayer IO s k ctx, HasLogger IO WalletWorkerLog ctx, IsOurs s Address , IsOurs s RewardAccount , AddressBookIso s, MaybeLight s) => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO () Source #

Restore a wallet from its current tip.

After the wallet has been restored, this action will continue to fetch newly created blocks and apply them, or roll back to a previous point whenever the chain switches.

updateWallet :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ( WalletMetadata -> WalletMetadata ) -> ExceptT ErrNoSuchWallet IO () Source #

Update a wallet's metadata with the given update function.

updateWalletPassphraseWithOldPassphrase :: forall ctx s k. ( HasDBLayer IO s k ctx, WalletKey k) => ctx -> WalletId -> ( Passphrase "user", Passphrase "user") -> ExceptT ErrUpdatePassphrase IO () Source #

Change a wallet's passphrase to the given passphrase.

updateWalletPassphraseWithMnemonic :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> (k ' RootK XPrv , Passphrase "user") -> ExceptT ErrUpdatePassphrase IO () Source #

walletSyncProgress :: forall ctx s. HasNetworkLayer IO ctx => ctx -> Wallet s -> IO SyncProgress Source #

fetchRewardBalance :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> IO Coin Source #

Fetch the cached reward balance of a given wallet from the database.

manageRewardBalance :: forall ctx s k (n :: NetworkDiscriminant ). ( HasLogger IO WalletWorkerLog ctx, HasNetworkLayer IO ctx, HasDBLayer IO s k ctx, Typeable s, Typeable n) => Proxy n -> ctx -> WalletId -> IO () Source #

rollbackBlocks :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> Slot -> ExceptT ErrNoSuchWallet IO ChainPoint Source #

Rewind the UTxO snapshots, transaction history and other information to a the earliest point in the past that is before or is the point of rollback.

checkWalletIntegrity :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> GenesisParameters -> ExceptT ErrCheckWalletIntegrity IO () Source #

Check whether a wallet is in good shape when restarting a worker.

readNextWithdrawal :: forall ctx k. ( HasTransactionLayer k ctx, HasNetworkLayer IO ctx) => ctx -> AnyCardanoEra -> Coin -> IO Coin Source #

Read the current withdrawal capacity of a wallet. Note that, this simply returns 0 if:

a) There's no reward account for this type of wallet. b) The current reward value is too small to be considered (adding it would cost more than its value).

readRewardAccount :: forall ctx s k (n :: NetworkDiscriminant ) shelley. ( HasDBLayer IO s k ctx, shelley ~ SeqState n ShelleyKey , Typeable n, Typeable s) => ctx -> WalletId -> ExceptT ErrReadRewardAccount IO ( RewardAccount , XPub , NonEmpty DerivationIndex ) Source #

someRewardAccount :: ToRewardAccount k => SomeMnemonic -> ( XPrv , RewardAccount , NonEmpty DerivationIndex ) Source #

readPolicyPublicKey :: forall ctx s k (n :: NetworkDiscriminant ) shelley. ( HasDBLayer IO s k ctx, shelley ~ SeqState n ShelleyKey , Typeable n, Typeable s) => ctx -> WalletId -> ExceptT ErrReadPolicyPublicKey IO ( XPub , NonEmpty DerivationIndex ) Source #

writePolicyPublicKey :: forall ctx s (n :: NetworkDiscriminant ). ( HasDBLayer IO s ShelleyKey ctx, s ~ SeqState n ShelleyKey ) => ctx -> WalletId -> Passphrase "user" -> ExceptT ErrWritePolicyPublicKey IO ( ShelleyKey ' PolicyK XPub ) Source #

queryRewardBalance :: forall ctx. HasNetworkLayer IO ctx => ctx -> RewardAccount -> ExceptT ErrFetchRewards IO Coin Source #

Query the node for the reward balance of a given wallet.

Rather than force all callers of readWallet to wait for fetching the account balance (via the NetworkLayer ), we expose this function for it.

newtype ErrWalletAlreadyExists Source #

Forbidden operation was executed on an already existing wallet

Constructors

ErrWalletAlreadyExists WalletId

Instances

Instances details

Eq ErrWalletAlreadyExists Source #
Instance details Defined in Cardano.Wallet.DB Methods (==) :: ErrWalletAlreadyExists -> ErrWalletAlreadyExists -> Bool Source # (/=) :: ErrWalletAlreadyExists -> ErrWalletAlreadyExists -> Bool Source #
Show ErrWalletAlreadyExists Source #
Instance details Defined in Cardano.Wallet.DB Methods showsPrec :: Int -> ErrWalletAlreadyExists -> ShowS Source # show :: ErrWalletAlreadyExists -> String Source # showList :: [ ErrWalletAlreadyExists ] -> ShowS Source #
IsServerError ErrWalletAlreadyExists Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrWalletAlreadyExists -> ServerError Source #

newtype ErrNoSuchWallet Source #

Can't perform given operation because there's no wallet

Constructors

ErrNoSuchWallet WalletId

Instances

Instances details

Eq ErrNoSuchWallet Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Methods (==) :: ErrNoSuchWallet -> ErrNoSuchWallet -> Bool Source # (/=) :: ErrNoSuchWallet -> ErrNoSuchWallet -> Bool Source #
Show ErrNoSuchWallet Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Methods showsPrec :: Int -> ErrNoSuchWallet -> ShowS Source # show :: ErrNoSuchWallet -> String Source # showList :: [ ErrNoSuchWallet ] -> ShowS Source #
IsServerError ErrNoSuchWallet Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrNoSuchWallet -> ServerError Source #

newtype ErrListUTxOStatistics Source #

Errors that can occur when listing UTxO statistics.

Constructors

ErrListUTxOStatisticsNoSuchWallet ErrNoSuchWallet

Instances

Instances details

Eq ErrListUTxOStatistics Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrListUTxOStatistics -> ErrListUTxOStatistics -> Bool Source # (/=) :: ErrListUTxOStatistics -> ErrListUTxOStatistics -> Bool Source #
Show ErrListUTxOStatistics Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrListUTxOStatistics -> ShowS Source # show :: ErrListUTxOStatistics -> String Source # showList :: [ ErrListUTxOStatistics ] -> ShowS Source #
IsServerError ErrListUTxOStatistics Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrListUTxOStatistics -> ServerError Source #

data ErrUpdatePassphrase Source #

Errors that can occur when trying to change a wallet's passphrase.

Constructors

ErrUpdatePassphraseNoSuchWallet ErrNoSuchWallet
ErrUpdatePassphraseWithRootKey ErrWithRootKey

Instances

Instances details

Eq ErrUpdatePassphrase Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrUpdatePassphrase -> ErrUpdatePassphrase -> Bool Source # (/=) :: ErrUpdatePassphrase -> ErrUpdatePassphrase -> Bool Source #
Show ErrUpdatePassphrase Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrUpdatePassphrase -> ShowS Source # show :: ErrUpdatePassphrase -> String Source # showList :: [ ErrUpdatePassphrase ] -> ShowS Source #
IsServerError ErrUpdatePassphrase Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrUpdatePassphrase -> ServerError Source #

newtype ErrFetchRewards Source #

Errors that can occur when fetching the reward balance of a wallet

Constructors

ErrFetchRewardsReadRewardAccount ErrReadRewardAccount

Instances

Instances details

Eq ErrFetchRewards Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrFetchRewards -> ErrFetchRewards -> Bool Source # (/=) :: ErrFetchRewards -> ErrFetchRewards -> Bool Source #
Show ErrFetchRewards Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrFetchRewards -> ShowS Source # show :: ErrFetchRewards -> String Source # showList :: [ ErrFetchRewards ] -> ShowS Source #
Generic ErrFetchRewards Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrFetchRewards :: Type -> Type Source # Methods from :: ErrFetchRewards -> Rep ErrFetchRewards x Source # to :: Rep ErrFetchRewards x -> ErrFetchRewards Source #
IsServerError ErrFetchRewards Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrFetchRewards -> ServerError Source #
type Rep ErrFetchRewards Source #
Instance details Defined in Cardano.Wallet type Rep ErrFetchRewards = D1 (' MetaData "ErrFetchRewards" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "ErrFetchRewardsReadRewardAccount" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrReadRewardAccount )))

data ErrCheckWalletIntegrity Source #

Constructors

ErrCheckWalletIntegrityNoSuchWallet ErrNoSuchWallet
ErrCheckIntegrityDifferentGenesis ( Hash "Genesis") ( Hash "Genesis")

Instances

Instances details

Eq ErrCheckWalletIntegrity Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrCheckWalletIntegrity -> ErrCheckWalletIntegrity -> Bool Source # (/=) :: ErrCheckWalletIntegrity -> ErrCheckWalletIntegrity -> Bool Source #
Show ErrCheckWalletIntegrity Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrCheckWalletIntegrity -> ShowS Source # show :: ErrCheckWalletIntegrity -> String Source # showList :: [ ErrCheckWalletIntegrity ] -> ShowS Source #
Exception ErrCheckWalletIntegrity Source #
Instance details Defined in Cardano.Wallet Methods toException :: ErrCheckWalletIntegrity -> SomeException Source # fromException :: SomeException -> Maybe ErrCheckWalletIntegrity Source # displayException :: ErrCheckWalletIntegrity -> String Source #

newtype ErrWalletNotResponding Source #

Can't perform given operation because the wallet died.

Constructors

ErrWalletNotResponding WalletId

Instances

Instances details

Eq ErrWalletNotResponding Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrWalletNotResponding -> ErrWalletNotResponding -> Bool Source # (/=) :: ErrWalletNotResponding -> ErrWalletNotResponding -> Bool Source #
Show ErrWalletNotResponding Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrWalletNotResponding -> ShowS Source # show :: ErrWalletNotResponding -> String Source # showList :: [ ErrWalletNotResponding ] -> ShowS Source #
IsServerError ErrWalletNotResponding Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrWalletNotResponding -> ServerError Source #

data ErrReadRewardAccount Source #

Constructors

ErrReadRewardAccountNotAShelleyWallet
ErrReadRewardAccountNoSuchWallet ErrNoSuchWallet

Instances

Instances details

Eq ErrReadRewardAccount Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrReadRewardAccount -> ErrReadRewardAccount -> Bool Source # (/=) :: ErrReadRewardAccount -> ErrReadRewardAccount -> Bool Source #
Show ErrReadRewardAccount Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrReadRewardAccount -> ShowS Source # show :: ErrReadRewardAccount -> String Source # showList :: [ ErrReadRewardAccount ] -> ShowS Source #
Generic ErrReadRewardAccount Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrReadRewardAccount :: Type -> Type Source # Methods from :: ErrReadRewardAccount -> Rep ErrReadRewardAccount x Source # to :: Rep ErrReadRewardAccount x -> ErrReadRewardAccount Source #
IsServerError ErrReadRewardAccount Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrReadRewardAccount -> ServerError Source #
type Rep ErrReadRewardAccount Source #
Instance details Defined in Cardano.Wallet type Rep ErrReadRewardAccount = D1 (' MetaData "ErrReadRewardAccount" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrReadRewardAccountNotAShelleyWallet" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "ErrReadRewardAccountNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrNoSuchWallet )))

data ErrReadPolicyPublicKey Source #

Constructors

ErrReadPolicyPublicKeyNotAShelleyWallet
ErrReadPolicyPublicKeyNoSuchWallet ErrNoSuchWallet
ErrReadPolicyPublicKeyAbsent

Instances

Instances details

Eq ErrReadPolicyPublicKey Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrReadPolicyPublicKey -> ErrReadPolicyPublicKey -> Bool Source # (/=) :: ErrReadPolicyPublicKey -> ErrReadPolicyPublicKey -> Bool Source #
Show ErrReadPolicyPublicKey Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrReadPolicyPublicKey -> ShowS Source # show :: ErrReadPolicyPublicKey -> String Source # showList :: [ ErrReadPolicyPublicKey ] -> ShowS Source #
Generic ErrReadPolicyPublicKey Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrReadPolicyPublicKey :: Type -> Type Source # Methods from :: ErrReadPolicyPublicKey -> Rep ErrReadPolicyPublicKey x Source # to :: Rep ErrReadPolicyPublicKey x -> ErrReadPolicyPublicKey Source #
IsServerError ErrReadPolicyPublicKey Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrReadPolicyPublicKey -> ServerError Source #
type Rep ErrReadPolicyPublicKey Source #
Instance details Defined in Cardano.Wallet type Rep ErrReadPolicyPublicKey = D1 (' MetaData "ErrReadPolicyPublicKey" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrReadPolicyPublicKeyNotAShelleyWallet" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: ( C1 (' MetaCons "ErrReadPolicyPublicKeyNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrNoSuchWallet )) :+: C1 (' MetaCons "ErrReadPolicyPublicKeyAbsent" ' PrefixI ' False ) ( U1 :: Type -> Type )))

data ErrWritePolicyPublicKey Source #

Constructors

ErrWritePolicyPublicKeyNoSuchWallet ErrNoSuchWallet
ErrWritePolicyPublicKeyWithRootKey ErrWithRootKey

Instances

Instances details

Eq ErrWritePolicyPublicKey Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrWritePolicyPublicKey -> ErrWritePolicyPublicKey -> Bool Source # (/=) :: ErrWritePolicyPublicKey -> ErrWritePolicyPublicKey -> Bool Source #
Show ErrWritePolicyPublicKey Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrWritePolicyPublicKey -> ShowS Source # show :: ErrWritePolicyPublicKey -> String Source # showList :: [ ErrWritePolicyPublicKey ] -> ShowS Source #
Generic ErrWritePolicyPublicKey Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrWritePolicyPublicKey :: Type -> Type Source # Methods from :: ErrWritePolicyPublicKey -> Rep ErrWritePolicyPublicKey x Source # to :: Rep ErrWritePolicyPublicKey x -> ErrWritePolicyPublicKey Source #
IsServerError ErrWritePolicyPublicKey Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrWritePolicyPublicKey -> ServerError Source #
type Rep ErrWritePolicyPublicKey Source #
Instance details Defined in Cardano.Wallet type Rep ErrWritePolicyPublicKey = D1 (' MetaData "ErrWritePolicyPublicKey" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrWritePolicyPublicKeyNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrNoSuchWallet )) :+: C1 (' MetaCons "ErrWritePolicyPublicKeyWithRootKey" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrWithRootKey )))

data ErrGetPolicyId Source #

Errors that can occur when getting policy id.

Constructors

ErrGetPolicyIdReadPolicyPubliKey ErrReadPolicyPublicKey
ErrGetPolicyIdWrongMintingBurningTemplate

Instances

Instances details

Eq ErrGetPolicyId Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrGetPolicyId -> ErrGetPolicyId -> Bool Source # (/=) :: ErrGetPolicyId -> ErrGetPolicyId -> Bool Source #
Show ErrGetPolicyId Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrGetPolicyId -> ShowS Source # show :: ErrGetPolicyId -> String Source # showList :: [ ErrGetPolicyId ] -> ShowS Source #
IsServerError ErrGetPolicyId Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrGetPolicyId -> ServerError Source #

Shared Wallet

updateCosigner :: forall ctx s k n. (s ~ SharedState n k, MkKeyFingerprint k Address , SoftDerivation k, Typeable n, WalletKey k, HasDBLayer IO s k ctx, k ~ SharedKey ) => ctx -> WalletId -> k ' AccountK XPub -> Cosigner -> CredentialType -> ExceptT ErrAddCosignerKey IO () Source #

data ErrAddCosignerKey Source #

Constructors

ErrAddCosignerKeyNoSuchWallet ErrNoSuchWallet	The shared wallet doesn't exist?
ErrAddCosignerKey ErrAddCosigner	Error adding this co-signer to the shared wallet.

Instances

Instances details

Eq ErrAddCosignerKey Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrAddCosignerKey -> ErrAddCosignerKey -> Bool Source # (/=) :: ErrAddCosignerKey -> ErrAddCosignerKey -> Bool Source #
Show ErrAddCosignerKey Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrAddCosignerKey -> ShowS Source # show :: ErrAddCosignerKey -> String Source # showList :: [ ErrAddCosignerKey ] -> ShowS Source #
IsServerError ErrAddCosignerKey Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrAddCosignerKey -> ServerError Source #

data ErrConstructSharedWallet Source #

Constructors

ErrConstructSharedWalletWrongScriptTemplate ErrScriptTemplate	The shared wallet' script template doesn't pass validation
ErrConstructSharedWalletInvalidIndex ( ErrInvalidDerivationIndex ' Hardened ' AccountK )	User provided a derivation index outside of the `Hard` domain

Instances

Instances details

Eq ErrConstructSharedWallet Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrConstructSharedWallet -> ErrConstructSharedWallet -> Bool Source # (/=) :: ErrConstructSharedWallet -> ErrConstructSharedWallet -> Bool Source #
Show ErrConstructSharedWallet Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrConstructSharedWallet -> ShowS Source # show :: ErrConstructSharedWallet -> String Source # showList :: [ ErrConstructSharedWallet ] -> ShowS Source #
IsServerError ErrConstructSharedWallet Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrConstructSharedWallet -> ServerError Source #

normalizeSharedAddress :: forall n k. ( SupportsDiscovery n k, k ~ SharedKey ) => SharedState n k -> Address -> Maybe Address Source #

constructSharedTransaction :: forall ctx s k (n :: NetworkDiscriminant ). ( HasTransactionLayer k ctx, HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, k ~ SharedKey , s ~ SharedState n k) => ctx -> WalletId -> AnyCardanoEra -> TransactionCtx -> SelectionOf TxOut -> ExceptT ErrConstructTx IO SealedTx Source #

Construct an unsigned transaction from a given selection for a shared wallet.

Address

createRandomAddress :: forall ctx s k n. ( HasDBLayer IO s k ctx, PaymentAddress n k, RndStateLike s, k ~ ByronKey , AddressBookIso s) => ctx -> WalletId -> Passphrase "user" -> Maybe ( Index ' Hardened ' AddressK ) -> ExceptT ErrCreateRandomAddress IO ( Address , NonEmpty DerivationIndex ) Source #

importRandomAddresses :: forall ctx s k. ( HasDBLayer IO s k ctx, RndStateLike s, k ~ ByronKey , AddressBookIso s) => ctx -> WalletId -> [ Address ] -> ExceptT ErrImportRandomAddress IO () Source #

listAddresses Source #

Arguments

:: forall ctx s k. ( HasDBLayer IO s k ctx, CompareDiscovery s, KnownAddresses s)
=> ctx
-> WalletId
-> (s -> Address -> Maybe Address )	A function to normalize address, so that delegated addresses non-delegation addresses found in the transaction history are shown with their delegation settings. Use `Just` for wallet without delegation settings.
-> ExceptT ErrNoSuchWallet IO [( Address , AddressState , NonEmpty DerivationIndex )]

List all addresses of a wallet with their metadata. Addresses are ordered from the most-recently-discovered to the oldest known.

normalizeDelegationAddress :: forall s k n. ( DelegationAddress n k, s ~ SeqState n k) => s -> Address -> Maybe Address Source #

lookupTxIns :: forall ctx s k. ( HasDBLayer IO s k ctx, IsOurs s Address ) => ctx -> WalletId -> [ TxIn ] -> ExceptT ErrDecodeTx IO [( TxIn , Maybe ( TxOut , NonEmpty DerivationIndex ))] Source #

lookupTxOuts :: forall ctx s k. ( HasDBLayer IO s k ctx, IsOurs s Address ) => ctx -> WalletId -> [ TxOut ] -> ExceptT ErrDecodeTx IO [( TxOut , Maybe ( NonEmpty DerivationIndex ))] Source #

data ErrCreateRandomAddress Source #

Constructors

ErrIndexAlreadyExists ( Index ' Hardened ' AddressK )
ErrCreateAddrNoSuchWallet ErrNoSuchWallet
ErrCreateAddrWithRootKey ErrWithRootKey
ErrCreateAddressNotAByronWallet

Instances

Instances details

Eq ErrCreateRandomAddress Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrCreateRandomAddress -> ErrCreateRandomAddress -> Bool Source # (/=) :: ErrCreateRandomAddress -> ErrCreateRandomAddress -> Bool Source #
Show ErrCreateRandomAddress Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrCreateRandomAddress -> ShowS Source # show :: ErrCreateRandomAddress -> String Source # showList :: [ ErrCreateRandomAddress ] -> ShowS Source #
Generic ErrCreateRandomAddress Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrCreateRandomAddress :: Type -> Type Source # Methods from :: ErrCreateRandomAddress -> Rep ErrCreateRandomAddress x Source # to :: Rep ErrCreateRandomAddress x -> ErrCreateRandomAddress Source #
IsServerError ErrCreateRandomAddress Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrCreateRandomAddress -> ServerError Source #
type Rep ErrCreateRandomAddress Source #
Instance details Defined in Cardano.Wallet type Rep ErrCreateRandomAddress = D1 (' MetaData "ErrCreateRandomAddress" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) (( C1 (' MetaCons "ErrIndexAlreadyExists" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Index ' Hardened ' AddressK ))) :+: C1 (' MetaCons "ErrCreateAddrNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrNoSuchWallet ))) :+: ( C1 (' MetaCons "ErrCreateAddrWithRootKey" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrWithRootKey )) :+: C1 (' MetaCons "ErrCreateAddressNotAByronWallet" ' PrefixI ' False ) ( U1 :: Type -> Type )))

data ErrImportRandomAddress Source #

Constructors

ErrImportAddrNoSuchWallet ErrNoSuchWallet
ErrImportAddr ErrImportAddress
ErrImportAddressNotAByronWallet

Instances

Instances details

Eq ErrImportRandomAddress Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrImportRandomAddress -> ErrImportRandomAddress -> Bool Source # (/=) :: ErrImportRandomAddress -> ErrImportRandomAddress -> Bool Source #
Show ErrImportRandomAddress Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrImportRandomAddress -> ShowS Source # show :: ErrImportRandomAddress -> String Source # showList :: [ ErrImportRandomAddress ] -> ShowS Source #
Generic ErrImportRandomAddress Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrImportRandomAddress :: Type -> Type Source # Methods from :: ErrImportRandomAddress -> Rep ErrImportRandomAddress x Source # to :: Rep ErrImportRandomAddress x -> ErrImportRandomAddress Source #
IsServerError ErrImportRandomAddress Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrImportRandomAddress -> ServerError Source #
type Rep ErrImportRandomAddress Source #
Instance details Defined in Cardano.Wallet type Rep ErrImportRandomAddress = D1 (' MetaData "ErrImportRandomAddress" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrImportAddrNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrNoSuchWallet )) :+: ( C1 (' MetaCons "ErrImportAddr" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrImportAddress )) :+: C1 (' MetaCons "ErrImportAddressNotAByronWallet" ' PrefixI ' False ) ( U1 :: Type -> Type )))

newtype ErrImportAddress Source #

Constructors

ErrAddrDoesNotBelong Address

Instances

Instances details

Eq ErrImportAddress Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDiscovery.Random Methods (==) :: ErrImportAddress -> ErrImportAddress -> Bool Source # (/=) :: ErrImportAddress -> ErrImportAddress -> Bool Source #
Show ErrImportAddress Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDiscovery.Random Methods showsPrec :: Int -> ErrImportAddress -> ShowS Source # show :: ErrImportAddress -> String Source # showList :: [ ErrImportAddress ] -> ShowS Source #
Generic ErrImportAddress Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDiscovery.Random Associated Types type Rep ErrImportAddress :: Type -> Type Source # Methods from :: ErrImportAddress -> Rep ErrImportAddress x Source # to :: Rep ErrImportAddress x -> ErrImportAddress Source #
type Rep ErrImportAddress Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDiscovery.Random type Rep ErrImportAddress = D1 (' MetaData "ErrImportAddress" "Cardano.Wallet.Primitive.AddressDiscovery.Random" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "ErrAddrDoesNotBelong" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Address )))

newtype ErrDecodeTx Source #

Errors that can occur when decoding a transaction.

Constructors

ErrDecodeTxNoSuchWallet ErrNoSuchWallet

Instances

Instances details

Eq ErrDecodeTx Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrDecodeTx -> ErrDecodeTx -> Bool Source # (/=) :: ErrDecodeTx -> ErrDecodeTx -> Bool Source #
Show ErrDecodeTx Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrDecodeTx -> ShowS Source # show :: ErrDecodeTx -> String Source # showList :: [ ErrDecodeTx ] -> ShowS Source #
IsServerError ErrDecodeTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrDecodeTx -> ServerError Source #

Payment

getTxExpiry Source #

Arguments

:: TimeInterpreter ( ExceptT PastHorizonException IO )	Context for time to slot calculation.
-> Maybe NominalDiffTime	Time to live (TTL) in seconds from now.
-> IO SlotNo

Calculate the transaction expiry slot, given a TimeInterpreter , and an optional TTL in seconds.

If no TTL is provided, a default of 2 hours is used (note: there is no particular reason why we chose that duration).

data SelectAssetsParams s result Source #

Parameters for the selectAssets function.

Constructors

SelectAssetsParams
Fields outputs :: [ TxOut ] pendingTxs :: Set Tx randomSeed :: Maybe StdGenSeed txContext :: TransactionCtx utxoAvailableForCollateral :: Map WalletUTxO TokenBundle utxoAvailableForInputs :: UTxOSelection WalletUTxO wallet :: Wallet s selectionStrategy :: SelectionStrategy Specifies which selection strategy to use. See `SelectionStrategy` .

Instances

Instances details

Generic ( SelectAssetsParams s result) Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ( SelectAssetsParams s result) :: Type -> Type Source # Methods from :: SelectAssetsParams s result -> Rep ( SelectAssetsParams s result) x Source # to :: Rep ( SelectAssetsParams s result) x -> SelectAssetsParams s result Source #
type Rep ( SelectAssetsParams s result) Source #
Instance details Defined in Cardano.Wallet type Rep ( SelectAssetsParams s result) = D1 (' MetaData "SelectAssetsParams" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "SelectAssetsParams" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "outputs") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [ TxOut ]) :: S1 (' MetaSel (' Just "pendingTxs") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Set Tx ))) :: ( S1 (' MetaSel (' Just "randomSeed") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe StdGenSeed )) :: S1 (' MetaSel (' Just "txContext") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 TransactionCtx ))) :: (( S1 (' MetaSel (' Just "utxoAvailableForCollateral") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Map WalletUTxO TokenBundle )) :: S1 (' MetaSel (' Just "utxoAvailableForInputs") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( UTxOSelection WalletUTxO ))) :: ( S1 (' MetaSel (' Just "wallet") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Wallet s)) :*: S1 (' MetaSel (' Just "selectionStrategy") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 SelectionStrategy )))))

selectAssets :: forall ctx m s k result. ( BoundedAddressLength k, HasTransactionLayer k ctx, HasLogger m WalletWorkerLog ctx, MonadRandom m) => ctx -> AnyCardanoEra -> ProtocolParameters -> SelectAssetsParams s result -> (s -> Selection -> result) -> ExceptT ErrSelectAssets m result Source #

Selects assets from a wallet.

This function has the following responsibilities:

selecting inputs from the UTxO set to pay for user-specified outputs;
selecting inputs from the UTxO set to pay for collateral;
producing change outputs to return excess value to the wallet;
balancing a selection to pay for the transaction fee.

When selecting inputs to pay for user-specified outputs, inputs are selected randomly.

By default, the seed used for random selection is derived automatically, from the given MonadRandom context.

However, if a concrete value is specified for the optional $sel:randomSeed:SelectAssetsParams parameter, then that value will be used instead as the seed for random selection.

readWalletUTxOIndex :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO ( UTxOIndex WalletUTxO , Wallet s, Set Tx ) Source #

Read a wallet checkpoint and index its UTxO, for selectAssets and selectAssetsNoOutputs .

assignChangeAddresses :: forall s. GenChange s => ArgGenChange s -> Selection -> s -> ( SelectionOf TxOut , s) Source #

Augments the given outputs with new outputs. These new outputs correspond to change outputs to which new addresses have been assigned. This updates the wallet state as it needs to keep track of new pending change addresses.

assignChangeAddressesAndUpdateDb :: forall ctx s k. ( GenChange s, HasDBLayer IO s k ctx, AddressBookIso s) => ctx -> WalletId -> ArgGenChange s -> Selection -> ExceptT ErrSignPayment IO ( SelectionOf TxOut ) Source #

assignChangeAddressesWithoutDbUpdate :: forall ctx s k. ( GenChange s, HasDBLayer IO s k ctx) => ctx -> WalletId -> ArgGenChange s -> Selection -> ExceptT ErrConstructTx IO ( SelectionOf TxOut ) Source #

selectionToUnsignedTx :: forall s input output change withdrawal. ( IsOurs s Address , input ~ ( TxIn , TxOut , NonEmpty DerivationIndex ), output ~ TxOut , change ~ TxChange ( NonEmpty DerivationIndex ), withdrawal ~ ( RewardAccount , Coin , NonEmpty DerivationIndex )) => Withdrawal -> SelectionOf TxOut -> s -> UnsignedTx input output change withdrawal Source #

buildAndSignTransaction Source #

Arguments

:: forall ctx s k. ( HasTransactionLayer k ctx, HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, IsOwned s k)
=> ctx
-> WalletId
-> AnyCardanoEra
-> ((k ' RootK XPrv , Passphrase "encryption") -> ( XPrv , Passphrase "encryption"))	Reward account derived from the root key (or somewhere else).
-> Passphrase "user"
-> TransactionCtx
-> SelectionOf TxOut
-> ExceptT ErrSignPayment IO ( Tx , TxMeta , UTCTime , SealedTx )

Produce witnesses and construct a transaction from a given selection.

Requires the encryption passphrase in order to decrypt the root private key. Note that this doesn't broadcast the transaction to the network. In order to do so, use submitTx .

signTransaction Source #

Arguments

:: forall k. ( WalletKey k, HardDerivation k, Bounded ( Index ( AddressIndexDerivationType k) ' AddressK ))
=> TransactionLayer k SealedTx	The way to interact with the wallet backend
-> AnyCardanoEra	Preferred latest era
-> ( Address -> Maybe (k ' AddressK XPrv , Passphrase "encryption"))	The wallets address-key lookup function
-> (k ' RootK XPrv , Passphrase "encryption")	The root key of the wallet
-> UTxO	The total UTxO set of the wallet (i.e. if pending transactions all applied).
-> SealedTx	The transaction to sign
-> SealedTx	The original transaction, with additional signatures added where necessary

constructTransaction :: forall ctx s k (n :: NetworkDiscriminant ). ( HasTransactionLayer k ctx, HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, Typeable s, Typeable n) => ctx -> WalletId -> AnyCardanoEra -> TransactionCtx -> SelectionOf TxOut -> ExceptT ErrConstructTx IO SealedTx Source #

Construct an unsigned transaction from a given selection.

constructTxMeta :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> TransactionCtx -> [( TxIn , Coin )] -> [ TxOut ] -> ExceptT ErrSubmitTransaction IO TxMeta Source #

data ErrSelectAssets Source #

Constructors

ErrSelectAssetsPrepareOutputsError ( SelectionOutputError WalletSelectionContext )
ErrSelectAssetsNoSuchWallet ErrNoSuchWallet
ErrSelectAssetsAlreadyWithdrawing Tx
ErrSelectAssetsSelectionError ( SelectionError WalletSelectionContext )

Instances

Instances details

Eq ErrSelectAssets Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrSelectAssets -> ErrSelectAssets -> Bool Source # (/=) :: ErrSelectAssets -> ErrSelectAssets -> Bool Source #
Show ErrSelectAssets Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrSelectAssets -> ShowS Source # show :: ErrSelectAssets -> String Source # showList :: [ ErrSelectAssets ] -> ShowS Source #
Generic ErrSelectAssets Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrSelectAssets :: Type -> Type Source # Methods from :: ErrSelectAssets -> Rep ErrSelectAssets x Source # to :: Rep ErrSelectAssets x -> ErrSelectAssets Source #
IsServerError ErrSelectAssets Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrSelectAssets -> ServerError Source #
type Rep ErrSelectAssets Source #
Instance details Defined in Cardano.Wallet type Rep ErrSelectAssets = D1 (' MetaData "ErrSelectAssets" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) (( C1 (' MetaCons "ErrSelectAssetsPrepareOutputsError" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( SelectionOutputError WalletSelectionContext ))) :+: C1 (' MetaCons "ErrSelectAssetsNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrNoSuchWallet ))) :+: ( C1 (' MetaCons "ErrSelectAssetsAlreadyWithdrawing" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Tx )) :+: C1 (' MetaCons "ErrSelectAssetsSelectionError" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( SelectionError WalletSelectionContext )))))

data ErrSignPayment Source #

Errors that can occur when signing a transaction.

Constructors

ErrSignPaymentMkTx ErrMkTransaction
ErrSignPaymentNoSuchWallet ErrNoSuchWallet
ErrSignPaymentWithRootKey ErrWithRootKey
ErrSignPaymentIncorrectTTL PastHorizonException

Instances

Instances details

Eq ErrSignPayment Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrSignPayment -> ErrSignPayment -> Bool Source # (/=) :: ErrSignPayment -> ErrSignPayment -> Bool Source #
Show ErrSignPayment Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrSignPayment -> ShowS Source # show :: ErrSignPayment -> String Source # showList :: [ ErrSignPayment ] -> ShowS Source #
IsServerError ErrSignPayment Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrSignPayment -> ServerError Source #

data ErrNotASequentialWallet Source #

Constructors

ErrNotASequentialWallet

Instances

Instances details

Eq ErrNotASequentialWallet Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrNotASequentialWallet -> ErrNotASequentialWallet -> Bool Source # (/=) :: ErrNotASequentialWallet -> ErrNotASequentialWallet -> Bool Source #
Show ErrNotASequentialWallet Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrNotASequentialWallet -> ShowS Source # show :: ErrNotASequentialWallet -> String Source # showList :: [ ErrNotASequentialWallet ] -> ShowS Source #
Generic ErrNotASequentialWallet Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrNotASequentialWallet :: Type -> Type Source # Methods from :: ErrNotASequentialWallet -> Rep ErrNotASequentialWallet x Source # to :: Rep ErrNotASequentialWallet x -> ErrNotASequentialWallet Source #
IsServerError ErrNotASequentialWallet Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrNotASequentialWallet -> ServerError Source #
type Rep ErrNotASequentialWallet Source #
Instance details Defined in Cardano.Wallet type Rep ErrNotASequentialWallet = D1 (' MetaData "ErrNotASequentialWallet" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrNotASequentialWallet" ' PrefixI ' False ) ( U1 :: Type -> Type ))

data ErrWithdrawalNotWorth Source #

Constructors

ErrWithdrawalNotWorth

Instances

Instances details

Eq ErrWithdrawalNotWorth Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrWithdrawalNotWorth -> ErrWithdrawalNotWorth -> Bool Source # (/=) :: ErrWithdrawalNotWorth -> ErrWithdrawalNotWorth -> Bool Source #
Show ErrWithdrawalNotWorth Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrWithdrawalNotWorth -> ShowS Source # show :: ErrWithdrawalNotWorth -> String Source # showList :: [ ErrWithdrawalNotWorth ] -> ShowS Source #
Generic ErrWithdrawalNotWorth Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrWithdrawalNotWorth :: Type -> Type Source # Methods from :: ErrWithdrawalNotWorth -> Rep ErrWithdrawalNotWorth x Source # to :: Rep ErrWithdrawalNotWorth x -> ErrWithdrawalNotWorth Source #
IsServerError ErrWithdrawalNotWorth Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrWithdrawalNotWorth -> ServerError Source #
type Rep ErrWithdrawalNotWorth Source #
Instance details Defined in Cardano.Wallet type Rep ErrWithdrawalNotWorth = D1 (' MetaData "ErrWithdrawalNotWorth" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrWithdrawalNotWorth" ' PrefixI ' False ) ( U1 :: Type -> Type ))

data ErrConstructTx Source #

Errors that can occur when constructing an unsigned transaction.

Constructors

ErrConstructTxWrongPayload
ErrConstructTxBody ErrMkTransaction
ErrConstructTxNoSuchWallet ErrNoSuchWallet
ErrConstructTxReadRewardAccount ErrReadRewardAccount
ErrConstructTxIncorrectTTL PastHorizonException
ErrConstructTxMultidelegationNotSupported
ErrConstructTxMultiaccountNotSupported
ErrConstructTxWrongMintingBurningTemplate
ErrConstructTxAssetNameTooLong
ErrConstructTxMintOrBurnAssetQuantityOutOfBounds
ErrConstructTxWrongValidityBounds
ErrConstructTxValidityIntervalNotWithinScriptTimelock
ErrConstructTxSharedWalletPending
ErrConstructTxNotImplemented String	Temporary error constructor.

Instances

Instances details

Eq ErrConstructTx Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrConstructTx -> ErrConstructTx -> Bool Source # (/=) :: ErrConstructTx -> ErrConstructTx -> Bool Source #
Show ErrConstructTx Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrConstructTx -> ShowS Source # show :: ErrConstructTx -> String Source # showList :: [ ErrConstructTx ] -> ShowS Source #
IsServerError ErrConstructTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrConstructTx -> ServerError Source #

newtype ErrMintBurnAssets Source #

Constructors

ErrMintBurnNotImplemented Text

Temporary error constructor.

Instances

Instances details

Eq ErrMintBurnAssets Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrMintBurnAssets -> ErrMintBurnAssets -> Bool Source # (/=) :: ErrMintBurnAssets -> ErrMintBurnAssets -> Bool Source #
Show ErrMintBurnAssets Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrMintBurnAssets -> ShowS Source # show :: ErrMintBurnAssets -> String Source # showList :: [ ErrMintBurnAssets ] -> ShowS Source #

data ErrBalanceTx Source #

Errors that can occur when balancing transaction.

Constructors

ErrBalanceTxUpdateError ErrUpdateSealedTx
ErrBalanceTxSelectAssets ErrSelectAssets
ErrBalanceTxMaxSizeLimitExceeded
ErrBalanceTxExistingCollateral
ErrBalanceTxExistingTotalCollateral
ErrBalanceTxExistingReturnCollateral
ErrBalanceTxConflictingNetworks
ErrBalanceTxAssignRedeemers ErrAssignRedeemers
ErrBalanceTxInternalError ErrBalanceTxInternalError
ErrBalanceTxZeroAdaOutput
ErrByronTxNotSupported

Instances

Instances details

Eq ErrBalanceTx Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrBalanceTx -> ErrBalanceTx -> Bool Source # (/=) :: ErrBalanceTx -> ErrBalanceTx -> Bool Source #
Show ErrBalanceTx Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrBalanceTx -> ShowS Source # show :: ErrBalanceTx -> String Source # showList :: [ ErrBalanceTx ] -> ShowS Source #
IsServerError ErrBalanceTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrBalanceTx -> ServerError Source #

data ErrBalanceTxInternalError Source #

Constructors

ErrUnderestimatedFee Coin SealedTx
ErrFailedBalancing Value

Instances

Instances details

Eq ErrBalanceTxInternalError Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrBalanceTxInternalError -> ErrBalanceTxInternalError -> Bool Source # (/=) :: ErrBalanceTxInternalError -> ErrBalanceTxInternalError -> Bool Source #
Show ErrBalanceTxInternalError Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrBalanceTxInternalError -> ShowS Source # show :: ErrBalanceTxInternalError -> String Source # showList :: [ ErrBalanceTxInternalError ] -> ShowS Source #

newtype ErrUpdateSealedTx Source #

Constructors

ErrExistingKeyWitnesses Int

The SealedTx couldn't not be updated because the *n* existing key-witnesses would have been rendered invalid.

Instances

Instances details

Eq ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrUpdateSealedTx -> ErrUpdateSealedTx -> Bool Source # (/=) :: ErrUpdateSealedTx -> ErrUpdateSealedTx -> Bool Source #
Show ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrUpdateSealedTx -> ShowS Source # show :: ErrUpdateSealedTx -> String Source # showList :: [ ErrUpdateSealedTx ] -> ShowS Source #
Generic ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrUpdateSealedTx :: Type -> Type Source # Methods from :: ErrUpdateSealedTx -> Rep ErrUpdateSealedTx x Source # to :: Rep ErrUpdateSealedTx x -> ErrUpdateSealedTx Source #
IsServerError ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrUpdateSealedTx -> ServerError Source #
type Rep ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrUpdateSealedTx = D1 (' MetaData "ErrUpdateSealedTx" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "ErrExistingKeyWitnesses" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int )))

data ErrCannotJoin Source #

Constructors

ErrAlreadyDelegating PoolId
ErrNoSuchPool PoolId

Instances

Instances details

Eq ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrCannotJoin -> ErrCannotJoin -> Bool Source # (/=) :: ErrCannotJoin -> ErrCannotJoin -> Bool Source #
Show ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrCannotJoin -> ShowS Source # show :: ErrCannotJoin -> String Source # showList :: [ ErrCannotJoin ] -> ShowS Source #
Generic ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrCannotJoin :: Type -> Type Source # Methods from :: ErrCannotJoin -> Rep ErrCannotJoin x Source # to :: Rep ErrCannotJoin x -> ErrCannotJoin Source #
IsServerError ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrCannotJoin -> ServerError Source #
type Rep ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrCannotJoin = D1 (' MetaData "ErrCannotJoin" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrAlreadyDelegating" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PoolId )) :+: C1 (' MetaCons "ErrNoSuchPool" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PoolId )))

data ErrCannotQuit Source #

Constructors

ErrNotDelegatingOrAboutTo
ErrNonNullRewards Coin

Instances

Instances details

Eq ErrCannotQuit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrCannotQuit -> ErrCannotQuit -> Bool Source # (/=) :: ErrCannotQuit -> ErrCannotQuit -> Bool Source #
Show ErrCannotQuit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrCannotQuit -> ShowS Source # show :: ErrCannotQuit -> String Source # showList :: [ ErrCannotQuit ] -> ShowS Source #
IsServerError ErrCannotQuit Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrCannotQuit -> ServerError Source #

data ErrSubmitTransaction Source #

Errors that can occur when submitting a transaction.

Constructors

ErrSubmitTransactionNoSuchWallet ErrNoSuchWallet
ErrSubmitTransactionForeignWallet
ErrSubmitTransactionPartiallySignedOrNoSignedTx Int Int
ErrSubmitTransactionMultidelegationNotSupported

Instances

Instances details

Eq ErrSubmitTransaction Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrSubmitTransaction -> ErrSubmitTransaction -> Bool Source # (/=) :: ErrSubmitTransaction -> ErrSubmitTransaction -> Bool Source #
Show ErrSubmitTransaction Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrSubmitTransaction -> ShowS Source # show :: ErrSubmitTransaction -> String Source # showList :: [ ErrSubmitTransaction ] -> ShowS Source #
IsServerError ErrSubmitTransaction Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrSubmitTransaction -> ServerError Source #

Migration

createMigrationPlan :: forall ctx k s. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, HasTransactionLayer k ctx) => ctx -> AnyCardanoEra -> WalletId -> Withdrawal -> ExceptT ErrCreateMigrationPlan IO MigrationPlan Source #

migrationPlanToSelectionWithdrawals :: MigrationPlan -> Withdrawal -> NonEmpty Address -> Maybe ( NonEmpty ( SelectionWithoutChange , Withdrawal )) Source #

type SelectionWithoutChange = SelectionOf Void Source #

data ErrCreateMigrationPlan Source #

Constructors

ErrCreateMigrationPlanEmpty
ErrCreateMigrationPlanNoSuchWallet ErrNoSuchWallet

Instances

Instances details

Eq ErrCreateMigrationPlan Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrCreateMigrationPlan -> ErrCreateMigrationPlan -> Bool Source # (/=) :: ErrCreateMigrationPlan -> ErrCreateMigrationPlan -> Bool Source #
Show ErrCreateMigrationPlan Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrCreateMigrationPlan -> ShowS Source # show :: ErrCreateMigrationPlan -> String Source # showList :: [ ErrCreateMigrationPlan ] -> ShowS Source #
Generic ErrCreateMigrationPlan Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ErrCreateMigrationPlan :: Type -> Type Source # Methods from :: ErrCreateMigrationPlan -> Rep ErrCreateMigrationPlan x Source # to :: Rep ErrCreateMigrationPlan x -> ErrCreateMigrationPlan Source #
IsServerError ErrCreateMigrationPlan Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrCreateMigrationPlan -> ServerError Source #
type Rep ErrCreateMigrationPlan Source #
Instance details Defined in Cardano.Wallet type Rep ErrCreateMigrationPlan = D1 (' MetaData "ErrCreateMigrationPlan" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrCreateMigrationPlanEmpty" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "ErrCreateMigrationPlanNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrNoSuchWallet )))

Delegation

data PoolRetirementEpochInfo Source #

Constructors

PoolRetirementEpochInfo
Fields currentEpoch :: EpochNo The current epoch. retirementEpoch :: EpochNo The retirement epoch of a pool.

Instances

Instances details

Eq PoolRetirementEpochInfo Source #
Instance details Defined in Cardano.Wallet Methods (==) :: PoolRetirementEpochInfo -> PoolRetirementEpochInfo -> Bool Source # (/=) :: PoolRetirementEpochInfo -> PoolRetirementEpochInfo -> Bool Source #
Show PoolRetirementEpochInfo Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> PoolRetirementEpochInfo -> ShowS Source # show :: PoolRetirementEpochInfo -> String Source # showList :: [ PoolRetirementEpochInfo ] -> ShowS Source #
Generic PoolRetirementEpochInfo Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep PoolRetirementEpochInfo :: Type -> Type Source # Methods from :: PoolRetirementEpochInfo -> Rep PoolRetirementEpochInfo x Source # to :: Rep PoolRetirementEpochInfo x -> PoolRetirementEpochInfo Source #
type Rep PoolRetirementEpochInfo Source #
Instance details Defined in Cardano.Wallet type Rep PoolRetirementEpochInfo = D1 (' MetaData "PoolRetirementEpochInfo" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "PoolRetirementEpochInfo" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "currentEpoch") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 EpochNo ) :*: S1 (' MetaSel (' Just "retirementEpoch") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 EpochNo )))

joinStakePool Source #

Arguments

:: forall ctx s k. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx, HasLogger IO WalletWorkerLog ctx)
=> ctx
-> EpochNo
-> Set PoolId
-> PoolId
-> PoolLifeCycleStatus
-> WalletId
-> ExceptT ErrStakePoolDelegation IO ( DelegationAction , Maybe Coin )	snd is the deposit

quitStakePool :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> Withdrawal -> ExceptT ErrStakePoolDelegation IO DelegationAction Source #

Helper function to factor necessary logic for quitting a stake pool.

guardJoin :: Set PoolId -> WalletDelegation -> PoolId -> Maybe PoolRetirementEpochInfo -> Either ErrCannotJoin () Source #

guardQuit :: WalletDelegation -> Withdrawal -> Coin -> Either ErrCannotQuit () Source #

data ErrStakePoolDelegation Source #

Constructors

ErrStakePoolDelegationNoSuchWallet ErrNoSuchWallet
ErrStakePoolJoin ErrCannotJoin
ErrStakePoolQuit ErrCannotQuit

Instances

Instances details

IsServerError ErrStakePoolDelegation Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrStakePoolDelegation -> ServerError Source #

Fee Estimation

data FeeEstimation Source #

Result of a fee estimation process given a wallet and payment order.

Constructors

FeeEstimation
Fields estMinFee :: Word64 Most coin selections will result in a fee higher than this. estMaxFee :: Word64 Most coin selections will result in a fee lower than this.

Instances

Instances details

Eq FeeEstimation Source #
Instance details Defined in Cardano.Wallet Methods (==) :: FeeEstimation -> FeeEstimation -> Bool Source # (/=) :: FeeEstimation -> FeeEstimation -> Bool Source #
Show FeeEstimation Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> FeeEstimation -> ShowS Source # show :: FeeEstimation -> String Source # showList :: [ FeeEstimation ] -> ShowS Source #
Generic FeeEstimation Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep FeeEstimation :: Type -> Type Source # Methods from :: FeeEstimation -> Rep FeeEstimation x Source # to :: Rep FeeEstimation x -> FeeEstimation Source #
NFData FeeEstimation Source #
Instance details Defined in Cardano.Wallet Methods rnf :: FeeEstimation -> () Source #
type Rep FeeEstimation Source #
Instance details Defined in Cardano.Wallet type Rep FeeEstimation = D1 (' MetaData "FeeEstimation" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "FeeEstimation" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "estMinFee") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word64 ) :*: S1 (' MetaSel (' Just "estMaxFee") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word64 )))

estimateFee :: forall m. Monad m => ExceptT ErrSelectAssets m Coin -> ExceptT ErrSelectAssets m FeeEstimation Source #

Estimate the transaction fee for a given coin selection algorithm by repeatedly running it (100 times) and collecting the results. In the returned FeeEstimation , the minimum fee is that which 90% of the sampled fees are greater than. The maximum fee is the highest fee observed in the samples.

calcMinimumDeposit :: forall ctx s k. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx) => ctx -> WalletId -> ExceptT ErrSelectAssets IO Coin Source #

Calculate the minimum deposit necessary if a given wallet wanted to delegate to a pool. Said differently, this return either 0, or the value of the key deposit protocol parameters if the wallet has no registered stake key.

calcMinimumCoinValues :: forall ctx k f. ( HasTransactionLayer k ctx, HasNetworkLayer IO ctx, Applicative f) => ctx -> AnyCardanoEra -> f TxOut -> IO (f Coin ) Source #

Calculate the minimum coin values required for a bunch of specified outputs.

Transaction

forgetTx :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> Hash "Tx" -> ExceptT ErrRemoveTx IO () Source #

Remove a pending or expired transaction from the transaction history. This happens at the request of the user. If the transaction is already on chain, or is missing from the transaction history, an error will be returned.

If a Pending transaction is removed, but later appears in a block, it will be added back to the transaction history.

listTransactions :: forall ctx s k. ( HasDBLayer IO s k ctx, HasNetworkLayer IO ctx) => ctx -> WalletId -> Maybe Coin -> Maybe UTCTime -> Maybe UTCTime -> SortOrder -> ExceptT ErrListTransactions IO [ TransactionInfo ] Source #

List all transactions and metadata from history for a given wallet.

listAssets :: forall s k ctx. ( HasDBLayer IO s k ctx, IsOurs s Address ) => ctx -> WalletId -> ExceptT ErrNoSuchWallet IO ( Set AssetId ) Source #

Extract assets associated with a given wallet from its transaction history.

getTransaction :: forall ctx s k. HasDBLayer IO s k ctx => ctx -> WalletId -> Hash "Tx" -> ExceptT ErrGetTransaction IO TransactionInfo Source #

Get transaction and metadata from history for a given wallet.

submitExternalTx :: forall ctx k. ( HasNetworkLayer IO ctx, HasTransactionLayer k ctx, HasLogger IO TxSubmitLog ctx) => ctx -> SealedTx -> ExceptT ErrPostTx IO Tx Source #

Broadcast an externally-signed transaction to the network.

NOTE: external transactions will not be added to the LocalTxSubmission pool, so the user must retry submission themselves.

submitTx :: forall ctx s k. ( HasNetworkLayer IO ctx, HasDBLayer IO s k ctx, HasLogger IO WalletWorkerLog ctx) => ctx -> WalletId -> ( Tx , TxMeta , SealedTx ) -> ExceptT ErrSubmitTx IO () Source #

Broadcast a (signed) transaction to the network.

balanceTransaction :: forall era m s k ctx. ( HasTransactionLayer k ctx, GenChange s, MonadRandom m, HasLogger m WalletWorkerLog ctx, IsShelleyBasedEra era, BoundedAddressLength k) => ctx -> ArgGenChange s -> ( ProtocolParameters , ProtocolParameters ) -> TimeInterpreter ( Either PastHorizonException ) -> ( UTxOIndex WalletUTxO , Wallet s, Set Tx ) -> PartialTx era -> ExceptT ErrBalanceTx m ( Tx era) Source #

data PartialTx era Source #

A PartialTx is an an unbalanced SealedTx along with the necessary information to balance it.

The $sel:inputs:PartialTx and $sel:redeemers:PartialTx must match the binary transaction contained in the sealedTx .

Constructors

PartialTx
Fields tx :: Tx era inputs :: [( TxIn , TxOut , Maybe ( Hash "Datum"))] redeemers :: [ Redeemer ]

Instances

Instances details

Eq ( PartialTx era) Source #
Instance details Defined in Cardano.Wallet Methods (==) :: PartialTx era -> PartialTx era -> Bool Source # (/=) :: PartialTx era -> PartialTx era -> Bool Source #
Show ( PartialTx era) Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> PartialTx era -> ShowS Source # show :: PartialTx era -> String Source # showList :: [ PartialTx era] -> ShowS Source #
Generic ( PartialTx era) Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep ( PartialTx era) :: Type -> Type Source # Methods from :: PartialTx era -> Rep ( PartialTx era) x Source # to :: Rep ( PartialTx era) x -> PartialTx era Source #
Buildable ( PartialTx era) Source #
Instance details Defined in Cardano.Wallet Methods build :: PartialTx era -> Builder Source #
type Rep ( PartialTx era) Source #
Instance details Defined in Cardano.Wallet type Rep ( PartialTx era) = D1 (' MetaData "PartialTx" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "PartialTx" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "tx") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Tx era)) :: ( S1 (' MetaSel (' Just "inputs") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [( TxIn , TxOut , Maybe ( Hash "Datum"))]) :: S1 (' MetaSel (' Just "redeemers") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [ Redeemer ]))))

data LocalTxSubmissionConfig Source #

Parameters for runLocalTxSubmissionPool

Constructors

LocalTxSubmissionConfig
Fields rateLimit :: DiffTime Minimum time between checks of pending transactions blockInterval :: Word64 Resubmission interval, in terms of expected blocks.

Instances

Instances details

Eq LocalTxSubmissionConfig Source #
Instance details Defined in Cardano.Wallet Methods (==) :: LocalTxSubmissionConfig -> LocalTxSubmissionConfig -> Bool Source # (/=) :: LocalTxSubmissionConfig -> LocalTxSubmissionConfig -> Bool Source #
Show LocalTxSubmissionConfig Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> LocalTxSubmissionConfig -> ShowS Source # show :: LocalTxSubmissionConfig -> String Source # showList :: [ LocalTxSubmissionConfig ] -> ShowS Source #
Generic LocalTxSubmissionConfig Source #
Instance details Defined in Cardano.Wallet Associated Types type Rep LocalTxSubmissionConfig :: Type -> Type Source # Methods from :: LocalTxSubmissionConfig -> Rep LocalTxSubmissionConfig x Source # to :: Rep LocalTxSubmissionConfig x -> LocalTxSubmissionConfig Source #
type Rep LocalTxSubmissionConfig Source #
Instance details Defined in Cardano.Wallet type Rep LocalTxSubmissionConfig = D1 (' MetaData "LocalTxSubmissionConfig" "Cardano.Wallet" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "LocalTxSubmissionConfig" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "rateLimit") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 DiffTime ) :*: S1 (' MetaSel (' Just "blockInterval") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word64 )))

defaultLocalTxSubmissionConfig :: LocalTxSubmissionConfig Source #

The current default is to resubmit any pending transaction about once every 10 blocks.

The default rate limit for checking the pending list is 1000ms.

runLocalTxSubmissionPool :: forall ctx s k m. ( MonadUnliftIO m, MonadMonotonicTime m, HasLogger IO WalletWorkerLog ctx, HasNetworkLayer m ctx, HasDBLayer m s k ctx) => LocalTxSubmissionConfig -> ctx -> WalletId -> m () Source #

Continuous process which monitors the chain tip and retries submission of pending transactions as the chain lengthens.

Regardless of the frequency of chain updates, this function won't re-query the database faster than the configured $sel:rateLimit:LocalTxSubmissionConfig .

This only exits if the network layer watchNodeTip function exits.

data ErrMkTransaction Source #

Constructors

ErrMkTransactionNoSuchWallet WalletId
ErrMkTransactionTxBodyError Text	We failed to construct a transaction for some reasons.
ErrMkTransactionInvalidEra AnyCardanoEra	Should never happen, means that that we have programmatically provided an invalid era.
ErrMkTransactionJoinStakePool ErrCannotJoin
ErrMkTransactionQuitStakePool ErrCannotQuit
ErrMkTransactionIncorrectTTL PastHorizonException

Instances

Instances details

Eq ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrMkTransaction -> ErrMkTransaction -> Bool Source # (/=) :: ErrMkTransaction -> ErrMkTransaction -> Bool Source #
Show ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrMkTransaction -> ShowS Source # show :: ErrMkTransaction -> String Source # showList :: [ ErrMkTransaction ] -> ShowS Source #
Generic ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrMkTransaction :: Type -> Type Source # Methods from :: ErrMkTransaction -> Rep ErrMkTransaction x Source # to :: Rep ErrMkTransaction x -> ErrMkTransaction Source #
IsServerError ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrMkTransaction -> ServerError Source #
type Rep ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrMkTransaction = D1 (' MetaData "ErrMkTransaction" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) (( C1 (' MetaCons "ErrMkTransactionNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 WalletId )) :+: ( C1 (' MetaCons "ErrMkTransactionTxBodyError" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text )) :+: C1 (' MetaCons "ErrMkTransactionInvalidEra" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 AnyCardanoEra )))) :+: ( C1 (' MetaCons "ErrMkTransactionJoinStakePool" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrCannotJoin )) :+: ( C1 (' MetaCons "ErrMkTransactionQuitStakePool" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrCannotQuit )) :+: C1 (' MetaCons "ErrMkTransactionIncorrectTTL" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PastHorizonException )))))

data ErrSubmitTx Source #

Errors that can occur when submitting a signed transaction to the network.

Constructors

ErrSubmitTxNetwork ErrPostTx
ErrSubmitTxNoSuchWallet ErrNoSuchWallet
ErrSubmitTxImpossible ErrNoSuchTransaction

Instances

Instances details

Eq ErrSubmitTx Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrSubmitTx -> ErrSubmitTx -> Bool Source # (/=) :: ErrSubmitTx -> ErrSubmitTx -> Bool Source #
Show ErrSubmitTx Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrSubmitTx -> ShowS Source # show :: ErrSubmitTx -> String Source # showList :: [ ErrSubmitTx ] -> ShowS Source #
IsServerError ErrSubmitTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrSubmitTx -> ServerError Source #

data ErrRemoveTx Source #

Can't remove pending or expired transaction.

Constructors

ErrRemoveTxNoSuchWallet ErrNoSuchWallet
ErrRemoveTxNoSuchTransaction ErrNoSuchTransaction
ErrRemoveTxAlreadyInLedger ( Hash "Tx")

Instances

Instances details

Eq ErrRemoveTx Source #
Instance details Defined in Cardano.Wallet.DB Methods (==) :: ErrRemoveTx -> ErrRemoveTx -> Bool Source # (/=) :: ErrRemoveTx -> ErrRemoveTx -> Bool Source #
Show ErrRemoveTx Source #
Instance details Defined in Cardano.Wallet.DB Methods showsPrec :: Int -> ErrRemoveTx -> ShowS Source # show :: ErrRemoveTx -> String Source # showList :: [ ErrRemoveTx ] -> ShowS Source #
IsServerError ErrRemoveTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrRemoveTx -> ServerError Source #

newtype ErrPostTx Source #

Error while trying to send a transaction

Constructors

ErrPostTxValidationError Text

Instances

Instances details

Eq ErrPostTx Source #
Instance details Defined in Cardano.Wallet.Network Methods (==) :: ErrPostTx -> ErrPostTx -> Bool Source # (/=) :: ErrPostTx -> ErrPostTx -> Bool Source #
Show ErrPostTx Source #
Instance details Defined in Cardano.Wallet.Network Methods showsPrec :: Int -> ErrPostTx -> ShowS Source # show :: ErrPostTx -> String Source # showList :: [ ErrPostTx ] -> ShowS Source #
Generic ErrPostTx Source #
Instance details Defined in Cardano.Wallet.Network Associated Types type Rep ErrPostTx :: Type -> Type Source # Methods from :: ErrPostTx -> Rep ErrPostTx x Source # to :: Rep ErrPostTx x -> ErrPostTx Source #
ToText ErrPostTx Source #
Instance details Defined in Cardano.Wallet.Network Methods toText :: ErrPostTx -> Text Source #
IsServerError ErrPostTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrPostTx -> ServerError Source #
type Rep ErrPostTx Source #
Instance details Defined in Cardano.Wallet.Network type Rep ErrPostTx = D1 (' MetaData "ErrPostTx" "Cardano.Wallet.Network" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "ErrPostTxValidationError" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text )))

data ErrListTransactions Source #

Errors that can occur when trying to list transactions.

Constructors

ErrListTransactionsNoSuchWallet ErrNoSuchWallet
ErrListTransactionsStartTimeLaterThanEndTime ErrStartTimeLaterThanEndTime
ErrListTransactionsMinWithdrawalWrong
ErrListTransactionsPastHorizonException PastHorizonException

Instances

Instances details

Show ErrListTransactions Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrListTransactions -> ShowS Source # show :: ErrListTransactions -> String Source # showList :: [ ErrListTransactions ] -> ShowS Source #
IsServerError ErrListTransactions Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrListTransactions -> ServerError Source #

data ErrGetTransaction Source #

Errors that can occur when trying to get transaction.

Constructors

ErrGetTransactionNoSuchWallet ErrNoSuchWallet
ErrGetTransactionNoSuchTransaction ErrNoSuchTransaction

Instances

Instances details

Eq ErrGetTransaction Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrGetTransaction -> ErrGetTransaction -> Bool Source # (/=) :: ErrGetTransaction -> ErrGetTransaction -> Bool Source #
Show ErrGetTransaction Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrGetTransaction -> ShowS Source # show :: ErrGetTransaction -> String Source # showList :: [ ErrGetTransaction ] -> ShowS Source #
IsServerError ErrGetTransaction Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrGetTransaction -> ServerError Source #

data ErrNoSuchTransaction Source #

Indicates that the specified transaction hash is not found in the transaction history of the given wallet.

Constructors

ErrNoSuchTransaction WalletId ( Hash "Tx")

Instances

Instances details

Eq ErrNoSuchTransaction Source #
Instance details Defined in Cardano.Wallet.DB Methods (==) :: ErrNoSuchTransaction -> ErrNoSuchTransaction -> Bool Source # (/=) :: ErrNoSuchTransaction -> ErrNoSuchTransaction -> Bool Source #
Show ErrNoSuchTransaction Source #
Instance details Defined in Cardano.Wallet.DB Methods showsPrec :: Int -> ErrNoSuchTransaction -> ShowS Source # show :: ErrNoSuchTransaction -> String Source # showList :: [ ErrNoSuchTransaction ] -> ShowS Source #
IsServerError ErrNoSuchTransaction Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrNoSuchTransaction -> ServerError Source #

data ErrStartTimeLaterThanEndTime Source #

Indicates that the specified start time is later than the specified end time.

Constructors

ErrStartTimeLaterThanEndTime
Fields errStartTime :: UTCTime errEndTime :: UTCTime

Instances

Instances details

Eq ErrStartTimeLaterThanEndTime Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrStartTimeLaterThanEndTime -> ErrStartTimeLaterThanEndTime -> Bool Source # (/=) :: ErrStartTimeLaterThanEndTime -> ErrStartTimeLaterThanEndTime -> Bool Source #
Show ErrStartTimeLaterThanEndTime Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrStartTimeLaterThanEndTime -> ShowS Source # show :: ErrStartTimeLaterThanEndTime -> String Source # showList :: [ ErrStartTimeLaterThanEndTime ] -> ShowS Source #
IsServerError ErrStartTimeLaterThanEndTime Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrStartTimeLaterThanEndTime -> ServerError Source #

data ErrWitnessTx Source #

Errors that can occur when signing a transaction.

Constructors

ErrWitnessTxSignTx ErrSignTx
ErrWitnessTxNoSuchWallet ErrNoSuchWallet
ErrWitnessTxWithRootKey ErrWithRootKey
ErrWitnessTxIncorrectTTL PastHorizonException

Instances

Instances details

Eq ErrWitnessTx Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrWitnessTx -> ErrWitnessTx -> Bool Source # (/=) :: ErrWitnessTx -> ErrWitnessTx -> Bool Source #
Show ErrWitnessTx Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrWitnessTx -> ShowS Source # show :: ErrWitnessTx -> String Source # showList :: [ ErrWitnessTx ] -> ShowS Source #
IsServerError ErrWitnessTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrWitnessTx -> ServerError Source #

Root Key

withRootKey :: forall ctx s k e a. HasDBLayer IO s k ctx => ctx -> WalletId -> Passphrase "user" -> ( ErrWithRootKey -> e) -> (k ' RootK XPrv -> PassphraseScheme -> ExceptT e IO a) -> ExceptT e IO a Source #

Execute an action which requires holding a root XPrv.

withRootKey takes a callback function with two arguments:

The encrypted root private key itself
The underlying passphrase scheme (legacy or new)

Caller are then expected to use preparePassphrase with the given scheme in order to "prepare" the passphrase to be used by other function. This does nothing for the new encryption, but for the legacy encryption with Scrypt, passphrases needed to first be CBOR serialized and blake2b_256 hashed.

@@ withRootKey ctx s k ctx wid pwd OnError $ xprv scheme -> changePassphrase (preparePassphrase scheme pwd) newPwd xprv @@@

derivePublicKey :: forall ctx s k. ( HasDBLayer IO s k ctx, SoftDerivation k, GetAccount s k) => ctx -> WalletId -> Role -> DerivationIndex -> ExceptT ErrDerivePublicKey IO (k ' AddressK XPub ) Source #

getAccountPublicKeyAtIndex :: forall ctx s k. ( HasDBLayer IO s k ctx, WalletKey k, GetPurpose k) => ctx -> WalletId -> Passphrase "user" -> DerivationIndex -> Maybe DerivationIndex -> ExceptT ErrReadAccountPublicKey IO (k ' AccountK XPub ) Source #

Retrieve any public account key of a wallet.

readAccountPublicKey :: forall ctx s k. ( HasDBLayer IO s k ctx, GetAccount s k) => ctx -> WalletId -> ExceptT ErrReadAccountPublicKey IO (k ' AccountK XPub ) Source #

Retrieve current public account key of a wallet.

signMetadataWith :: forall ctx s k n. ( HasDBLayer IO s k ctx, HardDerivation k, AddressIndexDerivationType k ~ ' Soft , WalletKey k, s ~ SeqState n k) => ctx -> WalletId -> Passphrase "user" -> ( Role , DerivationIndex ) -> TxMetadata -> ExceptT ErrSignMetadataWith IO ( Signature TxMetadata ) Source #

Sign an arbitrary transaction metadata object with a private key belonging to the wallet's account.

This is experimental, and will likely be replaced by a more robust to arbitrary message signing using COSE, or a subset of it.

data ErrWithRootKey Source #

Errors that can occur when trying to perform an operation on a wallet that requires a private key, but where none is attached to the wallet.

Constructors

ErrWithRootKeyNoRootKey WalletId
ErrWithRootKeyWrongPassphrase WalletId ErrWrongPassphrase
ErrWithRootKeyWrongMnemonic WalletId

Instances

Instances details

Eq ErrWithRootKey Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrWithRootKey -> ErrWithRootKey -> Bool Source # (/=) :: ErrWithRootKey -> ErrWithRootKey -> Bool Source #
Show ErrWithRootKey Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrWithRootKey -> ShowS Source # show :: ErrWithRootKey -> String Source # showList :: [ ErrWithRootKey ] -> ShowS Source #
IsServerError ErrWithRootKey Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrWithRootKey -> ServerError Source #

data ErrWrongPassphrase Source #

Indicate a failure when checking for a given Passphrase match

Constructors

ErrWrongPassphrase
ErrPassphraseSchemeUnsupported PassphraseScheme

Instances

Instances details

Eq ErrWrongPassphrase Source #
Instance details Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods (==) :: ErrWrongPassphrase -> ErrWrongPassphrase -> Bool Source # (/=) :: ErrWrongPassphrase -> ErrWrongPassphrase -> Bool Source #
Show ErrWrongPassphrase Source #
Instance details Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods showsPrec :: Int -> ErrWrongPassphrase -> ShowS Source # show :: ErrWrongPassphrase -> String Source # showList :: [ ErrWrongPassphrase ] -> ShowS Source #
Generic ErrWrongPassphrase Source #
Instance details Defined in Cardano.Wallet.Primitive.Passphrase.Types Associated Types type Rep ErrWrongPassphrase :: Type -> Type Source # Methods from :: ErrWrongPassphrase -> Rep ErrWrongPassphrase x Source # to :: Rep ErrWrongPassphrase x -> ErrWrongPassphrase Source #
NFData ErrWrongPassphrase Source #
Instance details Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods rnf :: ErrWrongPassphrase -> () Source #
type Rep ErrWrongPassphrase Source #
Instance details Defined in Cardano.Wallet.Primitive.Passphrase.Types type Rep ErrWrongPassphrase = D1 (' MetaData "ErrWrongPassphrase" "Cardano.Wallet.Primitive.Passphrase.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrWrongPassphrase" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "ErrPassphraseSchemeUnsupported" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PassphraseScheme )))

data ErrSignMetadataWith Source #

Constructors

ErrSignMetadataWithRootKey ErrWithRootKey	The wallet exists, but there's no root key attached to it
ErrSignMetadataWithNoSuchWallet ErrNoSuchWallet	The wallet doesn't exist?
ErrSignMetadataWithInvalidIndex ( ErrInvalidDerivationIndex ' Soft ' AddressK )	User provided a derivation index outside of the `Soft` domain

Instances

Instances details

Eq ErrSignMetadataWith Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrSignMetadataWith -> ErrSignMetadataWith -> Bool Source # (/=) :: ErrSignMetadataWith -> ErrSignMetadataWith -> Bool Source #
Show ErrSignMetadataWith Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrSignMetadataWith -> ShowS Source # show :: ErrSignMetadataWith -> String Source # showList :: [ ErrSignMetadataWith ] -> ShowS Source #
IsServerError ErrSignMetadataWith Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrSignMetadataWith -> ServerError Source #

data ErrDerivePublicKey Source #

Constructors

ErrDerivePublicKeyNoSuchWallet ErrNoSuchWallet	The wallet doesn't exist?
ErrDerivePublicKeyInvalidIndex ( ErrInvalidDerivationIndex ' Soft ' AddressK )	User provided a derivation index outside of the `Soft` domain

Instances

Instances details

Eq ErrDerivePublicKey Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrDerivePublicKey -> ErrDerivePublicKey -> Bool Source # (/=) :: ErrDerivePublicKey -> ErrDerivePublicKey -> Bool Source #
Show ErrDerivePublicKey Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrDerivePublicKey -> ShowS Source # show :: ErrDerivePublicKey -> String Source # showList :: [ ErrDerivePublicKey ] -> ShowS Source #
IsServerError ErrDerivePublicKey Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrDerivePublicKey -> ServerError Source #

data ErrReadAccountPublicKey Source #

Constructors

ErrReadAccountPublicKeyNoSuchWallet ErrNoSuchWallet	The wallet doesn't exist?
ErrReadAccountPublicKeyInvalidAccountIndex ( ErrInvalidDerivationIndex ' Hardened ' AccountK )	User provided a derivation index for account outside of the `Hard` domain
ErrReadAccountPublicKeyInvalidPurposeIndex ( ErrInvalidDerivationIndex ' Hardened ' PurposeK )	User provided a derivation index for purpose outside of the `Hard` domain
ErrReadAccountPublicKeyRootKey ErrWithRootKey	The wallet exists, but there's no root key attached to it

Instances

Instances details

Eq ErrReadAccountPublicKey Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrReadAccountPublicKey -> ErrReadAccountPublicKey -> Bool Source # (/=) :: ErrReadAccountPublicKey -> ErrReadAccountPublicKey -> Bool Source #
Show ErrReadAccountPublicKey Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrReadAccountPublicKey -> ShowS Source # show :: ErrReadAccountPublicKey -> String Source # showList :: [ ErrReadAccountPublicKey ] -> ShowS Source #
IsServerError ErrReadAccountPublicKey Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrReadAccountPublicKey -> ServerError Source #

data ErrInvalidDerivationIndex derivation level Source #

Constructors

ErrIndexOutOfBound ( Index derivation level) ( Index derivation level) DerivationIndex

Instances

Instances details

Eq ( ErrInvalidDerivationIndex derivation level) Source #
Instance details Defined in Cardano.Wallet Methods (==) :: ErrInvalidDerivationIndex derivation level -> ErrInvalidDerivationIndex derivation level -> Bool Source # (/=) :: ErrInvalidDerivationIndex derivation level -> ErrInvalidDerivationIndex derivation level -> Bool Source #
Show ( ErrInvalidDerivationIndex derivation level) Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> ErrInvalidDerivationIndex derivation level -> ShowS Source # show :: ErrInvalidDerivationIndex derivation level -> String Source # showList :: [ ErrInvalidDerivationIndex derivation level] -> ShowS Source #
IsServerError ( ErrInvalidDerivationIndex ' Hardened level) Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrInvalidDerivationIndex ' Hardened level -> ServerError Source #
IsServerError ( ErrInvalidDerivationIndex ' Soft level) Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrInvalidDerivationIndex ' Soft level -> ServerError Source #

Utilities

throttle :: ( MonadUnliftIO m, MonadMonotonicTime m) => DiffTime -> ( Time -> a -> m ()) -> m (a -> m ()) Source #

Return a function to run an action at most once every _interval_.

guardHardIndex :: Monad m => DerivationIndex -> ExceptT ( ErrInvalidDerivationIndex ' Hardened level) m ( Index ' Hardened whatever) Source #

withNoSuchWallet :: Monad m => WalletId -> m ( Maybe a) -> ExceptT ErrNoSuchWallet m a Source #

posAndNegFromCardanoValue :: Value -> ( TokenBundle , TokenBundle ) Source #

Convert a Value into a positive and negative component. Useful to convert the potentially negative balance of a partial tx into TokenBundles.

Logging

data WalletWorkerLog Source #

Log messages for actions running within a wallet worker context.

Constructors

MsgWallet WalletLog
MsgWalletFollow WalletFollowLog
MsgChainFollow ChainFollowLog

Instances

Instances details

Eq WalletWorkerLog Source #
Instance details Defined in Cardano.Wallet Methods (==) :: WalletWorkerLog -> WalletWorkerLog -> Bool Source # (/=) :: WalletWorkerLog -> WalletWorkerLog -> Bool Source #
Show WalletWorkerLog Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> WalletWorkerLog -> ShowS Source # show :: WalletWorkerLog -> String Source # showList :: [ WalletWorkerLog ] -> ShowS Source #
ToText WalletWorkerLog Source #
Instance details Defined in Cardano.Wallet Methods toText :: WalletWorkerLog -> Text Source #
HasPrivacyAnnotation WalletWorkerLog Source #
Instance details Defined in Cardano.Wallet Methods getPrivacyAnnotation :: WalletWorkerLog -> PrivacyAnnotation
HasSeverityAnnotation WalletWorkerLog Source #
Instance details Defined in Cardano.Wallet Methods getSeverityAnnotation :: WalletWorkerLog -> Severity

data WalletFollowLog Source #

Log messages arising from the restore and follow process.

Constructors

MsgDiscoveredDelegationCert SlotNo DelegationCertificate
MsgCheckpoint BlockHeader
MsgDiscoveredTxs [( Tx , TxMeta )]
MsgDiscoveredTxsContent [( Tx , TxMeta )]

Instances

Instances details

Eq WalletFollowLog Source #
Instance details Defined in Cardano.Wallet Methods (==) :: WalletFollowLog -> WalletFollowLog -> Bool Source # (/=) :: WalletFollowLog -> WalletFollowLog -> Bool Source #
Show WalletFollowLog Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> WalletFollowLog -> ShowS Source # show :: WalletFollowLog -> String Source # showList :: [ WalletFollowLog ] -> ShowS Source #
ToText WalletFollowLog Source #
Instance details Defined in Cardano.Wallet Methods toText :: WalletFollowLog -> Text Source #
HasPrivacyAnnotation WalletFollowLog Source #
Instance details Defined in Cardano.Wallet Methods getPrivacyAnnotation :: WalletFollowLog -> PrivacyAnnotation
HasSeverityAnnotation WalletFollowLog Source #
Instance details Defined in Cardano.Wallet Methods getSeverityAnnotation :: WalletFollowLog -> Severity

data WalletLog Source #

Log messages from API server actions running in a wallet worker context.

Constructors

MsgSelectionStart Int [ TxOut ]
MsgSelectionForBalancingStart Int (BuildableInAnyEra PartialTx )
MsgSelectionError ( SelectionError WalletSelectionContext )
MsgSelectionReportSummarized SelectionReportSummarized
MsgSelectionReportDetailed SelectionReportDetailed
MsgMigrationUTxOBefore UTxOStatistics
MsgMigrationUTxOAfter UTxOStatistics
MsgRewardBalanceQuery BlockHeader
MsgRewardBalanceResult ( Either ErrFetchRewards Coin )
MsgRewardBalanceNoSuchWallet ErrNoSuchWallet
MsgRewardBalanceExited
MsgTxSubmit TxSubmitLog
MsgIsStakeKeyRegistered Bool

Instances

Instances details

Eq WalletLog Source #
Instance details Defined in Cardano.Wallet Methods (==) :: WalletLog -> WalletLog -> Bool Source # (/=) :: WalletLog -> WalletLog -> Bool Source #
Show WalletLog Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> WalletLog -> ShowS Source # show :: WalletLog -> String Source # showList :: [ WalletLog ] -> ShowS Source #
ToText WalletLog Source #
Instance details Defined in Cardano.Wallet Methods toText :: WalletLog -> Text Source #
HasPrivacyAnnotation WalletLog Source #
Instance details Defined in Cardano.Wallet Methods getPrivacyAnnotation :: WalletLog -> PrivacyAnnotation
HasSeverityAnnotation WalletLog Source #
Instance details Defined in Cardano.Wallet Methods getSeverityAnnotation :: WalletLog -> Severity

data TxSubmitLog Source #

Constructors

MsgSubmitTx Tx TxMeta SealedTx ( BracketLog' ( Either ErrSubmitTx ()))
MsgSubmitExternalTx ( Hash "Tx") ( BracketLog' ( Either ErrPostTx Tx ))
MsgRetryPostTx ( Hash "Tx") ( BracketLog' ( Either ErrPostTx ()))
MsgProcessPendingPool BracketLog

Instances

Instances details

Eq TxSubmitLog Source #
Instance details Defined in Cardano.Wallet Methods (==) :: TxSubmitLog -> TxSubmitLog -> Bool Source # (/=) :: TxSubmitLog -> TxSubmitLog -> Bool Source #
Show TxSubmitLog Source #
Instance details Defined in Cardano.Wallet Methods showsPrec :: Int -> TxSubmitLog -> ShowS Source # show :: TxSubmitLog -> String Source # showList :: [ TxSubmitLog ] -> ShowS Source #
Buildable TxSubmitLog Source #
Instance details Defined in Cardano.Wallet Methods build :: TxSubmitLog -> Builder Source #
ToText TxSubmitLog Source #
Instance details Defined in Cardano.Wallet Methods toText :: TxSubmitLog -> Text Source #
HasPrivacyAnnotation TxSubmitLog Source #
Instance details Defined in Cardano.Wallet Methods getPrivacyAnnotation :: TxSubmitLog -> PrivacyAnnotation
HasSeverityAnnotation TxSubmitLog Source #
Instance details Defined in Cardano.Wallet Methods getSeverityAnnotation :: TxSubmitLog -> Severity