cardano-web3-js
v2.1.3
Published
Cardano Web3 JavaScript SDK
Downloads
77
Readme
🛠 Cardano Web3 JavaScript SDK
CardanoWeb3js is a versatile TypeScript library designed for seamless integration with the Cardano blockchain. It supports both Node.js and browser environments, streamlining transaction creation, smart contract deployment, and data exploration. Ideal for developers, this toolkit simplifies Cardano cryptographic operations and API interactions
Installation
To install with Yarn, run:
yarn install cardano-web3-js
To install with NPM, run:
npm i cardano-web3-js
Documentation
- Docs: https://cardano-web3-js.org
- Typedoc API: https://cardano-web3-js.org/api
- Playground: https://cardano-web3-js.org/playground
Basic Usage
Check /test folder for detailed usage examples. Or read the documentation to learn how to create a transaction of any complexity
import { CardanoWeb3 } from "cardano-web3-js"
const app = async () => {
const web3 = await CardanoWeb3.init()
const mnemonic = web3.utils.keys.mnemonicGenerate()
const account = web3.account.fromMnemonic(mnemonic)
await account.updateState() // update balance & delegation info
const { utxos } = account.__state
console.log(mnemonic) // generated mnemonic
console.log(account.__config) // account info (xpub, changeAddress, creds, etc)
console.log(account.__state) // balance & delegation info
const tx = await web3
.createTx()
.addInputs(utxos)
.addOutput(
{
address: "addr1qxpm2aqmn48he8dtp9p8hk9gtew6cypy6ra3mgs8xkn86qmd3vtjzheq22w8mmfhm8agpmywnlu2rsxgkdrctv7mcc3s9anhjz",
value: 2000000n,
},
)
.applyAndBuild()
const tx_hash = await tx_unsigned
.signWithAccount(account)
.applyAndSubmit() // submit tx
console.log(tx_hash)
}
app()
Web3 Configuration Parameteres
import { CardanoWeb3, KoiosProvider, KupmiosProvider, BlockfrostProvider } from "cardano-web3-js"
const app = async () => {
const providerHeaders = {
"x-api-key": "YOUR_API_KEY_01",
}
const koiosHeaders = {
"x-api-key": "YOUR_API_KEY_02",
}
const web3 = await CardanoWeb3.init({
network: "preprod", // "mainnet" | "preprod" | "preview" | "custom"
protocolParams: {...}, // override protocolParams, eg. in case of custom network
ttl: 900, // 900 secs = 15 minutes
provider: new KoiosProvider("https://api.koios.rest/api/v1", providerHeaders),
explorer: {
koios: {
headers: koiosHeaders,
url: "https://preprod.koios.rest/api/v1",
},
nftcdn: {
headers: {},
url: "https://graph.xray.app/output/nftcdn/preprod/api/v1",
},
pricing: {
headers: {},
url: "https://graph.xray.app/output/pricing/mainnet/api/v1", // only mainnet available
},
}
})
console.log(web3.__config) // web3 instance config
}
app()
Test
Check /test folder for available tests
yarn test