Contract.Wallet

mkKeyWalletFromPrivateKeys :: PrivatePaymentKey -> Maybe PrivateStakeKey -> Maybe PrivateDrepKey -> KeyWallet

withKeyWallet :: forall (a :: Type). KeyWallet -> Contract a -> Contract a

withKeyWalletFromMnemonic :: forall (a :: Type). String -> Cip1852DerivationPath -> StakeKeyPresence -> Contract a -> Contract a

ownStakePubKeyHash :: Warn (Text "This function returns only one `StakePubKeyHash` even in case multiple `StakePubKeysHash`es are available. Use `ownStakePubKeyHashes` instead") => Contract (Maybe StakePubKeyHash)

ownPaymentPubKeyHash :: Warn (Text "This function returns only one `PaymentPubKeyHash` even in case multiple `PaymentPubKeysHash`es are available. Use `ownPaymentPubKeyHashes` instead") => Contract (Maybe PaymentPubKeyHash)

Gets a wallet PaymentPubKeyHash via getWalletAddresses.

getWalletBalance :: Contract (Maybe Value)

getWalletUtxos :: Contract (Maybe UtxoMap)

Similar to utxosAt called on own address, except that it uses CIP-30 wallet state and not query layer state. The user should not expect these states to be in sync. When active wallet is KeyWallet, query layer state is used. This function is expected to be more performant than utxosAt when there is a large number of assets.

getWalletCollateral :: Contract (Maybe (Array TransactionUnspentOutput))

Get the collateral of the browser wallet. This collateral will vary depending on the wallet. E.g. Nami creates a hard-coded 5 Ada collateral. Throws on Promise rejection by wallet, returns Nothing if no collateral is available.

getWalletAddress :: Warn (Text "This function returns only one `Address` even in case multiple `Address`es are available. Use `getWalletAddresses` instead") => Contract (Maybe Address)

Get the first Address of the wallet.

newtype PrivateStakeKey

Constructors

• PrivateStakeKey PrivateKey

Instances

• Newtype PrivateStakeKey _
• Show PrivateStakeKey
• EncodeAeson PrivateStakeKey
• DecodeAeson PrivateStakeKey

newtype PrivatePaymentKey

Constructors

• PrivatePaymentKey PrivateKey

Instances

• Newtype PrivatePaymentKey _
• Show PrivatePaymentKey
• EncodeAeson PrivatePaymentKey
• DecodeAeson PrivatePaymentKey

newtype KeyWallet

An interface that wraps PrivateKeys. Used in CTL. Technically, can be implemented with remote calls, e.g. over HTTP, to provide signing services without revealing the private key.

Constructors

• KeyWallet { address :: NetworkId -> Aff Address, drepKey :: Aff (Maybe PrivateDrepKey), paymentKey :: Aff PrivatePaymentKey, selectCollateral :: Coin -> Coin -> Int -> UtxoMap -> Aff (Maybe (Array TransactionUnspentOutput)), signData :: Address -> RawBytes -> Aff (Maybe DataSignature), signTx :: Transaction -> Aff TransactionWitnessSet, stakeKey :: Aff (Maybe PrivateStakeKey) }

Instances

• Newtype KeyWallet _

privateKeysToKeyWallet :: PrivatePaymentKey -> Maybe PrivateStakeKey -> Maybe PrivateDrepKey -> KeyWallet

signData :: Address -> RawBytes -> Contract DataSignature

ownUnregisteredPubStakeKeys :: Contract (Array PublicKey)

ownStakePubKeyHashes :: Contract (Array (Maybe StakePubKeyHash))

ownRegisteredPubStakeKeys :: Contract (Array PublicKey)

ownPaymentPubKeyHashes :: Contract (Array PaymentPubKeyHash)

Gets all wallet PaymentPubKeyHashes via getWalletAddresses.

ownDrepPubKeyHash :: Contract Ed25519KeyHash

ownDrepPubKey :: Contract PublicKey

getWalletAddresses :: Contract (Array Address)

Get all Addresses of the browser wallet.

getWallet :: Contract (Maybe Wallet)

getUnusedAddresses :: Contract (Array Address)

getRewardAddresses :: Contract (Array Address)

getChangeAddress :: Contract Address

type WalletExtension = { exts :: Cip30Extensions, name :: String }

data Wallet

Constructors

• GenericCip30 Cip30Wallet
• KeyWallet KeyWallet

type Cip30Extensions = { cip95 :: Boolean }

isWalletAvailable :: String -> Effect Boolean

formatStakeKey :: PrivateStakeKey -> String

Convert private stake key to cardano-cli envelope format.

formatPaymentKey :: PrivatePaymentKey -> String

Convert private payment key to cardano-cli envelope format.

data WalletSpec

A data type to describe instructions on how to initialize a wallet.

Constructors

• UseKeys PrivatePaymentKeySource (Maybe PrivateStakeKeySource) (Maybe PrivateDrepKeySource)
• UseMnemonic MnemonicSource Cip1852DerivationPath StakeKeyPresence
• ConnectToGenericCip30 String Cip30Extensions

Instances

• Generic WalletSpec _
• Show WalletSpec

data PrivateStakeKeySource

Constructors

• PrivateStakeKeyFile FilePath
• PrivateStakeKeyValue PrivateStakeKey

Instances

• Generic PrivateStakeKeySource _
• Show PrivateStakeKeySource

data PrivatePaymentKeySource

Constructors

• PrivatePaymentKeyFile FilePath
• PrivatePaymentKeyValue PrivatePaymentKey

Instances

• Generic PrivatePaymentKeySource _
• Show PrivatePaymentKeySource

data MnemonicSource

Constructors

• MnemonicString String
• MnemonicFile FilePath

Instances

• Generic MnemonicSource _
• Show MnemonicSource

data KnownWallet

Constructors

• Nami
• Gero
• Flint
• Eternl
• Lode
• Lace
• NuFi

walletName :: KnownWallet -> String