Workspaces split

.gitignore

@@ -6,8 +6,24 @@ rust/target
 rust/.idea
 binaryen/
 
-rust/core/target/**
-rust/core/Cargo.lock
-rust/wasm/target/**
-rust/wasm/Cargo.lock
-rust/json-gen-split/target/**
+target/
+
+core/target/**
+core/Cargo.lock
+
+crypto/target/**
+crypto/Cargo.lock
+
+wasm/target/**
+wasm/Cargo.lock
+
+cip25/target/**
+cip25/Cargo.lock
+
+cip25-wasm/target/**
+cip25-wasm/Cargo.lock
+
+json-gen-split/target/**
+
+cip25-json-gen/target/**
+

Cargo.toml

@@ -0,0 +1,10 @@
+[workspace]
+
+# this is for the new crate structure. The legacy code (current CML) still resides in the `rust` directory.
+members = [
+    "core",
+    "crypto",
+    "cip25",
+    "cip25-wasm",
+    "wasm"
+]

README.md

@@ -21,3 +21,7 @@ We recommend using Ionic + Capacitor or an equivalent setup to have the WASM bin
 ## Documentation
 
 TODO
+
+# Crate Architecture
+
+For current users, the `rust/ `crate is the main version of CML and is the only one that should be used. There is a workspace in the root directory with crates like `core`, `wasm` etc, which are a part of a big refactor and will eventually replace the rust crate at some point in the future, but are still quite WIP for now. The rust crate when used for WASM builds via the npm scripts in the root repo dir will utilize the `rust/json-gen` crate here in the build scripts to generate typescript definitions for the JSON conversion. The `json-gen-split` crate is the equivalent for the new `core`/`wasm` crates and is not called anywhere from the build scripts, but will someday replace the `rust/json-gen` crate once the refactoring is completed.

chain/Cargo.toml

@@ -0,0 +1,54 @@
+[package]
+name = "cardano-multiplatform-lib-chain"
+version = "0.1.0"
+edition = "2018"
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[dependencies]
+cardano-multiplatform-lib-core = { "path" = "../core" }
+cardano-multiplatform-lib-crypto = { "path" = "../crypto" }
+cbor_event = "2.2.0"
+linked-hash-map = "0.5.3"
+derivative = "2.2.0"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0.57"
+schemars = "0.8.8"
+
+bech32 = "0.7.2"
+hex = "0.4.0"
+itertools = "0.10.1"
+getrandom = { version = "0.2.3", features = ["js"] }
+rand = "0.8.5"
+fraction = "0.10.0"
+base64 = "0.13"
+num-bigint = "0.4.0"
+num-integer = "0.1.45"
+#rand_os = "0.1"
+thiserror = "1.0.37"
+# These can be removed if we make wasm bindings for ALL functionality here.
+# This was not done right now as there is a lot of existing legacy code e.g.
+# for Byron that might need to be used from WASM and might not.
+# We can remove this dependency when that is decided.
+#
+# The other use-case here is enums. Without this two enums would need to be defined
+# despite wasm_bindgen supporting C-style enums (with non-negative values) 100%
+# This could possibly be resolved with macros but maybe not.
+
+# non-wasm
+#[target.'cfg(not(all(target_arch = "wasm32", not(target_os = "emscripten"))))'.dependencies]
+#rand_os = "0.1"
+#noop_proc_macro = "0.3.0"
+
+# wasm
+#[target.'cfg(all(target_arch = "wasm32", not(target_os = "emscripten")))'.dependencies]
+wasm-bindgen = { version = "=0.2.82", features = ["serde-serialize"] }
+#rand_os = { version = "0.1", features = ["wasm-bindgen"] }
+#js-sys = "=0.3.59"
+
+
+[dev-dependencies]
+quickcheck = "0.9.2"
+quickcheck_macros = "0.9.1"
+rand_chacha = "0.3.1"

chain/README.md

@@ -0,0 +1,4 @@
+# Chain
+
+This is the core cardano-multiplatform-lib crate for all on-chain data types.
+This was generated from the `specs/babbage/` CDDL specs using cddl-codegen.

chain/src/block.rs

@@ -1,3 +1,5 @@
+use super::*;
+
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
 pub struct Block {
     pub header: Header,

chain/src/cbor_encodings.rs

@@ -1,4 +1,8 @@
 use super::*;
+use cardano_multiplatform_lib_core::{
+    serialization::{LenEncoding, StringEncoding},
+};
+use cbor_event::Sz;
 
 #[derive(Clone, Debug, Default)]
 pub struct AddressEncoding {
@@ -65,13 +69,6 @@ pub struct BlockEncoding {
     pub invalid_transactions_elem_encodings: Vec<Option<cbor_event::Sz>>,
 }
 
-#[derive(Clone, Debug, Default)]
-pub struct BootstrapWitnessEncoding {
-    pub len_encoding: LenEncoding,
-    pub chain_code_encoding: StringEncoding,
-    pub attributes_encoding: StringEncoding,
-}
-
 #[derive(Clone, Debug, Default)]
 pub struct ConstrPlutusDataEncoding {
     pub len_encoding: LenEncoding,
@@ -175,16 +172,6 @@ pub struct Ipv6Encoding {
     pub inner_encoding: StringEncoding,
 }
 
-#[derive(Clone, Debug, Default)]
-pub struct KesSignatureEncoding {
-    pub inner_encoding: StringEncoding,
-}
-
-#[derive(Clone, Debug, Default)]
-pub struct KesVkeyEncoding {
-    pub inner_encoding: StringEncoding,
-}
-
 #[derive(Clone, Debug, Default)]
 pub struct MoveInstantaneousRewardEncoding {
     pub len_encoding: LenEncoding,
@@ -204,13 +191,6 @@ pub struct MultiHostNameEncoding {
     pub index_0_encoding: Option<cbor_event::Sz>,
 }
 
-#[derive(Clone, Debug, Default)]
-pub struct Nonce1Encoding {
-    pub len_encoding: LenEncoding,
-    pub index_0_encoding: Option<cbor_event::Sz>,
-    pub bytes_encoding: StringEncoding,
-}
-
 #[derive(Clone, Debug, Default)]
 pub struct OperationalCertEncoding {
     pub len_encoding: LenEncoding,
@@ -393,16 +373,6 @@ pub struct ShelleyTxOutEncoding {
     pub len_encoding: LenEncoding,
 }
 
-#[derive(Clone, Debug, Default)]
-pub struct SignatureEncoding {
-    pub inner_encoding: StringEncoding,
-}
-
-#[derive(Clone, Debug, Default)]
-pub struct SignkeyKESEncoding {
-    pub inner_encoding: StringEncoding,
-}
-
 #[derive(Clone, Debug, Default)]
 pub struct SingleHostAddrEncoding {
     pub len_encoding: LenEncoding,
@@ -537,25 +507,3 @@ pub struct ValueEncoding {
     pub multiasset_encoding: LenEncoding,
     pub multiasset_value_encodings: BTreeMap<PolicyId, (LenEncoding, BTreeMap<AssetName, Option<cbor_event::Sz>>)>,
 }
-
-#[derive(Clone, Debug, Default)]
-pub struct VkeyEncoding {
-    pub pubkey_bytes_encoding: StringEncoding,
-}
-
-#[derive(Clone, Debug, Default)]
-pub struct VkeywitnessEncoding {
-    pub len_encoding: LenEncoding,
-}
-
-#[derive(Clone, Debug, Default)]
-pub struct VrfCertEncoding {
-    pub len_encoding: LenEncoding,
-    pub index_0_encoding: StringEncoding,
-    pub bytes_encoding: StringEncoding,
-}
-
-#[derive(Clone, Debug, Default)]
-pub struct VrfVkeyEncoding {
-    pub inner_encoding: StringEncoding,
-}

chain/src/lib.rs

@@ -1,40 +1,49 @@
 use std::io::{BufRead, Seek, Write};
-pub use error::*;
 
-// This library was code-generated using an experimental CDDL to rust tool:
-// https://github.com/dcSpark/cddl-codegen
 
 use cbor_event::{self, de::Deserializer, se::Serializer};
-
 use cbor_event::Type as CBORType;
-
 use cbor_event::Special as CBORSpecial;
-
-use serialization::*;
-
 use std::collections::BTreeMap;
-
 use std::convert::{From, TryFrom};
-use schemars::JsonSchema;
-
-#[macro_use]
-extern crate cfg_if;
-
-pub mod error;
 
 pub mod serialization;
 
-pub mod ordered_hash_map;
-
-pub mod chain_core;
-pub mod chain_crypto;
-pub mod impl_mockchain;
 //pub mod legacy_address;
-pub mod typed_bytes;
-
-use ordered_hash_map::OrderedHashMap;
 
-use cbor_event::{Sz, LenSz, StringLenSz};
+pub use cardano_multiplatform_lib_core::{
+    ordered_hash_map::OrderedHashMap,
+    error::{DeserializeError, DeserializeFailure},
+    serialization::{Serialize, Deserialize, StringEncoding, LenEncoding},
+};
+
+use cardano_multiplatform_lib_crypto::{
+    BootstrapWitness,
+    KesSignature,
+    KesVkey,
+    Nonce,
+    SignkeyKES,
+    Vkey,
+    Vkeywitness,
+    VrfCert,
+    VrfVkey,
+    // auto-gened hashes/sigs:
+    Ed25519Signature,
+    Ed25519KeyHash,
+    ScriptHash,
+    TransactionHash,
+    GenesisDelegateHash,
+    GenesisHash,
+    AuxiliaryDataHash,
+    PoolMetadataHash,
+    VRFKeyHash,
+    BlockBodyHash,
+    BlockHeaderHash,
+    DataHash,
+    ScriptDataHash,
+    VRFVKey,
+    KESVKey,
+};
 
 pub mod cbor_encodings;
 
@@ -44,6 +53,9 @@ extern crate derivative;
 
 pub(crate) use derivative::Derivative;
 
+// This library was code-generated using an experimental CDDL to rust tool:
+// https://github.com/dcSpark/cddl-codegen
+
 // TODO: for regen, change babbage's cddl to have our own names in the first place
 pub type AddrKeyhash = Ed25519KeyHash;
 
@@ -200,9 +212,9 @@ pub mod certs;
 pub use certs::*;
 
 
-pub mod crypto;
+//pub mod crypto;
 
-pub use crypto::*;
+//pub use crypto::*;
 
 
 pub mod metadata;
@@ -346,22 +358,6 @@ impl NetworkId {
     }
 }
 
-#[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
-pub struct Nonce1 {
-    pub bytes: Vec<u8>,
-    #[serde(skip)]
-    pub encodings: Option<Nonce1Encoding>,
-}
-
-impl Nonce1 {
-    pub fn new(bytes: Vec<u8>) -> Self {
-        Self {
-            bytes,
-            encodings: None,
-        }
-    }
-}
-
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
 pub struct PositiveInterval {
     #[serde(skip)]
@@ -628,22 +624,4 @@ impl Value {
             encodings: None,
         }
     }
-}
-
-#[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
-pub struct Vkeywitness {
-    pub vkey: Vkey,
-    pub signature: Ed25519Signature,
-    #[serde(skip)]
-    pub encodings: Option<VkeywitnessEncoding>,
-}
-
-impl Vkeywitness {
-    pub fn new(vkey: Vkey, signature: Ed25519Signature) -> Self {
-        Self {
-            vkey,
-            signature,
-            encodings: None,
-        }
-    }
 }

chain/src/metadata.rs

@@ -1,3 +1,5 @@
+use super::*;
+
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
 pub struct AlonzoAuxData {
     pub key_0: Option<Metadata>,

chain/src/plutus.rs

@@ -1,3 +1,5 @@
+use super::*;
+
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema, Derivative)]
 #[derivative(Eq, PartialEq, Ord, PartialOrd, Hash)]
 pub struct BigInt {