- {props.data.error}
+
+ {open && (
+ <>
+ {topic.description}
+ {!!props.data.error && (
+
+ {props.data.error}
+
+ )}
+ {props.data.attributes?.map((c) => (
+
+ ))}
+ {props.data.children?.map((c) => (
+
+ ))}
+ {!props.data.attributes?.length && !props.data.children?.length && (
+
+ )}
+ {!!props.data.bytes && (
+
+ )}
+
)}
);
@@ -145,7 +160,7 @@ export function TextArea(props: { name: string; placeholder?: string }) {
}
export function logCuriosity(data: any) {
- if (!!data) {
+ if (data) {
console.group("CURIOUS FELLOW, EH?");
console.log("hello there! want to learn how we parse the data?");
console.log(
@@ -159,3 +174,65 @@ export function logCuriosity(data: any) {
console.groupEnd();
}
}
+
+export function AccordionItem({ validation }: { validation: IValidation }) {
+ const [open, setOpen] = useState(false);
+ const handleClick = () => setOpen(!open);
+ return (
+
+
+
+
+ +
+
+
+
+ {open && (
+
{validation.description}
+ )}
+
+
+ );
+}
+
+export function ValidationAccordion(props: { validations: IValidation[] }) {
+ return (
+
+ {props.validations.map((v) => (
+
+ ))}
+
+ );
+}
diff --git a/web/app/routes/tx.tsx b/web/app/routes/tx.tsx
index d88b14b..bc4b149 100644
--- a/web/app/routes/tx.tsx
+++ b/web/app/routes/tx.tsx
@@ -1,9 +1,25 @@
import { ActionFunctionArgs, json, type MetaFunction } from "@remix-run/node";
import { Form, useActionData } from "@remix-run/react";
-import { Button, logCuriosity, RootSection } from "~/components";
+import { useState } from "react";
+import {
+ Button,
+ logCuriosity,
+ RootSection,
+ ValidationAccordion,
+} from "../components";
import * as server from "./tx.server";
import TOPICS from "./tx.topics";
+export interface IValidation {
+ name: string;
+ value: boolean;
+ description: string;
+}
+
+export interface IValidations {
+ validations: IValidation[];
+}
+
export const meta: MetaFunction = () => {
return [
{ title: "Cardano Tx - Lovelace Anatomy" },
@@ -13,9 +29,9 @@ export const meta: MetaFunction = () => {
export async function action({ request }: ActionFunctionArgs) {
const formData = await request.formData();
- let raw = formData.get("raw");
+ const raw = formData.get("raw");
- if (!!raw) {
+ if (raw) {
const res = server.safeParseTx(raw.toString());
return json({ ...res, raw });
} else {
@@ -41,10 +57,57 @@ function ExampleCard(props: { title: string; address: string }) {
}
export default function Index() {
- const data: any = useActionData();
+ const data = useActionData();
+
+ const [open, setOpen] = useState(false);
+ const handleClick = () => setOpen(!open);
logCuriosity(data);
+ const validations: IValidation[] = [
+ { name: "Non empty inputs", value: true, description: "Sucessful" },
+ {
+ name: "All inputs in utxos",
+ value: false,
+ description:
+ "Lorem ipsum dolor sit amet consectetur adipisicing elit. Porro id maiores exercitationem asperiores molestias assumenda doloremque magnam fugit. Iure dolorum fugit facilis autem incidunt vero necessitatibus consectetur ducimus recusandae blanditiis!",
+ },
+ { name: "Validity interval", value: true, description: "Sucessful" },
+ { name: "Fee", value: true, description: "Sucessful" },
+ {
+ name: "Preservation of value",
+ value: false,
+ description:
+ "Lorem ipsum dolor sit amet consectetur adipisicing elit. Porro id maiores exercitationem asperiores molestias assumenda doloremque magnam fugit. Iure dolorum fugit facilis autem incidunt vero necessitatibus consectetur ducimus recusandae blanditiis!",
+ },
+ {
+ name: "Min lovelace per UTxO",
+ value: false,
+ description:
+ "Lorem ipsum dolor sit amet consectetur adipisicing elit. Porro id maiores exercitationem asperiores molestias assumenda doloremque magnam fugit. Iure dolorum fugit facilis autem incidunt vero necessitatibus consectetur ducimus recusandae blanditiis!",
+ },
+ { name: "Output value size", value: true, description: "Successful" },
+ { name: "Network Id", value: true, description: "Successful" },
+ { name: "Tx size", value: true, description: "Successful" },
+ { name: "Tx execution units", value: true, description: "Successful" },
+ { name: "Minting", value: true, description: "Successful" },
+ {
+ name: "Well formed",
+ value: false,
+ description:
+ "Lorem ipsum dolor sit amet consectetur adipisicing elit. Porro id maiores exercitationem asperiores molestias assumenda doloremque magnam fugit. Iure dolorum fugit facilis autem incidunt vero necessitatibus consectetur ducimus recusandae blanditiis!",
+ },
+ { name: "Script witness", value: true, description: "Successful" },
+ { name: "Languages", value: true, description: "Successful" },
+ {
+ name: "Auxiliary data hash",
+ value: false,
+ description:
+ "Lorem ipsum dolor sit amet consectetur adipisicing elit. Porro id maiores exercitationem asperiores molestias assumenda doloremque magnam fugit. Iure dolorum fugit facilis autem incidunt vero necessitatibus consectetur ducimus recusandae blanditiis!",
+ },
+ { name: "Script data hash", value: true, description: "Successful" },
+ ];
+
return (
Cardano Tx
@@ -82,7 +145,25 @@ export default function Index() {
)}
- {!!data && }
+ {!!data && (
+
+
+
+ {open &&
}
+
+
+
);
}
From ccfcfcaddc5fbc179b5dba2e3911edcf4495d8a9 Mon Sep 17 00:00:00 2001
From: Sara <88407794+mikarasv@users.noreply.github.com>
Date: Tue, 9 Apr 2024 21:45:43 -0300
Subject: [PATCH 2/2] chore: scaffold tx validation UI (#10)
---
napi-pallas/Cargo.toml | 2 +-
napi-pallas/index.d.ts | 14 +-
napi-pallas/src/lib.rs | 73 +++-
napi-pallas/src/tx.rs | 40 +-
napi-pallas/src/validations/alonzo.rs | 8 +
napi-pallas/src/validations/babbage.rs | 22 +
napi-pallas/src/validations/byron.rs | 6 +
napi-pallas/src/validations/conway.rs | 7 +
napi-pallas/src/validations/mod.rs | 6 +
napi-pallas/src/validations/shelley_ma.rs | 8 +
napi-pallas/src/validations/validate.rs | 31 ++
web/app/components.tsx | 39 +-
web/app/routes/tx.server.ts | 2 +-
web/app/routes/tx.tsx | 46 +-
web/yarn.lock | 509 +++++++++-------------
15 files changed, 451 insertions(+), 362 deletions(-)
create mode 100644 napi-pallas/src/validations/alonzo.rs
create mode 100644 napi-pallas/src/validations/babbage.rs
create mode 100644 napi-pallas/src/validations/byron.rs
create mode 100644 napi-pallas/src/validations/conway.rs
create mode 100644 napi-pallas/src/validations/mod.rs
create mode 100644 napi-pallas/src/validations/shelley_ma.rs
create mode 100644 napi-pallas/src/validations/validate.rs
diff --git a/napi-pallas/Cargo.toml b/napi-pallas/Cargo.toml
index 41bbf9d..cf2d72f 100644
--- a/napi-pallas/Cargo.toml
+++ b/napi-pallas/Cargo.toml
@@ -12,7 +12,7 @@ hex = "0.4.3"
# Default enable napi4 feature, see https://nodejs.org/api/n-api.html#node-api-version-matrix
napi = { version = "2.12.2", default-features = false, features = ["napi4"] }
napi-derive = "2.12.2"
-pallas = "0.21.0"
+pallas = { git = "https://github.com/alegadea/pallas.git", rev = "54ffc77" , features = ["unstable"]}
[build-dependencies]
napi-build = "2.0.1"
diff --git a/napi-pallas/index.d.ts b/napi-pallas/index.d.ts
index 4399f32..7254742 100644
--- a/napi-pallas/index.d.ts
+++ b/napi-pallas/index.d.ts
@@ -33,5 +33,17 @@ export interface Section {
children: Array
}
export function parseAddress(raw: string): Output
-export function safeParseTx(raw: string): Section
+export interface SectionValidation {
+ section: Section
+ validations: Validations
+}
+export function safeParseTx(raw: string): SectionValidation
export function safeParseBlock(raw: string): Section
+export interface Validation {
+ name: string
+ value: boolean
+ description: string
+}
+export interface Validations {
+ validations: Array
+}
diff --git a/napi-pallas/src/lib.rs b/napi-pallas/src/lib.rs
index ffab29e..af1cc3a 100644
--- a/napi-pallas/src/lib.rs
+++ b/napi-pallas/src/lib.rs
@@ -8,6 +8,7 @@ extern crate napi_derive;
mod address;
mod block;
mod tx;
+mod validations;
#[derive(Default)]
#[napi(object)]
@@ -143,11 +144,27 @@ pub fn parse_address(raw: String) -> address::Output {
}
}
+#[derive(Default)]
+#[napi(object)]
+pub struct SectionValidation {
+ pub section: Section,
+ pub validations: Validations,
+}
+
#[napi]
-pub fn safe_parse_tx(raw: String) -> Section {
+pub fn safe_parse_tx(raw: String) -> SectionValidation {
match tx::parse(raw) {
- Ok(x) => x,
- Err(x) => x,
+ Ok(x) => {
+ let (section, validations) = x;
+ SectionValidation {
+ section,
+ validations: validations,
+ }
+ }
+ Err(x) => SectionValidation {
+ section: x,
+ validations: Validations::new(),
+ },
}
}
@@ -158,3 +175,53 @@ pub fn safe_parse_block(raw: String) -> Section {
Err(x) => x,
}
}
+
+#[derive(Default, Debug)]
+#[napi(object)]
+pub struct Validation {
+ pub name: String,
+ pub value: bool,
+ pub description: String,
+}
+
+impl Validation {
+ fn new() -> Self {
+ Default::default()
+ }
+
+ pub fn with_description(self, description: impl ToString) -> Self {
+ Self {
+ description: description.to_string(),
+ ..self
+ }
+ }
+
+ pub fn with_value(self, value: bool) -> Self {
+ Self { value, ..self }
+ }
+
+ pub fn with_name(self, name: impl ToString) -> Self {
+ Self {
+ name: name.to_string(),
+ ..self
+ }
+ }
+}
+
+#[derive(Debug, Default)]
+#[napi(object)]
+pub struct Validations {
+ pub validations: Vec,
+}
+
+impl Validations {
+ pub fn new() -> Self {
+ Default::default()
+ }
+
+ pub fn add_new_validation(mut self, validation: Validation) -> Self {
+ self.validations.push(validation);
+
+ self
+ }
+}
diff --git a/napi-pallas/src/tx.rs b/napi-pallas/src/tx.rs
index d293c4c..2be1295 100644
--- a/napi-pallas/src/tx.rs
+++ b/napi-pallas/src/tx.rs
@@ -1,3 +1,6 @@
+use crate::validations::validate::validate;
+use crate::Validations;
+
use super::Section;
use pallas::{
codec::utils::KeepRaw,
@@ -5,7 +8,7 @@ use pallas::{
ledger::{
primitives::{
babbage::{Redeemer, RedeemerTag},
- conway::{Metadatum, PlutusData, PlutusV1Script, VKeyWitness},
+ conway::{Metadatum, PlutusData, VKeyWitness},
ToCanonicalJson,
},
traverse::{ComputeHash, MultiEraInput, MultiEraOutput, MultiEraTx},
@@ -98,8 +101,8 @@ fn print_metadatum(datum: &Metadatum) -> String {
Metadatum::Int(x) => x.to_string(),
Metadatum::Bytes(x) => hex::encode(x.as_slice()),
Metadatum::Text(x) => x.to_owned(),
- Metadatum::Array(x) => "[Array]".to_string(),
- Metadatum::Map(x) => "[Map]".to_string(),
+ Metadatum::Array(_) => "[Array]".to_string(),
+ Metadatum::Map(_) => "[Map]".to_string(),
}
}
@@ -190,7 +193,8 @@ fn tx_witnesses_section(tx: &MultiEraTx<'_>) -> Section {
Section::new()
.with_topic("tx_witnesses")
.append_children(tx.vkey_witnesses().iter().map(tx_vkey_witnesses_section))
- .append_children(tx.redeemers().iter().map(tx_redeemer_section))
+ // TODO: Uncomment when branch with this issue fixed is used
+ // .append_children(tx.redeemers().iter().map(tx_redeemer_section))
.append_children(tx.plutus_data().iter().map(tx_plutus_datum_section))
.append_children(
tx.plutus_v1_scripts()
@@ -209,11 +213,8 @@ fn tx_witnesses_section(tx: &MultiEraTx<'_>) -> Section {
)
}
-pub fn parse(raw: String) -> Result {
+pub fn create_cbor_structure(tx: &MultiEraTx<'_>) -> Section {
let out = Section::new().with_topic("cbor_parse").try_build_child(|| {
- let cbor = hex::decode(raw)?;
- let tx = MultiEraTx::decode(&cbor)?;
-
let child = Section::new()
.with_topic("tx")
.with_attr("era", tx.era())
@@ -231,6 +232,27 @@ pub fn parse(raw: String) -> Result {
Ok(child)
});
+ out
+}
- Ok(out)
+pub fn parse(raw: String) -> Result<(Section, Validations), Section> {
+ let res_cbor = hex::decode(raw);
+ match res_cbor {
+ Ok(cbor) => {
+ let res_mtx = MultiEraTx::decode(&cbor);
+ match res_mtx {
+ Ok(mtx) => Ok((create_cbor_structure(&mtx), validate(&mtx))),
+ Err(e) => {
+ let mut err = Section::new();
+ err.error = Some(e.to_string());
+ Err(err)
+ }
+ }
+ }
+ Err(e) => {
+ let mut err = Section::new();
+ err.error = Some(e.to_string());
+ Err(err)
+ }
+ }
}
diff --git a/napi-pallas/src/validations/alonzo.rs b/napi-pallas/src/validations/alonzo.rs
new file mode 100644
index 0000000..8393406
--- /dev/null
+++ b/napi-pallas/src/validations/alonzo.rs
@@ -0,0 +1,8 @@
+use pallas::ledger::primitives::alonzo::MintedTx;
+
+use crate::Validations;
+
+pub fn validate_alonzo(mtx_a: &MintedTx) -> Validations {
+ let out = Validations::new();
+ out
+}
diff --git a/napi-pallas/src/validations/babbage.rs b/napi-pallas/src/validations/babbage.rs
new file mode 100644
index 0000000..9006454
--- /dev/null
+++ b/napi-pallas/src/validations/babbage.rs
@@ -0,0 +1,22 @@
+use crate::{Validation, Validations};
+use pallas::{
+ applying::babbage::check_ins_not_empty,
+ ledger::primitives::babbage::{MintedTransactionBody, MintedTx as BabbageMintedTx},
+};
+
+use super::validate::set_description;
+
+fn validate_babbage_ins_not_empty(mtx: &BabbageMintedTx) -> Validation {
+ let tx_body: &MintedTransactionBody = &mtx.transaction_body.clone();
+ let res = check_ins_not_empty(tx_body);
+ let description = set_description(&res, "Inputs are not empty".to_string());
+ return Validation::new()
+ .with_name("Non empty inputs".to_string())
+ .with_value(res.is_ok())
+ .with_description(description);
+}
+
+pub fn validate_babbage(mtx_b: &BabbageMintedTx) -> Validations {
+ let out = Validations::new().add_new_validation(validate_babbage_ins_not_empty(&mtx_b));
+ out
+}
diff --git a/napi-pallas/src/validations/byron.rs b/napi-pallas/src/validations/byron.rs
new file mode 100644
index 0000000..78cd641
--- /dev/null
+++ b/napi-pallas/src/validations/byron.rs
@@ -0,0 +1,6 @@
+use crate::Validations;
+use pallas::ledger::primitives::byron::MintedTxPayload;
+pub fn validate_byron(mtxp: &MintedTxPayload) -> Validations {
+ let out = Validations::new();
+ out
+}
diff --git a/napi-pallas/src/validations/conway.rs b/napi-pallas/src/validations/conway.rs
new file mode 100644
index 0000000..fa1ca30
--- /dev/null
+++ b/napi-pallas/src/validations/conway.rs
@@ -0,0 +1,7 @@
+use pallas::ledger::primitives::conway::MintedTx;
+
+use crate::Validations;
+pub fn validate_conway(mtx_c: &MintedTx) -> Validations {
+ let out = Validations::new();
+ out
+}
diff --git a/napi-pallas/src/validations/mod.rs b/napi-pallas/src/validations/mod.rs
new file mode 100644
index 0000000..2b1fe12
--- /dev/null
+++ b/napi-pallas/src/validations/mod.rs
@@ -0,0 +1,6 @@
+pub mod alonzo;
+pub mod babbage;
+pub mod byron;
+pub mod conway;
+pub mod shelley_ma;
+pub mod validate;
diff --git a/napi-pallas/src/validations/shelley_ma.rs b/napi-pallas/src/validations/shelley_ma.rs
new file mode 100644
index 0000000..3778f67
--- /dev/null
+++ b/napi-pallas/src/validations/shelley_ma.rs
@@ -0,0 +1,8 @@
+use pallas::ledger::primitives::alonzo::MintedTx;
+
+use crate::Validations;
+
+pub fn validate_shelley_ma(mtx_sma: &MintedTx) -> Validations {
+ let out = Validations::new();
+ out
+}
diff --git a/napi-pallas/src/validations/validate.rs b/napi-pallas/src/validations/validate.rs
new file mode 100644
index 0000000..8a43c6e
--- /dev/null
+++ b/napi-pallas/src/validations/validate.rs
@@ -0,0 +1,31 @@
+use crate::validations::babbage::validate_babbage;
+use crate::Validations;
+
+use pallas::applying::utils::ValidationError;
+use pallas::ledger::traverse::{Era, MultiEraTx};
+
+use super::alonzo::validate_alonzo;
+use super::byron::validate_byron;
+use super::conway::validate_conway;
+use super::shelley_ma::validate_shelley_ma;
+
+pub fn set_description(res: &Result<(), ValidationError>, success: String) -> String {
+ match res {
+ Ok(_) => success,
+ Err(e) => format!("Error {:?}", e),
+ }
+}
+
+pub fn validate(mtx: &MultiEraTx<'_>) -> Validations {
+ match &mtx {
+ MultiEraTx::Byron(mtxp) => validate_byron(&mtxp),
+ MultiEraTx::AlonzoCompatible(mtx_sma, Era::Shelley)
+ | MultiEraTx::AlonzoCompatible(mtx_sma, Era::Allegra)
+ | MultiEraTx::AlonzoCompatible(mtx_sma, Era::Mary) => validate_shelley_ma(&mtx_sma),
+ MultiEraTx::AlonzoCompatible(mtx_a, Era::Alonzo) => validate_alonzo(&mtx_a),
+ MultiEraTx::Babbage(mtx_b) => validate_babbage(&mtx_b),
+ MultiEraTx::Conway(mtx_c) => validate_conway(&mtx_c),
+ // This case is impossible. TODO: Handle error
+ _ => Validations::new(),
+ }
+}
diff --git a/web/app/components.tsx b/web/app/components.tsx
index aad70cb..d305930 100644
--- a/web/app/components.tsx
+++ b/web/app/components.tsx
@@ -1,6 +1,6 @@
import { Attribute, type Section } from "napi-pallas";
import { PropsWithChildren, useState } from "react";
-import { IValidation } from "./routes/tx";
+import { DataProps, IValidation } from "./routes/tx";
export type TopicMeta = {
title: string;
@@ -53,18 +53,37 @@ export const P1 = Paragraph;
export function RootSection(props: {
data: Section;
topics: Record;
+ validations: IValidation[];
}) {
+ const [open, setOpen] = useState(false);
+ const handleClick = () => setOpen(!open);
const topic = getTopicMeta(props.data.topic, props.topics);
+ if (props.data.error)
+ return (
+
+
{topic.description}
+ {props.data.error}
+
+ );
+
return (
- <>
+
+
+
+ {open &&
}
+
{topic.title}
- {!props.data.error && topic.description}
- {!!props.data.error && (
-
- {props.data.error}
-
- )}
{!!props.data.bytes && (
)}
@@ -74,7 +93,7 @@ export function RootSection(props: {
{props.data.children?.map((c) => (
))}
-
+
-
-
- {open &&
}
-
-
-