request and API drafts

Author: dr-orlovsky

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace]
-members = [".", "inmem"]
-default-members = [".", "inmem"]
+members = [".", "inmem", "request"]
+default-members = [".", "inmem", "request"]
 
 [workspace.package]
 version = "0.12.0-alpha.1"
@@ -15,8 +15,8 @@ rust-version = "1.77.0" # Due to `rustfix`
 
 [workspace.dependencies]
 amplify = "~4.8.0"
-strict_encoding = "~2.8.0"
-strict_types = "~2.8.0"
+strict_encoding = "~2.8.1"
+strict_types = "~2.8.1"
 aluvm = "0.12.0-beta.2"
 ultrasonic = "0.12.0-beta.1"
 serde = { version = "1", features = ["derive"] }
@@ -41,7 +41,7 @@ name = "sonare"
 
 [dependencies]
 amplify.workspace = true
-baid64 = "0.3.0"
+baid64 = "0.4.0"
 strict_encoding.workspace = true
 strict_types.workspace = true
 commit_verify = "0.12.0-alpha.3"
@@ -72,3 +72,6 @@ wasm-bindgen-test = "0.3"
 
 [package.metadata.docs.rs]
 features = ["all"]
+
+[patch.crates-io]
+ultrasonic = { git = "https://github.com/AluVM/ultrasonic" }

Cargo.toml

@@ -31,12 +31,10 @@
 //! persistence solution adapted for enterprise needs.
 
 use amplify::confinement::{SmallOrdMap, SmallVec, TinyOrdMap};
-use sonare::{StateTy, StructData};
+use sonare::api::ApiId;
+use sonare::state::{StateTy, StructData};
 use ultrasonic::{CellAddr, StateCell, StateData};
 
-// TODO: Remove temporary type
-pub type IfaceId = u128;
-
 /// The state as it is defined in the contract. Accessed during the validation.
 pub struct RawState {
     pub append_only: SmallOrdMap<CellAddr, StateData>,
@@ -65,7 +63,7 @@ pub struct MemState {
     ///
     /// When more API adaptors are added, these values are either lazy computed - or computed in a
     /// background task.
-    pub converted: TinyOrdMap<IfaceId, ConvertedState>,
+    pub converted: TinyOrdMap<ApiId, ConvertedState>,
 
     /// Index for resolving state types into values.
     pub index: StateIndex,

inmem/src/state.rs

@@ -0,0 +1,28 @@
+[package]
+name = "sonare-request"
+version.workspace = true
+authors.workspace = true
+description = "SONARE request builders and parsers"
+repository.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+categories = ["algorithms", "cryptography", "science", "no-std"]
+readme.workspace = true
+license.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+exclude = [".github"]
+
+[dependencies]
+amplify.workspace = true
+strict_encoding.workspace = true
+strict_types.workspace = true
+ultrasonic.workspace = true
+sonare = { version = "0.12.0-alpha.1", path = ".." }
+serde = { workspace = true, optional = true }
+
+[features]
+default = ["std"]
+all = ["std"]
+
+std = []

request/Cargo.toml

@@ -0,0 +1,44 @@
+// SONARE: Runtime environment for formally-verifiable distributed software
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// Designed in 2019-2024 by Dr Maxim Orlovsky <[email protected]>
+// Written in 2024-2025 by Dr Maxim Orlovsky <[email protected]>
+//
+// Copyright (C) 2019-2025 LNP/BP Standards Association, Switzerland.
+// Copyright (C) 2024-2025 Laboratories for Ubiquitous Deterministic Computing (UBIDECO),
+//                         Institute for Distributed and Cognitive Systems (InDCS), Switzerland.
+// Copyright (C) 2019-2025 Dr Maxim Orlovsky.
+// All rights under the above copyrights are reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License. You may obtain a copy of the License at
+//
+//        http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software distributed under the License
+// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+// or implied. See the License for the specific language governing permissions and limitations under
+// the License.
+
+use amplify::confinement::{TinyString, TinyVec};
+use strict_types::StrictVal;
+use ultrasonic::{ContractId, ProofOfPubl};
+
+pub trait SonareProtocol {
+    const URL_SCHEME: &'static str;
+    type PoP: ProofOfPubl;
+}
+
+pub struct Request<S: SonareProtocol> {
+    pub pop: S::PoP,
+    pub contract_id: Option<ContractId>,
+    pub interface: Option<TinyString>,
+    pub method: Option<TinyString>,
+    pub args: TinyVec<RequestArg>,
+}
+
+pub struct RequestArg {
+    pub name: TinyString,
+    pub value: StrictVal,
+}

request/src/data.rs

@@ -0,0 +1,32 @@
+// SONARE: Runtime environment for formally-verifiable distributed software
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// Designed in 2019-2024 by Dr Maxim Orlovsky <[email protected]>
+// Written in 2024-2025 by Dr Maxim Orlovsky <[email protected]>
+//
+// Copyright (C) 2019-2025 LNP/BP Standards Association, Switzerland.
+// Copyright (C) 2024-2025 Laboratories for Ubiquitous Deterministic Computing (UBIDECO),
+//                         Institute for Distributed and Cognitive Systems (InDCS), Switzerland.
+// Copyright (C) 2019-2025 Dr Maxim Orlovsky.
+// All rights under the above copyrights are reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License. You may obtain a copy of the License at
+//
+//        http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software distributed under the License
+// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+// or implied. See the License for the specific language governing permissions and limitations under
+// the License.
+
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(not(feature = "std"), no_std)]
+
+//! _Request_ (or _transaction request_) is a specification on constructing a transaction for a
+//! SONARE contract.
+
+mod data;
+
+extern crate alloc;

request/src/lib.rs

@@ -0,0 +1,53 @@
+// SONARE: Runtime environment for formally-verifiable distributed software
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// Designed in 2019-2024 by Dr Maxim Orlovsky <[email protected]>
+// Written in 2024-2025 by Dr Maxim Orlovsky <[email protected]>
+//
+// Copyright (C) 2019-2025 LNP/BP Standards Association, Switzerland.
+// Copyright (C) 2024-2025 Laboratories for Ubiquitous Deterministic Computing (UBIDECO),
+//                         Institute for Distributed and Cognitive Systems (InDCS), Switzerland.
+// Copyright (C) 2019-2025 Dr Maxim Orlovsky.
+// All rights under the above copyrights are reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License. You may obtain a copy of the License at
+//
+//        http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software distributed under the License
+// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+// or implied. See the License for the specific language governing permissions and limitations under
+// the License.
+
+use aluvm::LibSite;
+
+use super::{ApiVm, ApiVmType, StateArithm};
+use crate::state::StructData;
+
+impl ApiVm for aluvm::Vm {
+    const TYPE: ApiVmType = ApiVmType::AluVM;
+    type Arithm = AluVMArithm;
+    type ReaderSite = LibSite;
+    type AdaptorSite = LibSite;
+}
+
+pub struct AluVMArithm {
+    pub vm: Option<aluvm::Vm>,
+    pub accumulate: LibSite,
+    pub lessen: LibSite,
+    pub diff: LibSite,
+}
+
+impl StateArithm for AluVMArithm {
+    type Site = LibSite;
+
+    fn measure(&self, state: StructData) -> Option<u8> { todo!() }
+
+    fn accumulate(&mut self, state: StructData) -> Option<()> { todo!() }
+
+    fn lessen(&mut self, state: StructData) -> Option<()> { todo!() }
+
+    fn diff(&self) -> Option<StructData> { todo!() }
+}