Nami is a browser based wallet extension to interact with the Cardano blockchain. It's an open-source project maintained by IOG.
Download and extract the zip attached to the latest Release. Then go to chrome://extensions
, click Load unpacked at the top left and select the build folder.
Since Nami is a browser extension, it can inject content inside the web context, which means you can connect the wallet to any website.
The exposed API follows CIP-0030. The returned types are in cbor
/bytes
format. A helpful library for serializing and de-serializing these low-level data structures is the serialization-lib. To verify a signature returned from cardano.dataSign(address, payload)
the message-signing library helps.
window.cardano
) and detect Nami (window.cardano.nami
)api
from window.cardano.nami.enable()
The full list of methods can be found in CIP-0030.
For the wallet namespace Nami uses nami
.
Note: Nami follows the ongoing PR for the dataSign
endpoint. (Very similar to the previous dataSign
endpoint from Nami).
Nami also uses a few custom endpoints, which are available under api.experimental
:
cardano.getCollateral() : [TransactionUnspentOutput]
Register events coming from Nami. Available events are:
accountChange: ((addresses : [BaseAddress]) => void)
networkChange: ((network : number) => void)
Deregister the events (works also with anonymous functions).
Since Nami is a browser extension, it can inject content inside the web context, which means you can connect the wallet to any website.
The exposed API follows for most parts this proposed CIP. The returned types are in cbor
/bytes
format. A helpful library for serializing and de-serializing these low-level data structures is the serialization-lib. To verify a signature returned from cardano.dataSign(address, payload)
the message-signing library helps.
window.cardano
)All methods will return their values as Promise
. For simplicity and easier understanding the API is explained without the Promises.
Will ask the user to give access to requested website. If access is given, this function will return true
, otherwise throws an error
.
If the user calls this function again with already having permission to the requested website, it will simply return true
.
cardano.isEnabled() : boolean
Returns true
if wallet has access to requested website, false
otherwise.
cardano.getBalance() : Value
Value
is a hex encoded cbor string.
cardano.getUtxos(amount?: Value, paginate?: {page: number, limit: number}) : [TransactionUnspentOutput]
TransactionUnspentOutput
is a hex encoded bytes string.
amount
and paginate
are optional parameters. They are meant to filter the overall utxo set of a user's wallet.
cardano.getCollateral() : [TransactionUnspentOutput]
cardano.getUsedAddresses() : [BaseAddress]
BaseAddress
is a hex encoded bytes string.
Note Nami doesn't utilize the concept of multipe addresses per wallet. This function will return an array of length 1
and will always return the same single address. Just to follow the standards of the proposed CIP, it will return the address in an array.
cardano.getUnusedAddresses() : [BaseAddress]
Note This endpoint will return an empty array []. Same reason as above, simply to follow the standards.
cardano.getChangeAddress() : BaseAddress
Will return the same address as the one in cardano.getUsedAddresses()
.
cardano.getRewardAddress() : [RewardAddress]
RewardAddress
is a hex encoded bytes string.
Note This function will return an array of length 1
and will always return the same single address.
cardano.getNetworkId() : number
Returns 0
if on testnet
, otherwise 1
if on mainnet
.
cardano.signData(address: BaseAddress|RewardAddress, payload: string) : CoseSign1
payload
is a hex encoded utf8 string.
CoseSign1
is a hex encoded bytes string.
If address is the BaseAddress
the signature is returned with the Payment Credential
, otherwise if the address is the RewardAddress
the signature is returned with the Stake Credential
.
The returned CoseSign1
object contains the payload
, signature
and the following protected headers:
key_id
=> PublicKey
,address
=> BaseAddress | RewardAddress
algorithm_id
=> EdDSA(0) (the algorithm used for Cardano addresses).Read more about message signing in CIP-0008.
cardano.signTx(tx: Transaction, partialSign?: boolean) : TransactionWitnessSet
Transaction
is a hex encoded cbor string.
TransactionWitnessSet
is a hex encoded cbor string.
partialSign
is by default false
and optional. The wallet needs to provide all required signatures. If it can't an error
is thrown, otherwise the TransactionWitnessSet
is returned.
If partialSign
is true
, the wallet doesn't need to provide all required signatures.
cardano.submitTx(tx : Transaction) : hash32
Returns the transaction hash, if transaction was submitted successfully, otherwise throws an error
.
cardano.onAccountChange((addresses : [BaseAddress]) => void)
Note To follow the standards of multiple addresses the callback will return an array, although Nami will just return an array with a single address, which is the same as the one in cardano.getUsedAddresses()
.
cardano.onNetworkChange((network : number) => void)
The project_id
for API requests can be created under blockfrost.io.
Recommended: Follow this approach in order to keep the keys seperate from the repository.
# Update secrets file with your own keys
cp secrets.testing.js secrets.development.js
The quick solution is to go under ./src/config/provider.js
and replace secrets.PROJECT_ID_MAINNET
, secrets.PROJECT_ID_TESTNET
, secrets.PROJECT_ID_PREVIEW
and secrets.PROJECT_ID_PREPROD
with the project ids from blockfrost.
# Update secrets file with your own keys
cp secrets.testing.js secrets.development.js
npm start
# Update secrets file with your own keys
cp secrets.testing.js secrets.production.js
npm run build
npm test
Wasm packages commit hash: 9986d0532334c465bbe4aa00234968edb43575d6
Visit namiwallet.io