Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new interim governance commands: {create, answer, verify}-poll #5050

Closed
wants to merge 10 commits into from
Closed

Add new interim governance commands: {create, answer, verify}-poll #5050

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1a7ff28
Expose bytes and text limit constraints on metadata value.
KtorZ Apr 6, 2023
ac4e13d
Add 'meta{Bytes,Text}chunks helper smart-constructors for TxMetadataV…
KtorZ Apr 6, 2023
03ec89d
Define new Governance.Poll types and high-level interface
KtorZ Apr 6, 2023
8f51170
Implement (de)serialization methods for GovernancePoll objects
KtorZ Apr 6, 2023
346e175
Define commands behavior for {create,answer,verify}-poll
KtorZ Apr 6, 2023
9f6f09c
Wire newly introduce governance commands in the CLI
KtorZ Apr 6, 2023
9e63ec9
Introduce a new test helper function: tryExecCardanoCLI
KtorZ Apr 6, 2023
d6a1f63
Write automated tests to cover newly introduced SPO on-chain poll com…
KtorZ Apr 6, 2023
4ed6fac
Add roundtrip serialization property tests for GovernancePoll{Answer,…
KtorZ Apr 14, 2023
160f67b
Add property tests for 'chunks', and fix 'metaTextChunks'
KtorZ Apr 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions cardano-api/src/Cardano/Api/TxMetadata.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ module Cardano.Api.TxMetadata (
-- * Constructing metadata
TxMetadataValue(..),
makeTransactionMetadata,
metaTextChunks,
metaBytesChunks,

-- * Validating metadata
validateTxMetadata,
Expand Down Expand Up @@ -127,6 +129,25 @@ instance SerialiseAsCBOR TxMetadata where
makeTransactionMetadata :: Map Word64 TxMetadataValue -> TxMetadata
makeTransactionMetadata = TxMetadata

-- | Create a 'TxMetadataValue' from a 'Text' as a list of chunks of an
-- acceptable size.
metaTextChunks :: Text -> TxMetadataValue
metaTextChunks =
TxMetaList . chunks
txMetadataTextStringMaxByteLength
TxMetaText
(BS.length . Text.encodeUtf8)
Text.splitAt

-- | Create a 'TxMetadataValue' from a 'ByteString' as a list of chunks of an
-- accaptable size.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo accaptable

metaBytesChunks :: ByteString -> TxMetadataValue
metaBytesChunks =
TxMetaList . chunks
txMetadataByteStringMaxLength
TxMetaBytes
BS.length
BS.splitAt
KtorZ marked this conversation as resolved.
Show resolved Hide resolved

-- ----------------------------------------------------------------------------
-- Internal conversion functions
Expand Down Expand Up @@ -160,6 +181,26 @@ fromShelleyMetadatum (Shelley.Map xs) = TxMetaMap
fromShelleyMetadatum v)
| (k,v) <- xs ]

-- | Transform a string-like structure into chunks with a maximum size; Chunks
-- are filled from left to right.
chunks
:: Int
-- ^ Chunk max size (inclusive)
-> (str -> chunk)
-- ^ Hoisting
-> (str -> Int)
-- ^ Measuring
-> (Int -> str -> (str, str))
-- ^ Splitting
-> str
-- ^ String
-> [chunk]
chunks maxLength strHoist strLength strSplitAt str
| strLength str > maxLength =
let (h, t) = strSplitAt maxLength str
in strHoist h : chunks maxLength strHoist strLength strSplitAt t
| otherwise =
[strHoist str]

-- ----------------------------------------------------------------------------
-- Validate tx metadata
Expand Down