Skip to content

Update GenRustJets to generate Bitcoin Jets #322

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

Closed
roconnor-blockstream wants to merge 1 commit into from
Closed

Update GenRustJets to generate Bitcoin Jets #322

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
128 changes: 74 additions & 54 deletions Haskell-Generate/GenRustJets.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import Data.Char (toLower)
import Data.Foldable (toList)
import Data.Function (on)
import Data.Functor.Fixedpoint (Fix(..))
import Data.List (sortBy)
import Data.List (nubBy, sortBy)
import Data.List.Split (chunksOf)
import Data.Maybe (fromMaybe)
import qualified Data.Map as Map
Expand Down Expand Up @@ -47,7 +47,14 @@ sortJetName = sortBy (compare `on` name)
where
name (SomeArrow j) = jetName j

cJetName = lowerSnakeCase . jetName
rustJetName :: JetData x y -> String
rustJetName jd = lowerSnakeCase (jetName jd)

cJetName :: JetData x y -> String
cJetName jd = prefix (jetModule jd) ++ lowerSnakeCase (jetName jd)
where
prefix BitcoinModule = "bitcoin_"
prefix _ = ""

coreJetData :: (TyC x, TyC y) => CoreJet x y -> JetData x y
coreJetData jet = JetData { jetName = mkName jet
Expand Down Expand Up @@ -88,6 +95,7 @@ moduleJets = sortJetName . toList . moduleCodes

rustModuleName = fromMaybe "Core" . moduleName
lowerRustModuleName = map toLower . rustModuleName
moduleEnvType mod = lowerRustModuleName mod ++ "::CTxEnv, "

coreModule :: Module
coreModule = Module Nothing (someArrowMap coreJetData <$> (treeEvalBitStream Core.getJetBit))
Expand All @@ -101,6 +109,11 @@ elementsModule = Module (Just "Elements") (someArrowMap elementsJetData <$> take
bitcoinModule :: Module
bitcoinModule = Module (Just "Bitcoin") (someArrowMap bitcoinJetData <$> takeRight (treeEvalBitStream Bitcoin.getJetBit))

allJets :: [SomeArrow JetData]
allJets = nubBy eqJet . sortJetName $ moduleJets =<< [bitcoinModule, elementsModule]
where
eqJet (SomeArrow jt1) (SomeArrow jt2) = jetName jt1 == jetName jt2 && jetModule jt1 == jetModule jt2

data CompactTy = CTyOne
| CTyWord Int
| CTyMaybe CompactTy
Expand Down Expand Up @@ -191,16 +204,14 @@ rustJetTargetTy = rustJetTy "target_ty" (\(SomeArrow jet) -> unreflect (snd (rei
rustJetPtr :: Module -> Doc a
rustJetPtr mod = vsep $
[ nest 4 (vsep ("fn c_jet_ptr(&self) -> &dyn Fn(&mut CFrameItem, CFrameItem, &Self::CJetEnvironment) -> bool {" :
if modname == "Bitcoin"
then ["unimplemented!(\"Bitcoin jets have not yet been implemented.\")"]
else [ nest 4 (vsep ("match self {" :
map (<>comma)
[ pretty modname <> "::" <> pretty (jetName jet) <+> "=>" <+>
pretty ("&simplicity_sys::c_jets::jets_wrapper::"++cJetName jet)
| SomeArrow jet <- moduleJets mod
]))
, "}"
]))
[ nest 4 (vsep ("match self {" :
map (<>comma)
[ pretty modname <> "::" <> pretty (jetName jet) <+> "=>" <+>
pretty ("&simplicity_sys::c_jets::jets_wrapper::"++cJetName jet)
| SomeArrow jet <- moduleJets mod
]))
, "}"
]))
, "}"
]
where
Expand Down Expand Up @@ -265,23 +276,26 @@ rustJetImpl mod = vsep $
where
modname = rustModuleName mod
env = vsep
[ pretty $ "type Environment = "++env++";"
[ pretty $ "type Transaction = "++transaction++";"
, pretty $ "type Environment<T> = "++env++"<T> where T: Borrow<Self::Transaction>;"
, pretty $ "type CJetEnvironment = "++cEnv++";"
, ""
, pretty $ "fn c_jet_env("++envArg++": &Self::Environment) -> &Self::CJetEnvironment {"
, pretty $ "fn c_jet_env<T>("++envArg++": &Self::Environment<T>) -> &Self::CJetEnvironment"
, " where T: Borrow<Self::Transaction>"
, "{"
, pretty $ " "++envBody
, "}"
]
where
env | Nothing <- moduleName mod = "()"
| Just "Elements" == moduleName mod = "ElementsEnv<std::sync::Arc<elements::Transaction>>"
transaction | Nothing <- moduleName mod = "core::convert::Infallible"
| Just name <- moduleName mod = map toLower name ++"::Transaction"
env | Nothing <- moduleName mod = "CoreEnv"
| Just name <- moduleName mod = name ++ "Env"
cEnv | Just "Elements" == moduleName mod = "CElementsTxEnv"
| otherwise = "()"
envArg | Just "Bitcoin" == moduleName mod = "_env"
cEnv | Nothing <- moduleName mod = "CoreEnv<Self::Transaction>"
| otherwise = "CTxEnv"
envArg | Nothing <- moduleName mod = "_"
| otherwise = "env"
envBody | Nothing == moduleName mod = "env"
| Just "Bitcoin" == moduleName mod = "unimplemented!(\"Unspecified CJetEnvironment for Bitcoin jets\")"
envBody | Nothing <- moduleName mod = "&CoreEnv::EMPTY"
| otherwise = "env.c_tx_env()"

rustJetEnum :: Module -> Doc a
Expand Down Expand Up @@ -311,7 +325,7 @@ rustJetDisplay mod =
nestBraces ("match self" <+>
nestBraces (vsep (
map (<>comma)
[ pretty modname <> "::" <> pretty (jetName jet) <+> "=> f.write_str" <> (parens . dquotes . pretty $ cJetName jet)
[ pretty modname <> "::" <> pretty (jetName jet) <+> "=> f.write_str" <> (parens . dquotes . pretty $ rustJetName jet)
| SomeArrow jet <- moduleJets mod
]))
)
Expand All @@ -329,7 +343,7 @@ rustJetFromStr mod =
nestBraces ("match s" <+>
nestBraces (vsep (
map (<> comma)
([ dquotes (pretty (cJetName jet)) <+> "=> Ok" <> parens (pretty modname <> "::" <> pretty (jetName jet))
([ dquotes (pretty (rustJetName jet)) <+> "=> Ok" <> parens (pretty modname <> "::" <> pretty (jetName jet))
| SomeArrow jet <- moduleJets mod
] ++ [ "x => Err(crate::Error::InvalidJetName(x.to_owned()))" ]
)))
Expand All @@ -352,14 +366,13 @@ rustImports mod = vsep (map (<> semi)
, "use hashes::sha256::Midstate"
, "use simplicity_sys::CFrameItem"
, "use std::io::Write"
, "use std::{fmt, str}"
, "use std::{borrow::Borrow, fmt, str}"
] ++ envImports))
where
envImports | Nothing == moduleName mod = []
| Just "Bitcoin" == moduleName mod = ["use crate::jet::bitcoin::BitcoinEnv"]
envImports | Nothing == moduleName mod = ["use crate::jet::core::CoreEnv"]
| Just name <- moduleName mod =
[ pretty $ "use crate::jet::"++map toLower name++"::"++name++"Env"
, pretty $ "use simplicity_sys::C"++name++"TxEnv"
, pretty $ "use simplicity_sys::"++map toLower name++"::CTxEnv"
]

rustJetDoc :: Module -> SimpleDocStream a
Expand All @@ -375,14 +388,16 @@ rustJetDoc mod = layoutPretty layoutOptions $ vsep (map (<> line)
rustFFIImports :: Doc a
rustFFIImports = vsep (map (<> semi)
[ "use crate::ffi::c_void"
, "use crate::{CElementsTxEnv, CFrameItem}"
, "use crate::bitcoin"
, "use crate::elements"
, "use crate::CFrameItem"
])

rustFFISigs :: Module -> Doc a
rustFFISigs mod = vsep
rustFFISigs :: Doc a
rustFFISigs = vsep
[ nest 4 $ vsep $
"extern \"C\" {" :
(declaration <$> moduleJets mod)
(declaration <$> allJets)
, "}"
]
where
Expand All @@ -394,63 +409,68 @@ rustFFISigs mod = vsep
linkName = "#[link_name = \"c_"++cJetName jet++"\"]"
signature = "pub fn "++cJetName jet++"(dst: *mut CFrameItem, src: *const CFrameItem, env: *const "++envType++") -> bool"
envType | CoreModule <- jetModule jet = "c_void"
| ElementsModule <- jetModule jet = "CElementsTxEnv"
| ElementsModule <- jetModule jet = "elements::CTxEnv"
| BitcoinModule <- jetModule jet = "bitcoin::CTxEnv"

rustFFIDoc :: Module -> SimpleDocStream a
rustFFIDoc mod = layoutPretty layoutOptions $ vsep (map (<> line)
rustFFIDoc :: SimpleDocStream a
rustFFIDoc = layoutPretty layoutOptions $ vsep (map (<> line)
[ rustHeader
, rustFFIImports
, rustFFISigs mod
, rustFFISigs
])

rustWrapperImports :: Doc a
rustWrapperImports = vsep (map (<> semi)
[ "use crate::{CElementsTxEnv, CFrameItem}"
, "use super::elements_ffi"
[ "use crate::bitcoin"
, "use crate::elements"
, "use crate::CFrameItem"
, "use super::jets_ffi"
])

rustWrappers :: Module -> Doc a
rustWrappers mod = vsep ((<> line) . wrapper <$> moduleJets mod)
rustWrappers :: Doc a
rustWrappers = vsep ((<> line) . wrapper <$> allJets)
where
wrapper (SomeArrow jet) = vsep
[ nest 4 $ vsep
[ pretty $ "pub fn "++cJetName jet++templateParam++"(dst: &mut CFrameItem, src: CFrameItem, "++envParam++") -> bool {"
, pretty $ "unsafe { "++lowerRustModuleName mod++"_ffi::"++cJetName jet++"(dst, &src, "++envArg++") }"
, pretty $ "unsafe { jets_ffi::"++cJetName jet++"(dst, &src, "++envArg++") }"
]
, "}"
]
where
templateParam | CoreModule <- jetModule jet = "<T>"
| otherwise = ""
envParam | CoreModule <- jetModule jet = "_env: &T"
| ElementsModule <- jetModule jet = "env: &CElementsTxEnv"
| ElementsModule <- jetModule jet = "env: &elements::CTxEnv"
| BitcoinModule <- jetModule jet = "env: &bitcoin::CTxEnv"
envArg | CoreModule <- jetModule jet = "std::ptr::null()"
| ElementsModule <- jetModule jet = "env"
| otherwise = "env"

rustWrapperDoc :: Module -> SimpleDocStream a
rustWrapperDoc mod = layoutPretty layoutOptions $ vsep (map (<> line)
rustWrapperDoc :: SimpleDocStream a
rustWrapperDoc = layoutPretty layoutOptions $ vsep (map (<> line)
[ rustHeader
, rustWrapperImports
, rustWrappers mod
, rustWrappers
])

cWrapperImports :: Doc a
cWrapperImports = vsep
[ "#include \"simplicity/elements/elementsJets.h\""
[ "#include \"simplicity/bitcoin/bitcoinJets.h\""
, "#include \"simplicity/elements/elementsJets.h\""
, "#include \"simplicity/simplicity_assert.h\""
, "#include \"wrapper.h\""
]

cWrappers :: Module -> Doc a
cWrappers mod = vsep (map wrapper $ moduleJets mod)
cWrappers :: Doc a
cWrappers = vsep (map wrapper $ allJets)
where
wrapper (SomeArrow jet) = pretty $ "WRAP_("++cJetName jet++")"

cWrapperDoc :: Module -> SimpleDocStream a
cWrapperDoc mod = layoutPretty layoutOptions $ vsep (map (<> line)
cWrapperDoc :: SimpleDocStream a
cWrapperDoc = layoutPretty layoutOptions $ vsep (map (<> line)
[ rustHeader -- also works for C
, cWrapperImports
, cWrappers mod
, cWrappers
])

renderFile name doc = withFile name WriteMode (\h -> renderIO h doc)
Expand All @@ -459,8 +479,8 @@ main = do
renderFile "core.rs" (rustJetDoc coreModule)
renderFile "elements.rs" (rustJetDoc elementsModule)
renderFile "bitcoin.rs" (rustJetDoc bitcoinModule)
renderFile "jets_ffi.rs" (rustFFIDoc elementsModule)
renderFile "jets_wrapper.rs" (rustWrapperDoc elementsModule)
renderFile "jets_wrapper.c" (cWrapperDoc elementsModule)
renderFile "jets_ffi.rs" rustFFIDoc
renderFile "jets_wrapper.rs" rustWrapperDoc
renderFile "jets_wrapper.c" cWrapperDoc

layoutOptions = LayoutOptions { layoutPageWidth = AvailablePerLine 100 1 }
Loading