@emurgo/cardano-serialization-lib-nodejs

What is @emurgo/cardano-serialization-lib-nodejs?

@emurgo/cardano-serialization-lib-nodejs is a library for Cardano blockchain developers that provides tools for serialization and deserialization of data structures used in Cardano transactions. It allows developers to create, sign, and manage Cardano transactions and addresses programmatically.

What are @emurgo/cardano-serialization-lib-nodejs's main functionalities?

Transaction Creation

This feature allows developers to create Cardano transactions by building transaction outputs and inputs. The code sample demonstrates how to create a transaction builder, add an output with a specific address and value, and build the transaction.

const { TransactionBuilder, TransactionOutput, Address, Value } = require('@emurgo/cardano-serialization-lib-nodejs');

const txBuilder = TransactionBuilder.new();
const address = Address.from_bech32('addr_test...');
const value = Value.new(BigInt(1000000));
const output = TransactionOutput.new(address, value);
txBuilder.add_output(output);
const tx = txBuilder.build();

Address Handling

This feature provides utilities for handling Cardano addresses, including conversion between different address formats. The code sample shows how to create an address from a Bech32 string and convert it back to a Bech32 string.

const { Address } = require('@emurgo/cardano-serialization-lib-nodejs');

const address = Address.from_bech32('addr_test...');
console.log(address.to_bech32());

Transaction Signing

This feature allows developers to sign transactions using private keys. The code sample demonstrates how to deserialize a transaction from bytes, sign it with a private key, and obtain a signed transaction.

const { Transaction, PrivateKey } = require('@emurgo/cardano-serialization-lib-nodejs');

const tx = Transaction.from_bytes(Buffer.from('...'));
const privateKey = PrivateKey.from_bech32('...');
const signedTx = tx.sign(privateKey);

Other packages similar to @emurgo/cardano-serialization-lib-nodejs

cardano-wallet-js

cardano-wallet-js is a JavaScript library for interacting with Cardano wallets. It provides functionalities for managing wallets, addresses, and transactions. Compared to @emurgo/cardano-serialization-lib-nodejs, cardano-wallet-js focuses more on wallet management and less on low-level transaction serialization.

cardano-crypto.js

cardano-crypto.js is a library for cryptographic operations related to Cardano, such as key generation and signing. While it provides some overlapping functionalities with @emurgo/cardano-serialization-lib-nodejs, it is more focused on cryptographic primitives rather than transaction serialization and deserialization.

README

Cardano Serialization Lib

This is a library, written in Rust, for serialization & deserialization of data structures used in Cardano's Haskell implementation of Alonzo along with useful utility functions.

NPM packages

• NodeJS WASM package
• Browser (chrome/firefox) WASM package
• Browser (pure JS - no WASM) ASM.js package

NPM packages with GC support

Note: This package uses weak references flag from wasm-bindgen. It uses FinalizationRegistry under the hood to automatically call "free" for each CSL struct when it is no longer needed. However, use this feature with caution as it may have unpredictable behaviors.

• NodeJS WASM package with GC
• Browser (chrome/firefox) WASM package with GC
• Browser (pure JS - no WASM) ASM.js package with GC

Rust crates

• cardano-serialization-lib

Mobile bindings

• React-Native mobile bindings

Documentation

You can find documentation here