Class BrowserExtensionWallet

This class acts as an adapter, consuming the raw, CBOR-based API of a CIP-30 wallet and exposing methods that return deserialized, object types from Cometa.

Implements

Wallet

Index

Constructors

constructor

Methods

createTransactionBuilder getBalance getChangeAddress getCollateral getNetworkId getNetworkMagic getPubDRepKey getRegisteredPubStakeKeys getRewardAddresses getUnregisteredPubStakeKeys getUnspentOutputs getUnusedAddresses getUsedAddresses signData signTransaction submitTransaction

Constructors

constructor

new BrowserExtensionWallet(
cip30Wallet: Cip30Wallet,
provider: Provider,
): BrowserExtensionWallet
Constructs a new instance of the BrowserExtensionWallet.
Parameters
- cip30Wallet: Cip30Wallet
  The raw CIP-30 wallet API provided by the browser extension.
- provider: Provider
  The provider used to fetch additional data.
Returns BrowserExtensionWallet
- Defined in wallet/BrowserExtensionWallet.ts:57

Methods

createTransactionBuilder

createTransactionBuilder(): Promise<TransactionBuilder>
Creates and initializes a new transaction builder with the wallet's current state.

Returns Promise<TransactionBuilder>
A promise that resolves to a pre-configured TransactionBuilder instance.
Remarks
This method simplifies transaction construction by automatically pre-populating the builder with:
1. The wallet's available UTxOs as inputs.
2. The wallet's change address to receive any leftover funds.
3. The network parameters from the wallet's provider.
The returned builder is ready for you to add outputs and other transaction details.
Implementation of Wallet.createTransactionBuilder
- Defined in wallet/BrowserExtensionWallet.ts:224

getBalance

getBalance(): Promise<Value>
Fetches and deserializes the total balance of all assets controlled by the wallet.

Returns Promise<Value>
A promise that resolves to a Value object representing the wallet's complete balance.
Implementation of Wallet.getBalance
- Defined in wallet/BrowserExtensionWallet.ts:84

getChangeAddress

getChangeAddress(): Promise<Address>
Fetches and parses a single change address from the wallet.

Returns Promise<Address>
A promise that resolves to a parsed Address object.
Implementation of Wallet.getChangeAddress
- Defined in wallet/BrowserExtensionWallet.ts:111

getCollateral

getCollateral(): Promise<UTxO[]>
Fetches and deserializes the wallet's collateral UTxOs.

Returns Promise<UTxO[]>
A promise that resolves to an array of collateral TxOut objects.

Remarks
Collateral is required for transactions involving Plutus smart contracts.
Implementation of Wallet.getCollateral
- Defined in wallet/BrowserExtensionWallet.ts:161

getNetworkId

getNetworkId(): Promise<NetworkId>
Returns the wallet's current network ID.

Returns Promise<NetworkId>
A promise that resolves to the network ID (0 for Testnet, 1 for Mainnet).
Implementation of Wallet.getNetworkId
- Defined in wallet/BrowserExtensionWallet.ts:66

getNetworkMagic

getNetworkMagic(): Promise<NetworkMagic>
Returns the "network magic," a unique number identifying the Cardano network.

Returns Promise<NetworkMagic>
A promise that resolves to the network magic number (e.g., Mainnet: 764824073, Preprod: 1).
Implementation of Wallet.getNetworkMagic
- Defined in wallet/BrowserExtensionWallet.ts:170

getPubDRepKey

getPubDRepKey(): Promise<string>
Returns the wallet's active public DRep (Delegated Representative) key.

Returns Promise<string>
A promise that resolves to the hex-encoded public DRep key.
Implementation of Wallet.getPubDRepKey
- Defined in wallet/BrowserExtensionWallet.ts:183

getRegisteredPubStakeKeys

getRegisteredPubStakeKeys(): Promise<string[]>
Returns public stake keys from the wallet that are currently registered for on-chain governance voting.

Returns Promise<string[]>
A promise that resolves to an array of hex-encoded public stake keys.
Implementation of Wallet.getRegisteredPubStakeKeys
- Defined in wallet/BrowserExtensionWallet.ts:194

getRewardAddresses

getRewardAddresses(): Promise<RewardAddress[]>
Fetches and parses all reward addresses controlled by the wallet.

Returns Promise<RewardAddress[]>
A promise that resolves to an array of parsed RewardAddress objects.
Implementation of Wallet.getRewardAddresses
- Defined in wallet/BrowserExtensionWallet.ts:120

getUnregisteredPubStakeKeys

getUnregisteredPubStakeKeys(): Promise<string[]>
Returns public stake keys from the wallet that are NOT yet registered for on-chain governance voting.

Returns Promise<string[]>
A promise that resolves to an array of hex-encoded public stake keys.
Implementation of Wallet.getUnregisteredPubStakeKeys
- Defined in wallet/BrowserExtensionWallet.ts:205

getUnspentOutputs

getUnspentOutputs(): Promise<UTxO[]>
Fetches the wallet's UTxOs and deserializes them from CBOR into an array of TxOut objects.

Returns Promise<UTxO[]>
A promise that resolves to an array of the wallet's UTxOs.
Implementation of Wallet.getUnspentOutputs
- Defined in wallet/BrowserExtensionWallet.ts:75

getUnusedAddresses

getUnusedAddresses(): Promise<Address[]>
Fetches and parses all unused addresses controlled by the wallet.

Returns Promise<Address[]>
A promise that resolves to an array of parsed Address objects.
Implementation of Wallet.getUnusedAddresses
- Defined in wallet/BrowserExtensionWallet.ts:102

getUsedAddresses

getUsedAddresses(): Promise<Address[]>
Fetches and parses all used addresses controlled by the wallet.

Returns Promise<Address[]>
A promise that resolves to an array of parsed Address objects.
Implementation of Wallet.getUsedAddresses
- Defined in wallet/BrowserExtensionWallet.ts:93

signData

signData(
address: string | Address,
payload: string,
): Promise<{ key: string; signature: string }>
Requests a CIP-8 compliant data signature from the wallet.
Parameters
- address: string | Address
  The address to sign with (as an Address object or Bech32 string).
- payload: string
  The hex-encoded data payload to be signed.
Returns Promise<{ key: string; signature: string }>
A promise that resolves to the signature and public key.
Implementation of Wallet.signData
- Defined in wallet/BrowserExtensionWallet.ts:142

signTransaction

signTransaction(txCbor: string, partialSign: boolean): Promise<VkeyWitnessSet>
Requests a transaction signature from the wallet and deserializes the resulting witness set.
Parameters
- txCbor: string
  The transaction to be signed, provided as a CBOR hex string.
- partialSign: boolean
  If true, the wallet will only add its witness for multi-signature transactions.
Returns Promise<VkeyWitnessSet>
A promise that resolves to the deserialized VkeyWitnessSet.
Implementation of Wallet.signTransaction
- Defined in wallet/BrowserExtensionWallet.ts:131

submitTransaction

submitTransaction(txCbor: string): Promise<string>
Submits a fully signed transaction to the blockchain via the wallet's provider.
Parameters
- txCbor: string
  The fully signed transaction as a CBOR hex string.
Returns Promise<string>
A promise that resolves to the transaction ID (hash).
Implementation of Wallet.submitTransaction
- Defined in wallet/BrowserExtensionWallet.ts:152

Class BrowserExtensionWallet

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BrowserExtensionWallet

Methods

createTransactionBuilder

Returns Promise<TransactionBuilder>

Remarks

getBalance

Returns Promise<Value>

getChangeAddress

Returns Promise<Address>

getCollateral

Returns Promise<UTxO[]>

Remarks

getNetworkId

Returns Promise<NetworkId>

getNetworkMagic

Returns Promise<NetworkMagic>

getPubDRepKey

Returns Promise<string>

getRegisteredPubStakeKeys

Returns Promise<string[]>

getRewardAddresses

Returns Promise<RewardAddress[]>

getUnregisteredPubStakeKeys

Returns Promise<string[]>

getUnspentOutputs

Returns Promise<UTxO[]>

getUnusedAddresses

Returns Promise<Address[]>

getUsedAddresses

Returns Promise<Address[]>

signData

Parameters

Returns Promise<{ key: string; signature: string }>

signTransaction

Parameters

Returns Promise<VkeyWitnessSet>

submitTransaction

Parameters

Returns Promise<string>

Settings

On This Page