Docs Update #307
Closed
Docs Update #307
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rooooooooob
commented
Feb 6, 2024
| @@ -417,6 +417,13 @@ macro_rules! impl_wasm_cbor_api { | |||
| cml_core::serialization::Serialize::to_cbor_bytes(&self.0) | |||
| } | |||
|
|
|||
| /** | |||
| * Serialize this type to CBOR bytes using canonical CBOR encodings | |||
| */ | |||
There was a problem hiding this comment.
I added this to all the types that support preserve-encodings/etc as we expose it in rust and it can't hurt to expose it. I used it in the cbor docs example.
One small possible inconsistency is that it's not added to the byron/cip25 types as we can't guarantee anything implementing cbor_event::Serialize will do it canonically or not. The comment for to_cbor_bytes() on those types does mention that the format may or may not be canonical.
rooooooooob
added a commit
that referenced
this pull request
Mar 1, 2024
Rust and WASM crates for creating tx builders from blockfrost. The rust crate can be directly used with the `blockfrost` crate when the feature `direct_api` is enabled. If it is not then various parsing ability is still exposed for cost models. The WASM crate due to technical restrictions just exposes an endpoint that takes in the response JSON and creates the config. the cml/wasm crate exports this new `cml-blockfrost-wasm` functionality which only increased compiled size from 896kb -> 911kb so should be fine to include by default. TODO: some documentation but this would conflict with #307's documentation update so can be done at a later date.
* feat: add native-script verify function
Due to changes here: IntersectMBO/cardano-ledger#4284 Clarification here: IntersectMBO/cardano-ledger#4383 Allows non-Plutus languages according to the spec and changes to an indexable map type.
* Add documentation + fix acronym names Using dcSpark/cddl-codegen#218 and dcSpark/cddl-codegen#238 Also renames some cert fields to be clear as `coin` was not very helpful. * update multi-era crates too * clippy fix
Fixes #334 Moves RawBytesEncoding to cml_core::serialization as there is nothing specific about crypto with it, and it can be used in many other places (Asset names, plutus scripts, etc). Add wasm macros for declaring the RawBytesEncoding API automatically using the rust type's trait impl Add missing hash() to PlutusV3Script Document AssetName on how to convert to/from using utf8 traits in rust Use dcSpark/cddl-codegen#240 to remove confusing `get()` (what is it getting?) functions on some wrapper types. These are replaced with `RawBytesEncoding` to standardize use with the rest of CML
* Governance Builders Adds `VoteBuilder` and `ProposalBuilder` to facilitate creation of votes and voting proposals to transactions. * Hook Vote/Proposal Builders into TxBuilder/RedeemerBuilder * Fix deposit/required certs * Fix proposal deposits
Somehow `coin` ended up here still after #333 despite being changed to `deposit`.
Rust CML crates must use wasm-bindgen for enums as these are used from the WASM CML crates. Using noop_proc_macro we can replace the wasm_bindgen proc macro with a no-op that does nothing when consumed directly from rust. This is now locked behind a feature (used_from_wasm) as we can't just use cfg target checks as compiling the wasm crate (not using web-pack) would use the rust target and break. Crates using cml-chain and cml-multi-era from a wasm crate must specify this feature to activate the wasm_bindgen dependancy instead of the no-op macro.
* Add support for parsing Shelley genesis blocks * Genesis keyHash alias + minor fixes * Add alias for `ShelleyGenesisCredential::keyHash` to account for cardano-node json format * Remove unnecessary clone() * Change `u64` to `Coin` when appropriate in Genesis types * ran cargo fmt * Update Genesis parsing for changes in #340 --------- Co-authored-by: rooooooooob <rooooooooob@users.noreply.github.com> Co-authored-by: rooooooooob <raftias@gmail.com>
rooooooooob
added a commit
that referenced
this pull request
Jul 25, 2024
Update docs to new crate structure. Adds CBOR and JSON explanations General updates as the docs were very outdated Replaces #307 (same without plutus + messed up git rebase/merges)
rooooooooob
added a commit
that referenced
this pull request
Jul 25, 2024
Based on Aiken's Hello WOrld example. TODO: I couldn't get the redeem contract to be accepted by the network. We need to figure out why and update this example. Replaces the plutus part of #307
Draft
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.