Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
@radixdlt/account
Advanced tools
A JavaScript client library for interacting with the Radix Distributed Ledger.
@radixdlt/account
Account related APIs for Radix.
We have a WalletT
type being a hierchal deterministic wallet (explained by Ledger Acadamy and on BitcoinWiki) capable of deriving all "account"s you will need.
The trailing T in WalletT
is a suffix we use for all type
s (we don't use TypeScript class
es at all). We reserve the Wallet
name as a "namespaces" for our types, providing static-like factory/constructor methods, e.g. Wallet.create
(N.B. the lack of trailing T). This decision was taken since we believe you will more often use the namespace Wallet.create
than you have to declare the type WalletT
.
Here follows the generation of a new mnemonic and the creation of a wallet, via the saving of a keystore.
This outlines the most convenient wallet creation flow using byEncryptingMnemonicAndSavingKeystore
.
import { Mnemonic, Strength, Language } from '@radixdlt/account'
// ⚠️ Require user to backup mnemonic.
// She will NEVER be able to re-view it.
const mnemonic = Mnemonic.generateNew()
// This will be our "application password" (1️⃣)
// User chooses this, however, please tell her to use a unique, strong randomly generated encryption password. Also urge user to back this up in a safe place. She will need it every time she starts the app.
const keystoreEncryptionPassword = confirmPasswordTextField.value() // or similar
// You need to pass in a function which saves the keystore
// this example uses 'fs' but using a browser you might
// wanna try out https://www.npmjs.com/package/fs-jetpack or similar.
import { PathLike, promises as fsPromises } from 'fs'
const saveKeystoreOnDisk = (keystore: KeystoreT): Promise<void> => {
const filePath = 'SOME/SUITABLE/PATH/keystore.json'
const json = JSON.stringify(keystore, null, '\t')
return fsPromises.writeFile(filePath, json)
}
// `walletResult` has type `ResultAsync<WalletT, Error>`
// `ResultAsync`: github.com/supermacro/neverthrow (2️⃣)
const walletResult = await Wallet.byEncryptingMnemonicAndSavingKeystore({
mnemonic,
password: keystoreEncryptionPassword,
save: saveKeystoreOnDisk,
})
if (walletResult.isErr()) {
console.log(`🤷♂️ Failed to create wallet: ${walletResult.error}`)
} else {
const wallet = walletResult.value
// do something with 'wallet'
}
1️⃣: The keystoreEncryptionPassword
will be needed everytime the user re-opens the wallet app after having terminated it. It's used to decrypt the encrypted hdMasterSeed
. Remember, the keystore is just a JSON file containing an encrypted ciphertext, and metadata about the encryption used to derive said cihpertext. The ciphertext itself is the BIP39 "seed", not the entropy/mnemonic itself.
2️⃣ Read more about Result
/ ResultAsync
Alternatively you can use a flow where you have a bit more control. This is basically exactly what Wallet.byEncryptingMnemonicAndSavingKeystore
above does.
const mnemonic = Mnemonic.generateNew()
// ⚠️ Require user backup mnemonic first!
const masterSeed = HDMasterSeed.fromMnemonic({ mnemonic })
// Tell user to backup encryption password.
const keystoreEncryptionPassword = confirmPasswordTextField.value() // or similar
const walletResult = await Keystore.encryptSecret({
secret: masterSeed.seed,
password,
})
.map((keystore) => ({ keystore, filePath: keystorePath }))
.andThen((keystore) => {
// Save keystore on file and return an `ResultAsync<KeystoreT, Error>
})
.map((keystore) => ({ keystore, password: keystoreEncryptionPassword }))
.andThen(Wallet.fromKeystore)
if (walletResult.isErr()) {
console.log(`🤷♂️ Failed to create wallet: ${walletResult.error}`)
} else {
const wallet = walletResult.value
// do something with 'wallet'
}
// Path to where location where the keystore.json file will be saved.
import { Keystore } from "./keystore";
import { PathLike, promises as fsPromises } from 'fs'
// Each time GUI wallet starts ask user for encryption password in GUI
const keystoreEncryptionPassword = passwordTextField.value() // or similar
const loadKeystoreOnDisk = (): Promise<KeystoreT> => {
const filePath = 'SOME/SUITABLE/PATH/keystore.json'
return fsPromises.readFile(filePath)
.then(buffer => Keystore.fromBuffer(buffer))
}
const walletResult = await Wallet.byLoadingAndDecryptingKeystore({
password: keystoreEncryptionPassword,
load: loadKeystoreOnDisk
})
if (walletResult.isErr()) {
console.log(`🤷♂️ Failed to create wallet: ${walletResult.error}`)
} else {
const wallet = walletResult.value
// do something with 'wallet'
}
FAQs
A JavaScript client library for interacting with the Radix Distributed Ledger.
The npm package @radixdlt/account receives a total of 12 weekly downloads. As such, @radixdlt/account popularity was classified as not popular.
We found that @radixdlt/account demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.