https://github.com/xray-network/cardano-web3-js
Cardano Web3 JavaScript SDK
https://github.com/xray-network/cardano-web3-js
blockchain cardano cardano-web3-js sdk web3 web3js xray
Last synced: 4 months ago
JSON representation
Cardano Web3 JavaScript SDK
- Host: GitHub
- URL: https://github.com/xray-network/cardano-web3-js
- Owner: xray-network
- License: mit
- Created: 2021-06-06T14:16:07.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-20T09:14:08.000Z (11 months ago)
- Last Synced: 2025-09-14T02:34:43.615Z (9 months ago)
- Topics: blockchain, cardano, cardano-web3-js, sdk, web3, web3js, xray
- Language: TypeScript
- Homepage: https://cardano-web3-js.org
- Size: 2.92 MB
- Stars: 47
- Watchers: 3
- Forks: 6
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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:
```TypeScript
yarn install cardano-web3-js
```
To install with NPM, run:
```TypeScript
npm i cardano-web3-js
```
## Documentation
* Docs: [https://cardano-web3-js.org](https://cardano-web3-js.org)
* Typedoc API: [https://cardano-web3-js.org/api](https://cardano-web3-js.org/api)
* Playground: [https://cardano-web3-js.org/playground](https://cardano-web3-js.org/playground)
## Basic Usage
Check [/test](/test) folder for detailed usage examples. Or read the documentation to learn how to create a transaction of any complexity
``` ts
import { CardanoWeb3 } from "cardano-web3-js"
const web3 = new CardanoWeb3()
const mnemonic = web3.utils.keys.mnemonicGenerate()
const account = web3.account.fromMnemonic(mnemonic)
const state = await account.getState() // update balance & delegation info
console.log(mnemonic) // generated mnemonic
console.log(account.__config) // account info (xpub, changeAddress, creds, etc)
console.log(state) // balance & delegation info
const tx = await web3
.createTx()
.addInputs(state.utxos)
.addOutput(
{
address: "addr1qxpm2aqmn48he8dtp9p8hk9gtew6cypy6ra3mgs8xkn86qmd3vtjzheq22w8mmfhm8agpmywnlu2rsxgkdrctv7mcc3s9anhjz",
value: 2000000n,
},
)
.applyAndBuild()
const tx_hash = await tx_unsigned
.signWithAccount(account)
.applyAndSubmit() // submit tx
console.log(tx_hash)
```
## Web3 Configuration Parameteres
Configuration Parameters
``` ts
import { CardanoWeb3, KoiosProvider, KupmiosProvider, BlockfrostProvider } from "cardano-web3-js"
const providerHeaders = {
"x-api-key": "YOUR_API_KEY_01",
}
const koiosHeaders = {
"x-api-key": "YOUR_API_KEY_02",
}
const web3 = new CardanoWeb3({
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
```
## Test
Check [/test](/test) folder for available tests
```TypeScript
yarn test
```