Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.Api

Contents

API
Type Families
Shelley
Settings
Byron
Miscellaneous
Shared Wallets
Api Layer

Synopsis

type Api n apiPool = Wallets :<|> ( WalletKeys :<|> ( Assets :<|> ( Addresses n :<|> ( CoinSelections n :<|> ( ShelleyTransactions n :<|> ( ShelleyMigrations n :<|> ( StakePools n apiPool :<|> ( ByronWallets :<|> ( ByronAssets :<|> ( ByronAddresses n :<|> ( ByronCoinSelections n :<|> ( ByronTransactions n :<|> ( ByronMigrations n :<|> ( Network :<|> ( Proxy_ :<|> ( Settings :<|> ( SMASH :<|> ( SharedWallets :<|> ( SharedWalletKeys :<|> ( SharedAddresses n :<|> SharedTransactions n))))))))))))))))))))
type ApiV2 n apiPool = "v2" :> Api n apiPool
type family PostData wallet :: Type where ...
type Wallets = DeleteWallet :<|> ( GetWallet :<|> ( ListWallets :<|> ( PostWallet :<|> ( PutWallet :<|> ( PutWalletPassphrase :<|> ( GetWalletUtxoSnapshot :<|> GetUTxOsStatistics ))))))
type DeleteWallet = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> DeleteNoContent )
type GetWallet = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> Get '[ JSON ] ApiWallet )
type ListWallets = "wallets" :> Get '[ JSON ] [ ApiWallet ]
type PostWallet = "wallets" :> ( ReqBody '[ JSON ] ( PostData ApiWallet ) :> PostCreated '[ JSON ] ApiWallet )
type PutWallet = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ( ReqBody '[ JSON ] WalletPutData :> Put '[ JSON ] ApiWallet ))
type PutWalletPassphrase = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("passphrase" :> ( ReqBody '[ JSON ] WalletPutPassphraseData :> PutNoContent )))
type GetUTxOsStatistics = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("statistics" :> ("utxos" :> Get '[ JSON ] ApiUtxoStatistics )))
type GetWalletUtxoSnapshot = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("utxo" :> Get '[ JSON ] ApiWalletUtxoSnapshot ))
type WalletKeys = GetWalletKey :<|> ( SignMetadata :<|> ( PostAccountKey :<|> ( GetAccountKey :<|> ( GetPolicyKey :<|> ( PostPolicyKey :<|> PostPolicyId )))))
type GetWalletKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( Capture "role" ( ApiT Role ) :> ( Capture "index" ( ApiT DerivationIndex ) :> ( QueryParam "hash" Bool :> Get '[ JSON ] ApiVerificationKeyShelley )))))
type SignMetadata = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("signatures" :> ( Capture "role" ( ApiT Role ) :> ( Capture "index" ( ApiT DerivationIndex ) :> ( ReqBody '[ JSON ] ApiWalletSignData :> Post '[ OctetStream ] ByteString )))))
type PostAccountKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( Capture "index" ( ApiT DerivationIndex ) :> ( ReqBody '[ JSON ] ApiPostAccountKeyDataWithPurpose :> PostAccepted '[ JSON ] ApiAccountKey ))))
type GetAccountKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( QueryParam "format" KeyFormat :> Get '[ JSON ] ApiAccountKey )))
type GetPolicyKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("policy-key" :> ( QueryParam "hash" Bool :> Get '[ JSON ] ApiPolicyKey )))
type PostPolicyKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("policy-key" :> ( QueryParam "hash" Bool :> ( ReqBody '[ JSON ] ApiPostPolicyKeyData :> PostAccepted '[ JSON ] ApiPolicyKey ))))
type PostPolicyId = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("policy-id" :> ( ReqBody '[ JSON ] ApiPostPolicyIdData :> PostAccepted '[ JSON ] ApiPolicyId )))
type Assets = ListAssets :<|> ( GetAsset :<|> GetAssetDefault )
type ListAssets = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> Get '[ JSON ] [ ApiAsset ]))
type GetAsset = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> ( Capture "policyId" ( ApiT TokenPolicyId ) :> ( Capture "assetName" ( ApiT TokenName ) :> Get '[ JSON ] ApiAsset ))))
type GetAssetDefault = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> ( Capture "policyId" ( ApiT TokenPolicyId ) :> Get '[ JSON ] ApiAsset )))
type Addresses n = ListAddresses n :<|> ( InspectAddress :<|> PostAnyAddress n)
type ListAddresses n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( QueryParam "state" ( ApiT AddressState ) :> Get '[ JSON ] [ ApiAddressT n])))
type InspectAddress = "addresses" :> ( Capture "addressId" ApiAddressInspectData :> Get '[ JSON ] ApiAddressInspect )
type PostAnyAddress n = "addresses" :> ( ReqBody '[ JSON ] ApiAddressData :> PostAccepted '[ JSON ] AnyAddress )
type CoinSelections n = SelectCoins n
type SelectCoins n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("coin-selections" :> ("random" :> ( ReqBody '[ JSON ] ( ApiSelectCoinsDataT n) :> Post '[ JSON ] ( ApiCoinSelectionT n)))))
type ShelleyTransactions n = ConstructTransaction n :<|> ( SignTransaction n :<|> ( ListTransactions n :<|> ( GetTransaction n :<|> ( DeleteTransaction :<|> ( CreateTransactionOld n :<|> ( PostTransactionFeeOld n :<|> ( BalanceTransaction n :<|> ( DecodeTransaction n :<|> SubmitTransaction ))))))))
type ConstructTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-construct" :> ( ReqBody '[ JSON ] ( ApiConstructTransactionDataT n) :> PostAccepted '[ JSON ] ( ApiConstructTransactionT n))))
type SignTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-sign" :> ( ReqBody '[ JSON ] ApiSignTransactionPostData :> PostAccepted '[ JSON ] ApiSerialisedTransaction )))
type ListTransactions n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( QueryParam "minWithdrawal" MinWithdrawal :> ( QueryParam "start" Iso8601Time :> ( QueryParam "end" Iso8601Time :> ( QueryParam "order" ( ApiT SortOrder ) :> ( QueryFlag "simple-metadata" :> Get '[ JSON ] [ ApiTransactionT n])))))))
type GetTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( Capture "transactionId" ApiTxId :> ( QueryFlag "simple-metadata" :> Get '[ JSON ] ( ApiTransactionT n)))))
type DeleteTransaction = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( Capture "transactionId" ApiTxId :> DeleteNoContent )))
type CreateTransactionOld n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( ReqBody '[ JSON ] ( PostTransactionOldDataT n) :> PostAccepted '[ JSON ] ( ApiTransactionT n))))
type PostTransactionFeeOld n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("payment-fees" :> ( ReqBody '[ JSON ] ( PostTransactionFeeOldDataT n) :> PostAccepted '[ JSON ] ApiFee )))
type BalanceTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-balance" :> ( ReqBody '[ JSON ] ( ApiBalanceTransactionPostDataT n) :> PostAccepted '[ JSON ] ApiSerialisedTransaction )))
type DecodeTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-decode" :> ( ReqBody '[ JSON ] ApiSerialisedTransaction :> PostAccepted '[ JSON ] ( ApiDecodedTransactionT n))))
type SubmitTransaction = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-submit" :> ( ReqBody '[ JSON ] ApiSerialisedTransaction :> PostAccepted '[ JSON ] ApiTxId )))
type StakePools n apiPool = ListStakePools apiPool :<|> ( JoinStakePool n :<|> ( QuitStakePool n :<|> ( DelegationFee :<|> ( ListStakeKeys n :<|> ( PostPoolMaintenance :<|> GetPoolMaintenance )))))
type ListStakePools apiPool = "stake-pools" :> ( QueryParam "stake" ( ApiT Coin ) :> Get '[ JSON ] [apiPool])
type JoinStakePool n = "stake-pools" :> ( Capture "stakePoolId" ApiPoolId :> ("wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ( ReqBody '[ JSON ] ApiWalletPassphrase :> PutAccepted '[ JSON ] ( ApiTransactionT n)))))
type QuitStakePool n = "stake-pools" :> ("*" :> ("wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ( ReqBody '[ JSON ] ApiWalletPassphrase :> DeleteAccepted '[ JSON ] ( ApiTransactionT n)))))
type DelegationFee = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("delegation-fees" :> Get '[ JSON ] ApiFee ))
type ListStakeKeys n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("stake-keys" :> Get '[ JSON ] ( ApiStakeKeysT n)))
type PostPoolMaintenance = "stake-pools" :> ("maintenance-actions" :> ( ReqBody '[ JSON ] ApiMaintenanceActionPostData :> PostNoContent ))
type GetPoolMaintenance = "stake-pools" :> ("maintenance-actions" :> Get '[ JSON ] ApiMaintenanceAction )
type ShelleyMigrations n = CreateShelleyWalletMigrationPlan n :<|> MigrateShelleyWallet n
type MigrateShelleyWallet n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("migrations" :> ( ReqBody '[ JSON ] ( ApiWalletMigrationPostDataT n "user") :> PostAccepted '[ JSON ] ( NonEmpty ( ApiTransactionT n)))))
type CreateShelleyWalletMigrationPlan n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("migrations" :> ("plan" :> ( ReqBody '[ JSON ] ( ApiWalletMigrationPlanPostDataT n) :> PostAccepted '[ JSON ] ( ApiWalletMigrationPlan n)))))
type Settings = PutSettings :<|> GetSettings
type PutSettings = "settings" :> ( ReqBody '[ JSON ] SettingsPutData :> PutNoContent )
type GetSettings = "settings" :> Get '[ JSON ] ( ApiT Settings )
type ByronWallets = PostByronWallet :<|> ( DeleteByronWallet :<|> ( GetByronWallet :<|> ( ListByronWallets :<|> ( PutByronWallet :<|> ( GetByronWalletUtxoSnapshot :<|> ( GetByronUTxOsStatistics :<|> PutByronWalletPassphrase ))))))
type DeleteByronWallet = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> DeleteNoContent )
type GetByronWallet = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> Get '[ JSON ] ApiByronWallet )
type ListByronWallets = "byron-wallets" :> Get '[ JSON ] [ ApiByronWallet ]
type PostByronWallet = "byron-wallets" :> ( ReqBody '[ JSON ] ( PostData ApiByronWallet ) :> PostCreated '[ JSON ] ApiByronWallet )
type PutByronWallet = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ( ReqBody '[ JSON ] WalletPutData :> Put '[ JSON ] ApiByronWallet ))
type GetByronUTxOsStatistics = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("statistics" :> ("utxos" :> Get '[ JSON ] ApiUtxoStatistics )))
type GetByronWalletUtxoSnapshot = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("utxo" :> Get '[ JSON ] ApiWalletUtxoSnapshot ))
type PutByronWalletPassphrase = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("passphrase" :> ( ReqBody '[ JSON ] ByronWalletPutPassphraseData :> PutNoContent )))
type ByronAssets = ListByronAssets :<|> ( GetByronAsset :<|> GetByronAssetDefault )
type ListByronAssets = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> Get '[ JSON ] [ ApiAsset ]))
type GetByronAsset = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> ( Capture "policyId" ( ApiT TokenPolicyId ) :> ( Capture "assetName" ( ApiT TokenName ) :> Get '[ JSON ] ApiAsset ))))
type GetByronAssetDefault = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> ( Capture "policyId" ( ApiT TokenPolicyId ) :> Get '[ JSON ] ApiAsset )))
type ByronAddresses n = PostByronAddress n :<|> ( PutByronAddress n :<|> ( PutByronAddresses n :<|> ListByronAddresses n))
type PostByronAddress n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( ReqBody '[ JSON ] ApiPostRandomAddressData :> PostCreated '[ JSON ] ( ApiAddressT n))))
type PutByronAddress n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( Capture "addressId" ( ApiAddressIdT n) :> PutNoContent )))
type PutByronAddresses n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( ReqBody '[ JSON ] ( ApiPutAddressesDataT n) :> PutNoContent )))
type ListByronAddresses n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( QueryParam "state" ( ApiT AddressState ) :> Get '[ JSON ] [ ApiAddressT n])))
type ByronCoinSelections n = ByronSelectCoins n
type ByronSelectCoins n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("coin-selections" :> ("random" :> ( ReqBody '[ JSON ] ( ApiSelectCoinsDataT n) :> Post '[ JSON ] ( ApiCoinSelectionT n)))))
type ByronTransactions n = ConstructByronTransaction n :<|> ( SignByronTransaction n :<|> ( ListByronTransactions n :<|> ( GetByronTransaction n :<|> ( DeleteByronTransaction :<|> ( CreateByronTransactionOld n :<|> PostByronTransactionFeeOld n)))))
type ConstructByronTransaction n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-construct" :> ( ReqBody '[ JSON ] ( ApiConstructTransactionDataT n) :> PostAccepted '[ JSON ] ( ApiConstructTransactionT n))))
type SignByronTransaction n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-sign" :> ( ReqBody '[ JSON ] ApiSignTransactionPostData :> PostAccepted '[ JSON ] ApiSerialisedTransaction )))
type ListByronTransactions n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( QueryParam "start" Iso8601Time :> ( QueryParam "end" Iso8601Time :> ( QueryParam "order" ( ApiT SortOrder ) :> Get '[ JSON ] [ ApiTransactionT n])))))
type GetByronTransaction n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( Capture "transactionId" ApiTxId :> Get '[ JSON ] ( ApiTransactionT n))))
type DeleteByronTransaction = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( Capture "transactionId" ApiTxId :> DeleteNoContent )))
type CreateByronTransactionOld n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( ReqBody '[ JSON ] ( PostTransactionOldDataT n) :> PostAccepted '[ JSON ] ( ApiTransactionT n))))
type PostByronTransactionFeeOld n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("payment-fees" :> ( ReqBody '[ JSON ] ( PostTransactionFeeOldDataT n) :> PostAccepted '[ JSON ] ApiFee )))
type ByronMigrations n = CreateByronWalletMigrationPlan n :<|> MigrateByronWallet n
type MigrateByronWallet n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("migrations" :> ( ReqBody '[ JSON ] ( ApiWalletMigrationPostDataT n "lenient") :> PostAccepted '[ JSON ] ( NonEmpty ( ApiTransactionT n)))))
type CreateByronWalletMigrationPlan n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("migrations" :> ("plan" :> ( ReqBody '[ JSON ] ( ApiWalletMigrationPlanPostDataT n) :> PostAccepted '[ JSON ] ( ApiWalletMigrationPlan n)))))
type Network = GetNetworkInformation :<|> ( GetNetworkParameters :<|> GetNetworkClock )
type GetNetworkInformation = "network" :> ("information" :> Get '[ JSON ] ApiNetworkInformation )
type GetNetworkParameters = "network" :> ("parameters" :> Get '[ JSON ] ApiNetworkParameters )
type GetNetworkClock = "network" :> ("clock" :> ( QueryFlag "forceNtpCheck" :> Get '[ JSON ] ApiNetworkClock ))
type SMASH = GetCurrentSMASHHealth
type GetCurrentSMASHHealth = "smash" :> ("health" :> ( QueryParam "url" ( ApiT SmashServer ) :> Get '[ JSON ] ApiHealthCheck ))
type SharedWallets = PostSharedWallet :<|> ( GetSharedWallet :<|> ( ListSharedWallets :<|> ( PatchSharedWalletInPayment :<|> ( PatchSharedWalletInDelegation :<|> DeleteSharedWallet ))))
type PostSharedWallet = "shared-wallets" :> ( ReqBody '[ JSON ] ApiSharedWalletPostData :> PostCreated '[ JSON ] ApiSharedWallet )
type GetSharedWallet = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> Get '[ JSON ] ApiSharedWallet )
type ListSharedWallets = "shared-wallets" :> Get '[ JSON ] [ ApiSharedWallet ]
type PatchSharedWalletInPayment = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("payment-script-template" :> ( ReqBody '[ JSON ] ApiSharedWalletPatchData :> Patch '[ JSON ] ApiSharedWallet )))
type PatchSharedWalletInDelegation = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("delegation-script-template" :> ( ReqBody '[ JSON ] ApiSharedWalletPatchData :> Patch '[ JSON ] ApiSharedWallet )))
type DeleteSharedWallet = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> DeleteNoContent )
type SharedWalletKeys = GetSharedWalletKey :<|> ( PostAccountKeyShared :<|> GetAccountKeyShared )
type GetSharedWalletKey = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( Capture "role" ( ApiT Role ) :> ( Capture "index" ( ApiT DerivationIndex ) :> ( QueryParam "hash" Bool :> Get '[ JSON ] ApiVerificationKeyShared )))))
type PostAccountKeyShared = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( Capture "index" ( ApiT DerivationIndex ) :> ( ReqBody '[ JSON ] ApiPostAccountKeyData :> PostAccepted '[ JSON ] ApiAccountKeyShared ))))
type GetAccountKeyShared = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( QueryParam "format" KeyFormat :> Get '[ JSON ] ApiAccountKeyShared )))
type SharedAddresses n = ListSharedAddresses n
type ListSharedAddresses n = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( QueryParam "state" ( ApiT AddressState ) :> Get '[ JSON ] [ ApiAddressT n])))
type SharedTransactions n = ConstructSharedTransaction n :<|> DecodeSharedTransaction n
type ConstructSharedTransaction n = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-construct" :> ( ReqBody '[ JSON ] ( ApiConstructTransactionDataT n) :> PostAccepted '[ JSON ] ( ApiConstructTransactionT n))))
type DecodeSharedTransaction n = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-decode" :> ( ReqBody '[ JSON ] ApiSerialisedTransaction :> PostAccepted '[ JSON ] ( ApiDecodedTransactionT n))))
type Proxy_ = PostExternalTransaction
type PostExternalTransaction = "proxy" :> ("transactions" :> ( ReqBody '[ OctetStream ] ( ApiT SealedTx ) :> PostAccepted '[ JSON ] ApiTxId ))
data ApiLayer s (k :: Depth -> Type -> Type ) = ApiLayer ( Tracer IO TxSubmitLog ) ( Tracer IO ( WorkerLog WalletId WalletWorkerLog )) ( Block , NetworkParameters ) ( NetworkLayer IO Block ) ( TransactionLayer k SealedTx ) ( DBFactory IO s k) ( WorkerRegistry WalletId ( DBLayer IO s k)) ( Concierge IO WalletLock ) ( TokenMetadataClient IO )
type HasWorkerRegistry s k ctx = ( HasType ( WorkerRegistry WalletId ( DBLayer IO s k)) ctx, HasWorkerCtx ( DBLayer IO s k) ctx, WorkerKey ctx ~ WalletId , WorkerMsg ctx ~ WalletWorkerLog )
workerRegistry :: forall s k ctx. HasWorkerRegistry s k ctx => Lens' ctx ( WorkerRegistry WalletId ( DBLayer IO s k))
data WalletLock = PostTransactionOld WalletId
walletLocks :: forall ctx. HasType ( Concierge IO WalletLock ) ctx => Lens' ctx ( Concierge IO WalletLock )
type HasDBFactory s k = HasType ( DBFactory IO s k)
dbFactory :: forall s k ctx. HasDBFactory s k ctx => Lens' ctx ( DBFactory IO s k)
tokenMetadataClient :: forall ctx. HasTokenMetadataClient ctx => Lens' ctx ( TokenMetadataClient IO )
type HasTokenMetadataClient = HasType ( TokenMetadataClient IO )

API

The full cardano-wallet API.

type ApiV2 n apiPool = "v2" :> Api n apiPool Source #

Type Families

type family PostData wallet :: Type where ... Source #

Equations

PostData ApiWallet = WalletOrAccountPostData
PostData ApiByronWallet = SomeByronWalletPostData

Shelley

type DeleteWallet = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> DeleteNoContent ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/deleteWallet

type GetWallet = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> Get '[ JSON ] ApiWallet ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getWallet

type ListWallets = "wallets" :> Get '[ JSON ] [ ApiWallet ] Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listWallets

type PostWallet = "wallets" :> ( ReqBody '[ JSON ] ( PostData ApiWallet ) :> PostCreated '[ JSON ] ApiWallet ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postWallet

type PutWallet = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ( ReqBody '[ JSON ] WalletPutData :> Put '[ JSON ] ApiWallet )) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/putWallet

type PutWalletPassphrase = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("passphrase" :> ( ReqBody '[ JSON ] WalletPutPassphraseData :> PutNoContent ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/putWalletPassphrase

type GetUTxOsStatistics = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("statistics" :> ("utxos" :> Get '[ JSON ] ApiUtxoStatistics ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getUTxOsStatistics

type GetWalletUtxoSnapshot = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("utxo" :> Get '[ JSON ] ApiWalletUtxoSnapshot )) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getWalletUtxoSnapshot

type GetWalletKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( Capture "role" ( ApiT Role ) :> ( Capture "index" ( ApiT DerivationIndex ) :> ( QueryParam "hash" Bool :> Get '[ JSON ] ApiVerificationKeyShelley ))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getWalletKey

type SignMetadata = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("signatures" :> ( Capture "role" ( ApiT Role ) :> ( Capture "index" ( ApiT DerivationIndex ) :> ( ReqBody '[ JSON ] ApiWalletSignData :> Post '[ OctetStream ] ByteString ))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/signMetadata

type PostAccountKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( Capture "index" ( ApiT DerivationIndex ) :> ( ReqBody '[ JSON ] ApiPostAccountKeyDataWithPurpose :> PostAccepted '[ JSON ] ApiAccountKey )))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postAccountKey

type GetAccountKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( QueryParam "format" KeyFormat :> Get '[ JSON ] ApiAccountKey ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getAccountKey

type GetPolicyKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("policy-key" :> ( QueryParam "hash" Bool :> Get '[ JSON ] ApiPolicyKey ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getPolicyKey

type PostPolicyKey = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("policy-key" :> ( QueryParam "hash" Bool :> ( ReqBody '[ JSON ] ApiPostPolicyKeyData :> PostAccepted '[ JSON ] ApiPolicyKey )))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postPolicyKey

type PostPolicyId = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("policy-id" :> ( ReqBody '[ JSON ] ApiPostPolicyIdData :> PostAccepted '[ JSON ] ApiPolicyId ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postPolicyId

type Assets = ListAssets :<|> ( GetAsset :<|> GetAssetDefault ) Source #

type ListAssets = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> Get '[ JSON ] [ ApiAsset ])) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listAssets

type GetAsset = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> ( Capture "policyId" ( ApiT TokenPolicyId ) :> ( Capture "assetName" ( ApiT TokenName ) :> Get '[ JSON ] ApiAsset )))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getAsset

type GetAssetDefault = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> ( Capture "policyId" ( ApiT TokenPolicyId ) :> Get '[ JSON ] ApiAsset ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getAssetDefault

type Addresses n = ListAddresses n :<|> ( InspectAddress :<|> PostAnyAddress n) Source #

type ListAddresses n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( QueryParam "state" ( ApiT AddressState ) :> Get '[ JSON ] [ ApiAddressT n]))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listAddresses

type InspectAddress = "addresses" :> ( Capture "addressId" ApiAddressInspectData :> Get '[ JSON ] ApiAddressInspect ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/inspectAddress

type PostAnyAddress n = "addresses" :> ( ReqBody '[ JSON ] ApiAddressData :> PostAccepted '[ JSON ] AnyAddress ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postAnyAddress

type CoinSelections n = SelectCoins n Source #

type SelectCoins n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("coin-selections" :> ("random" :> ( ReqBody '[ JSON ] ( ApiSelectCoinsDataT n) :> Post '[ JSON ] ( ApiCoinSelectionT n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/selectCoins

type ConstructTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-construct" :> ( ReqBody '[ JSON ] ( ApiConstructTransactionDataT n) :> PostAccepted '[ JSON ] ( ApiConstructTransactionT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/constructTransaction

type SignTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-sign" :> ( ReqBody '[ JSON ] ApiSignTransactionPostData :> PostAccepted '[ JSON ] ApiSerialisedTransaction ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/signTransaction

type ListTransactions n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( QueryParam "minWithdrawal" MinWithdrawal :> ( QueryParam "start" Iso8601Time :> ( QueryParam "end" Iso8601Time :> ( QueryParam "order" ( ApiT SortOrder ) :> ( QueryFlag "simple-metadata" :> Get '[ JSON ] [ ApiTransactionT n]))))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listTransactions

type GetTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( Capture "transactionId" ApiTxId :> ( QueryFlag "simple-metadata" :> Get '[ JSON ] ( ApiTransactionT n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getTransaction

type DeleteTransaction = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( Capture "transactionId" ApiTxId :> DeleteNoContent ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/deleteTransaction

type CreateTransactionOld n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( ReqBody '[ JSON ] ( PostTransactionOldDataT n) :> PostAccepted '[ JSON ] ( ApiTransactionT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postTransaction

type PostTransactionFeeOld n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("payment-fees" :> ( ReqBody '[ JSON ] ( PostTransactionFeeOldDataT n) :> PostAccepted '[ JSON ] ApiFee ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postTransactionFee

type BalanceTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-balance" :> ( ReqBody '[ JSON ] ( ApiBalanceTransactionPostDataT n) :> PostAccepted '[ JSON ] ApiSerialisedTransaction ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/balanceTransaction

type DecodeTransaction n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-decode" :> ( ReqBody '[ JSON ] ApiSerialisedTransaction :> PostAccepted '[ JSON ] ( ApiDecodedTransactionT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/decodeTransaction

type SubmitTransaction = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-submit" :> ( ReqBody '[ JSON ] ApiSerialisedTransaction :> PostAccepted '[ JSON ] ApiTxId ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/submitTransaction

type ListStakePools apiPool = "stake-pools" :> ( QueryParam "stake" ( ApiT Coin ) :> Get '[ JSON ] [apiPool]) Source #

https://input-output-hk.github.io/cardano-wallet/api/edge/#operation/listStakePools

type JoinStakePool n = "stake-pools" :> ( Capture "stakePoolId" ApiPoolId :> ("wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ( ReqBody '[ JSON ] ApiWalletPassphrase :> PutAccepted '[ JSON ] ( ApiTransactionT n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/joinStakePool

type QuitStakePool n = "stake-pools" :> ("*" :> ("wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ( ReqBody '[ JSON ] ApiWalletPassphrase :> DeleteAccepted '[ JSON ] ( ApiTransactionT n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/quitStakePool

type DelegationFee = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("delegation-fees" :> Get '[ JSON ] ApiFee )) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getDelegationFee

type ListStakeKeys n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("stake-keys" :> Get '[ JSON ] ( ApiStakeKeysT n))) Source #

type PostPoolMaintenance = "stake-pools" :> ("maintenance-actions" :> ( ReqBody '[ JSON ] ApiMaintenanceActionPostData :> PostNoContent )) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postPoolMaintenance

type GetPoolMaintenance = "stake-pools" :> ("maintenance-actions" :> Get '[ JSON ] ApiMaintenanceAction ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getPoolMaintenance

type ShelleyMigrations n = CreateShelleyWalletMigrationPlan n :<|> MigrateShelleyWallet n Source #

type MigrateShelleyWallet n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("migrations" :> ( ReqBody '[ JSON ] ( ApiWalletMigrationPostDataT n "user") :> PostAccepted '[ JSON ] ( NonEmpty ( ApiTransactionT n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/migrateShelleyWallet

type CreateShelleyWalletMigrationPlan n = "wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("migrations" :> ("plan" :> ( ReqBody '[ JSON ] ( ApiWalletMigrationPlanPostDataT n) :> PostAccepted '[ JSON ] ( ApiWalletMigrationPlan n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/createShelleyWalletMigrationPlan

Settings

type Settings = PutSettings :<|> GetSettings Source #

type PutSettings = "settings" :> ( ReqBody '[ JSON ] SettingsPutData :> PutNoContent ) Source #

type GetSettings = "settings" :> Get '[ JSON ] ( ApiT Settings ) Source #

Byron

type DeleteByronWallet = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> DeleteNoContent ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/deleteByronWallet

type GetByronWallet = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> Get '[ JSON ] ApiByronWallet ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getByronWallet

type ListByronWallets = "byron-wallets" :> Get '[ JSON ] [ ApiByronWallet ] Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listByronWallets

type PostByronWallet = "byron-wallets" :> ( ReqBody '[ JSON ] ( PostData ApiByronWallet ) :> PostCreated '[ JSON ] ApiByronWallet ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postByronWallet

type PutByronWallet = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ( ReqBody '[ JSON ] WalletPutData :> Put '[ JSON ] ApiByronWallet )) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/putByronWallet

type GetByronUTxOsStatistics = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("statistics" :> ("utxos" :> Get '[ JSON ] ApiUtxoStatistics ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getByronUTxOsStatistics

type GetByronWalletUtxoSnapshot = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("utxo" :> Get '[ JSON ] ApiWalletUtxoSnapshot )) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getByronWalletUtxoSnapshot

type PutByronWalletPassphrase = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("passphrase" :> ( ReqBody '[ JSON ] ByronWalletPutPassphraseData :> PutNoContent ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/putByronWalletPassphrase

type ByronAssets = ListByronAssets :<|> ( GetByronAsset :<|> GetByronAssetDefault ) Source #

type ListByronAssets = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> Get '[ JSON ] [ ApiAsset ])) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listByronAssets

type GetByronAsset = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> ( Capture "policyId" ( ApiT TokenPolicyId ) :> ( Capture "assetName" ( ApiT TokenName ) :> Get '[ JSON ] ApiAsset )))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getByronAsset

type GetByronAssetDefault = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("assets" :> ( Capture "policyId" ( ApiT TokenPolicyId ) :> Get '[ JSON ] ApiAsset ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getByronAssetDefault

type ByronAddresses n = PostByronAddress n :<|> ( PutByronAddress n :<|> ( PutByronAddresses n :<|> ListByronAddresses n)) Source #

type PostByronAddress n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( ReqBody '[ JSON ] ApiPostRandomAddressData :> PostCreated '[ JSON ] ( ApiAddressT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/createAddress

type PutByronAddress n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( Capture "addressId" ( ApiAddressIdT n) :> PutNoContent ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/restoreAddress

type PutByronAddresses n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( ReqBody '[ JSON ] ( ApiPutAddressesDataT n) :> PutNoContent ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/importAddresses

type ListByronAddresses n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( QueryParam "state" ( ApiT AddressState ) :> Get '[ JSON ] [ ApiAddressT n]))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listByronAddresses

type ByronCoinSelections n = ByronSelectCoins n Source #

type ByronSelectCoins n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("coin-selections" :> ("random" :> ( ReqBody '[ JSON ] ( ApiSelectCoinsDataT n) :> Post '[ JSON ] ( ApiCoinSelectionT n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/byronSelectCoins

type ConstructByronTransaction n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-construct" :> ( ReqBody '[ JSON ] ( ApiConstructTransactionDataT n) :> PostAccepted '[ JSON ] ( ApiConstructTransactionT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/constructByronTransaction

type SignByronTransaction n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-sign" :> ( ReqBody '[ JSON ] ApiSignTransactionPostData :> PostAccepted '[ JSON ] ApiSerialisedTransaction ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/signByronTransaction

type ListByronTransactions n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( QueryParam "start" Iso8601Time :> ( QueryParam "end" Iso8601Time :> ( QueryParam "order" ( ApiT SortOrder ) :> Get '[ JSON ] [ ApiTransactionT n]))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listByronTransactions

type GetByronTransaction n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( Capture "transactionId" ApiTxId :> Get '[ JSON ] ( ApiTransactionT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getByronTransaction

type DeleteByronTransaction = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( Capture "transactionId" ApiTxId :> DeleteNoContent ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/deleteByronTransaction

type CreateByronTransactionOld n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions" :> ( ReqBody '[ JSON ] ( PostTransactionOldDataT n) :> PostAccepted '[ JSON ] ( ApiTransactionT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postByronTransaction

type PostByronTransactionFeeOld n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("payment-fees" :> ( ReqBody '[ JSON ] ( PostTransactionFeeOldDataT n) :> PostAccepted '[ JSON ] ApiFee ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postByronTransactionFee

type ByronMigrations n = CreateByronWalletMigrationPlan n :<|> MigrateByronWallet n Source #

type MigrateByronWallet n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("migrations" :> ( ReqBody '[ JSON ] ( ApiWalletMigrationPostDataT n "lenient") :> PostAccepted '[ JSON ] ( NonEmpty ( ApiTransactionT n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/migrateByronWallet

type CreateByronWalletMigrationPlan n = "byron-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("migrations" :> ("plan" :> ( ReqBody '[ JSON ] ( ApiWalletMigrationPlanPostDataT n) :> PostAccepted '[ JSON ] ( ApiWalletMigrationPlan n))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/createByronWalletMigrationPlan

Miscellaneous

type Network = GetNetworkInformation :<|> ( GetNetworkParameters :<|> GetNetworkClock ) Source #

type GetNetworkInformation = "network" :> ("information" :> Get '[ JSON ] ApiNetworkInformation ) Source #

type GetNetworkParameters = "network" :> ("parameters" :> Get '[ JSON ] ApiNetworkParameters ) Source #

type GetNetworkClock = "network" :> ("clock" :> ( QueryFlag "forceNtpCheck" :> Get '[ JSON ] ApiNetworkClock )) Source #

type SMASH = GetCurrentSMASHHealth Source #

type GetCurrentSMASHHealth = "smash" :> ("health" :> ( QueryParam "url" ( ApiT SmashServer ) :> Get '[ JSON ] ApiHealthCheck )) Source #

Shared Wallets

type PostSharedWallet = "shared-wallets" :> ( ReqBody '[ JSON ] ApiSharedWalletPostData :> PostCreated '[ JSON ] ApiSharedWallet ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postSharedWallet

type GetSharedWallet = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> Get '[ JSON ] ApiSharedWallet ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getSharedWallet

type ListSharedWallets = "shared-wallets" :> Get '[ JSON ] [ ApiSharedWallet ] Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listSharedWallets

type PatchSharedWalletInPayment = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("payment-script-template" :> ( ReqBody '[ JSON ] ApiSharedWalletPatchData :> Patch '[ JSON ] ApiSharedWallet ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/patchSharedWalletInPayment

type PatchSharedWalletInDelegation = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("delegation-script-template" :> ( ReqBody '[ JSON ] ApiSharedWalletPatchData :> Patch '[ JSON ] ApiSharedWallet ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/patchSharedWalletInDelegation

type DeleteSharedWallet = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> DeleteNoContent ) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/deleteSharedWallet

type SharedWalletKeys = GetSharedWalletKey :<|> ( PostAccountKeyShared :<|> GetAccountKeyShared ) Source #

type GetSharedWalletKey = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( Capture "role" ( ApiT Role ) :> ( Capture "index" ( ApiT DerivationIndex ) :> ( QueryParam "hash" Bool :> Get '[ JSON ] ApiVerificationKeyShared ))))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getSharedWalletKey

type PostAccountKeyShared = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( Capture "index" ( ApiT DerivationIndex ) :> ( ReqBody '[ JSON ] ApiPostAccountKeyData :> PostAccepted '[ JSON ] ApiAccountKeyShared )))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postAccountKeyShared

type GetAccountKeyShared = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("keys" :> ( QueryParam "format" KeyFormat :> Get '[ JSON ] ApiAccountKeyShared ))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/getAccountKeyShared

type SharedAddresses n = ListSharedAddresses n Source #

type ListSharedAddresses n = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("addresses" :> ( QueryParam "state" ( ApiT AddressState ) :> Get '[ JSON ] [ ApiAddressT n]))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/listSharedAddresses

type SharedTransactions n = ConstructSharedTransaction n :<|> DecodeSharedTransaction n Source #

type ConstructSharedTransaction n = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-construct" :> ( ReqBody '[ JSON ] ( ApiConstructTransactionDataT n) :> PostAccepted '[ JSON ] ( ApiConstructTransactionT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/constructSharedTransaction

type DecodeSharedTransaction n = "shared-wallets" :> ( Capture "walletId" ( ApiT WalletId ) :> ("transactions-decode" :> ( ReqBody '[ JSON ] ApiSerialisedTransaction :> PostAccepted '[ JSON ] ( ApiDecodedTransactionT n)))) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/decodeSharedTransaction

type Proxy_ = PostExternalTransaction Source #

type PostExternalTransaction = "proxy" :> ("transactions" :> ( ReqBody '[ OctetStream ] ( ApiT SealedTx ) :> PostAccepted '[ JSON ] ApiTxId )) Source #

https://input-output-hk.github.io/cardano-wallet/api/#operation/postExternalTransaction

Api Layer

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

Constructors

ApiLayer ( Tracer IO TxSubmitLog ) ( Tracer IO ( WorkerLog WalletId WalletWorkerLog )) ( Block , NetworkParameters ) ( NetworkLayer IO Block ) ( TransactionLayer k SealedTx ) ( DBFactory IO s k) ( WorkerRegistry WalletId ( DBLayer IO s k)) ( Concierge IO WalletLock ) ( TokenMetadataClient IO )

Instances

Instances details

Generic ( ApiLayer s k) Source #
Instance details Defined in Cardano.Wallet.Api Associated Types type Rep ( ApiLayer s k) :: Type -> Type Source # Methods from :: ApiLayer s k -> Rep ( ApiLayer s k) x Source # to :: Rep ( ApiLayer s k) x -> ApiLayer s k Source #
HasWorkerCtx ( DBLayer IO s k) ( ApiLayer s k) Source #
Instance details Defined in Cardano.Wallet.Api Associated Types type WorkerCtx ( ApiLayer s k) Source # type WorkerMsg ( ApiLayer s k) Source # type WorkerKey ( ApiLayer s k) Source # Methods hoistResource :: DBLayer IO s k -> ( WorkerMsg ( ApiLayer s k) -> WorkerLog ( WorkerKey ( ApiLayer s k)) ( WorkerMsg ( ApiLayer s k))) -> ApiLayer s k -> WorkerCtx ( ApiLayer s k) Source #
type Rep ( ApiLayer s k) Source #
Instance details Defined in Cardano.Wallet.Api type Rep ( ApiLayer s k) = D1 (' MetaData "ApiLayer" "Cardano.Wallet.Api" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ApiLayer" ' PrefixI ' False ) ((( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Tracer IO TxSubmitLog )) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Tracer IO ( WorkerLog WalletId WalletWorkerLog )))) :: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Block , NetworkParameters )) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( NetworkLayer IO Block )))) :: (( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( TransactionLayer k SealedTx )) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( DBFactory IO s k))) :: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( WorkerRegistry WalletId ( DBLayer IO s k))) :: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Concierge IO WalletLock )) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( TokenMetadataClient IO )))))))
type WorkerCtx ( ApiLayer s k) Source #
Instance details Defined in Cardano.Wallet.Api type WorkerCtx ( ApiLayer s k) = WalletLayer IO s k
type WorkerMsg ( ApiLayer s k) Source #
Instance details Defined in Cardano.Wallet.Api type WorkerMsg ( ApiLayer s k) = WalletWorkerLog
type WorkerKey ( ApiLayer s k) Source #
Instance details Defined in Cardano.Wallet.Api type WorkerKey ( ApiLayer s k) = WalletId

type HasWorkerRegistry s k ctx = ( HasType ( WorkerRegistry WalletId ( DBLayer IO s k)) ctx, HasWorkerCtx ( DBLayer IO s k) ctx, WorkerKey ctx ~ WalletId , WorkerMsg ctx ~ WalletWorkerLog ) Source #

workerRegistry :: forall s k ctx. HasWorkerRegistry s k ctx => Lens' ctx ( WorkerRegistry WalletId ( DBLayer IO s k)) Source #

data WalletLock Source #

Locks that are held by the wallet in order to enforce sequential execution of some API actions. Used with Control.Concurrent.Concierge .

Constructors

PostTransactionOld WalletId

Instances

Instances details

Eq WalletLock Source #
Instance details Defined in Cardano.Wallet.Api Methods (==) :: WalletLock -> WalletLock -> Bool Source # (/=) :: WalletLock -> WalletLock -> Bool Source #
Ord WalletLock Source #
Instance details Defined in Cardano.Wallet.Api Methods compare :: WalletLock -> WalletLock -> Ordering Source # (<) :: WalletLock -> WalletLock -> Bool Source # (<=) :: WalletLock -> WalletLock -> Bool Source # (>) :: WalletLock -> WalletLock -> Bool Source # (>=) :: WalletLock -> WalletLock -> Bool Source # max :: WalletLock -> WalletLock -> WalletLock Source # min :: WalletLock -> WalletLock -> WalletLock Source #
Show WalletLock Source #
Instance details Defined in Cardano.Wallet.Api Methods showsPrec :: Int -> WalletLock -> ShowS Source # show :: WalletLock -> String Source # showList :: [ WalletLock ] -> ShowS Source #

walletLocks :: forall ctx. HasType ( Concierge IO WalletLock ) ctx => Lens' ctx ( Concierge IO WalletLock ) Source #

type HasDBFactory s k = HasType ( DBFactory IO s k) Source #

dbFactory :: forall s k ctx. HasDBFactory s k ctx => Lens' ctx ( DBFactory IO s k) Source #

tokenMetadataClient :: forall ctx. HasTokenMetadataClient ctx => Lens' ctx ( TokenMetadataClient IO ) Source #

type HasTokenMetadataClient = HasType ( TokenMetadataClient IO ) Source #