Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/lucid/mod.ts

Lucid is a library, which allows you to create Cardano transactions and off-chain code for your Plutus contracts in JavaScript, Deno and Node.js.
Very Popular
Latest
import * as lucid from "https://deno.land/x/lucid@0.10.7/mod.ts";

Classes

ED25519 key used as public key

We introduce a builder-pattern format for creating transaction outputs This is because:

  1. Some fields (i.e. data hash) are optional, and we can't easily expose Option<> in WASM
  2. Some fields like amounts have many ways it could be set (some depending on other field values being known)
  3. Easier to adapt as the output format gets more complicated in future Cardano releases

Builder de-duplicates witnesses as they are added

Variables

JSON <-> PlutusData conversion schemas. Follows ScriptDataJsonSchema in cardano-cli defined at: https://github.com/input-output-hk/cardano-node/blob/master/cardano-api/src/Cardano/Api/ScriptData.hs#L254

Each new language uses a different namespace for hashing its script This is because you could have a language where the same bytes have different semantics So this avoids scripts in different languages mapping to the same hash Note that the enum value here is different than the enum value for deciding the cost model of a script https://github.com/input-output-hk/cardano-ledger/blob/9c3b4737b13b30f71529e76c5330f403165e28a6/eras/alonzo/impl/src/Cardano/Ledger/Alonzo.hs#L127

Used to choose the schema for a script JSON string

Functions

Returns double cbor encoded script. If script is already double cbor encoded it's returned as it is.

Receives a script JSON string and returns a NativeScript. Cardano Wallet and Node styles are supported.

Instantiates an instance of the Wasm module returning its functions.

Instantiates an instance of the Wasm module along with its exports.

Gets if the Wasm module has been instantiated.

Concatenate the given arrays into a new Uint8Array.

This function is temporarily needed only, until Blockfrost returns the datum natively in Cbor. The conversion is ambigious, that's why it's better to get the datum directly in Cbor.

Check whether binary arrays are equal to each other.

Convert a Utf-8 encoded string to a Hex encoded string.

Splits unit into policy id, asset name (entire asset name), name (asset name without label) and label if applicable. name will be returned in Hex.

Address can be in Bech32 or Hex.

Instantiates an instance of the Wasm module returning its functions.

Instantiates an instance of the Wasm module along with its exports.

Gets if the Wasm module has been instantiated.

Convert a native script from Json to the Hex representation. It follows this Json format: https://github.com/input-output-hk/cardano-node/blob/master/doc/reference/simple-scripts.md

Convert a Hex encoded string to a Utf-8 encoded string.

Interfaces

A wallet that can be constructed from external data e.g utxos and an address. It doesn't allow you to sign transactions/messages. This needs to be handled separately.

Type Aliases

Bech32

Hex

Hex

JSON object

Hex

hash adds the datum hash to the output.

Hex

Hex

Hex

Bech32

Bech32

Bech32

Hex (Redeemer is only PlutusData, same as Datum)

Bech32

Hex

Hex

Hex

Hex

Hex

Hex

Concatenation of policy id and asset name in Hex.

Time in milliseconds

Hex