diff --git a/Cargo.lock b/Cargo.lock index f972b0778..d45547a71 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -469,30 +469,21 @@ version = "1.4.0" dependencies = [ "anyhow", "assert_cmd", - "assert_matches", "async-std", "blake2", "cargo_metadata", "clap", "colored", "contract-metadata", + "contract-transcode", "current_platform", "env_logger", - "escape8259", "heck", "hex", "impl-serde", - "indexmap", - "ink_env", - "ink_lang", "ink_metadata", - "ink_primitives", - "ink_storage", - "itertools", "jsonrpsee 0.13.1", "log", - "nom", - "nom-supreme", "pallet-contracts-primitives", "parity-scale-codec", "parity-wasm 0.45.0", @@ -500,12 +491,10 @@ dependencies = [ "pretty_assertions", "regex", "rustc_version", - "scale-info", "semver", "serde", "serde_json", "sp-core", - "sp-runtime", "substrate-build-script-utils", "subxt", "tempfile", @@ -649,6 +638,34 @@ dependencies = [ "url", ] +[[package]] +name = "contract-transcode" +version = "0.6.0" +dependencies = [ + "anyhow", + "assert_matches", + "contract-metadata", + "env_logger", + "escape8259", + "hex", + "indexmap", + "ink_env", + "ink_lang", + "ink_metadata", + "ink_primitives", + "ink_storage", + "itertools", + "log", + "nom", + "nom-supreme", + "parity-scale-codec", + "scale-info", + "serde", + "serde_json", + "sp-core", + "sp-runtime", +] + [[package]] name = "core-foundation" version = "0.9.3" diff --git a/Cargo.toml b/Cargo.toml index 8f3dd44f5..39af0b5b5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [workspace] -members = [".", "metadata"] +members = [".", "metadata", "transcode"] [package] name = "cargo-contract" @@ -39,6 +39,7 @@ toml = "0.5.9" rustc_version = "0.4.0" blake2 = "0.10.4" contract-metadata = { version = "0.6.0", path = "./metadata" } +transcode = { package = "contract-transcode", version = "0.1.0", path = "./transcode" } semver = { version = "1.0.9", features = ["serde"] } serde = { version = "1.0.137", default-features = false, features = ["derive"] } serde_json = "1.0.81" @@ -50,19 +51,11 @@ regex = "1.5.6" # dependencies for extrinsics (deploying and calling a contract) async-std = { version = "1.11.0", features = ["attributes", "tokio1"] } ink_metadata = { version = "3", features = ["derive"] } -ink_env = "3" -scale-info = { version = "2.1.2", default-features = false, features = ["derive"] } sp-core = "6.0.0" -sp-runtime = "6.0.0" pallet-contracts-primitives = "6.0.0" subxt = "0.21.0" hex = "0.4.3" jsonrpsee = { version = "0.13.1", features = ["ws-client"] } -nom = "7.1.1" -nom-supreme = { version = "0.7.0", features = ["error"] } -indexmap = "1.8.2" -escape8259 = "0.5.1" -itertools = "0.10.3" [build-dependencies] anyhow = "1.0.57" @@ -75,16 +68,11 @@ regex = "1.5.6" [dev-dependencies] assert_cmd = "2.0.4" -assert_matches = "1.5.0" pretty_assertions = "1.2.1" wabt = "0.10.0" regex = "1.5.6" predicates = "2.1.1" -ink_primitives = "3" -ink_storage = "3" -ink_lang = "3" - [features] # This `std` feature is required for testing using an inline contract's metadata, because `ink!` annotates the metadata # generation code with `#[cfg(feature = "std")]`. diff --git a/src/cmd/extrinsics/events.rs b/src/cmd/extrinsics/events.rs index 58669f5dc..575a8d0e5 100644 --- a/src/cmd/extrinsics/events.rs +++ b/src/cmd/extrinsics/events.rs @@ -16,10 +16,6 @@ use super::{ runtime_api::api::contracts::events::ContractEmitted, - transcode::{ - ContractMessageTranscoder, - TranscoderBuilder, - }, RuntimeEvent, }; use crate::{ @@ -28,6 +24,10 @@ use crate::{ DEFAULT_KEY_COL_WIDTH, }; use colored::Colorize as _; +use transcode::{ + ContractMessageTranscoder, + TranscoderBuilder, +}; use anyhow::Result; use subxt::{ diff --git a/src/cmd/extrinsics/mod.rs b/src/cmd/extrinsics/mod.rs index 2b5ed065b..4bbe10699 100644 --- a/src/cmd/extrinsics/mod.rs +++ b/src/cmd/extrinsics/mod.rs @@ -18,7 +18,6 @@ mod call; mod events; mod instantiate; mod runtime_api; -mod transcode; mod upload; #[cfg(test)] @@ -54,13 +53,13 @@ use subxt::{ HasModuleError as _, }; -pub use self::transcode::ContractMessageTranscoder; pub use call::CallCommand; pub use instantiate::InstantiateCommand; pub use runtime_api::api::{ DispatchError as RuntimeDispatchError, Event as RuntimeEvent, }; +pub use transcode::ContractMessageTranscoder; pub use upload::UploadCommand; type Balance = u128; diff --git a/transcode/Cargo.toml b/transcode/Cargo.toml new file mode 100644 index 000000000..ad822b670 --- /dev/null +++ b/transcode/Cargo.toml @@ -0,0 +1,49 @@ +[package] +name = "contract-transcode" +version = "0.1.0" +authors = ["Parity Technologies "] +edition = "2021" + +license = "Apache-2.0" +readme = "README.md" +repository = "https://github.com/paritytech/cargo-contract" +documentation = "https://docs.rs/contract-transcode" +homepage = "https://www.substrate.io/" +description = "Library encoding calls for smart contracts on substrate" +keywords = ["wasm", "parity", "webassembly", "blockchain", "edsl"] +include = ["Cargo.toml", "*.rs", "LICENSE"] + +[lib] +path = "src/lib.rs" + +[dependencies] +anyhow = "1.0.57" +contract-metadata = { version = "0.6.0", path = "../metadata" } +env_logger = "0.9.0" +escape8259 = "0.5.1" +hex = "0.4.3" +indexmap = "1.8.1" +ink_env = "3.0" +ink_metadata = { version = "3.0", features = ["derive"] } +itertools = "0.10.3" +log = "0.4.17" +nom = "7.1.1" +nom-supreme = { version = "0.7.0", features = ["error"] } +scale = { package = "parity-scale-codec", version = "3.0.0", features = ["derive"] } +scale-info = { version = "2.1.1", default-features = false, features = ["derive"] } +serde = { version = "1.0.137", default-features = false, features = ["derive"] } +serde_json = "1.0.81" +sp-core = "6.0.0" +sp-runtime = "6.0.0" + +[dev-dependencies] +assert_matches = "1.5.0" +ink_lang = "3" +ink_primitives = "3" +ink_storage = "3" + +[features] +# This `std` feature is required for testing using an inline contract's metadata, because `ink!` annotates the metadata +# generation code with `#[cfg(feature = "std")]`. +default = ["std"] +std = [] \ No newline at end of file diff --git a/transcode/LICENSE b/transcode/LICENSE new file mode 100644 index 000000000..6b0b1270f --- /dev/null +++ b/transcode/LICENSE @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. + diff --git a/transcode/README.md b/transcode/README.md new file mode 100644 index 000000000..1a1c9d5a5 --- /dev/null +++ b/transcode/README.md @@ -0,0 +1,41 @@ +# Contract Transcode + +Contains utilities for encoding smart contract calls to SCALE. + +Currently part of [`cargo-contract`](https://github.com/paritytech/cargo-contract), the build tool for smart + contracts written in [ink!](https://github.com/paritytech/ink). + + +# Example + +```rust +use transcode::ContractMessageTranscoder; + +fn main() { + let metadata_path = "/path/to/metadata.json"; + + let metadata = load_metadata(&metadata_path.into())?; + let transcoder = ContractMessageTranscoder::new(&metadata); + + let constructor = "new"; + let args = ["foo", "bar"]; + let data = transcoder.encode(&constructor, &args).unwrap(); + + println!("Encoded constructor data {:?}", data); +} + +fn load_metadata(path: &Path) -> anyhow::Result { + let file = File::open(&path).expect("Failed to open metadata file"); + let metadata: ContractMetadata = + serde_json::from_reader(file).expect("Failed to deserialize metadata file"); + let ink_metadata = serde_json::from_value(serde_json::Value::Object(metadata.abi)) + .expect("Failed to deserialize ink project metadata"); + + if let ink_metadata::MetadataVersioned::V3(ink_project) = ink_metadata { + Ok(ink_project) + } else { + Err(anyhow!("Unsupported ink metadata version. Expected V3")) + } +} + +``` diff --git a/src/cmd/extrinsics/transcode/decode.rs b/transcode/src/decode.rs similarity index 100% rename from src/cmd/extrinsics/transcode/decode.rs rename to transcode/src/decode.rs diff --git a/src/cmd/extrinsics/transcode/encode.rs b/transcode/src/encode.rs similarity index 100% rename from src/cmd/extrinsics/transcode/encode.rs rename to transcode/src/encode.rs diff --git a/src/cmd/extrinsics/transcode/env_types.rs b/transcode/src/env_types.rs similarity index 99% rename from src/cmd/extrinsics/transcode/env_types.rs rename to transcode/src/env_types.rs index f3135ab63..b00db1ef6 100644 --- a/src/cmd/extrinsics/transcode/env_types.rs +++ b/transcode/src/env_types.rs @@ -15,7 +15,7 @@ // along with cargo-contract. If not, see . use super::scon::Value; -use crate::cmd::extrinsics::transcode::scon::Hex; +use crate::scon::Hex; use anyhow::{ Context, Result, diff --git a/src/cmd/extrinsics/transcode/mod.rs b/transcode/src/lib.rs similarity index 99% rename from src/cmd/extrinsics/transcode/mod.rs rename to transcode/src/lib.rs index 4b71b0029..1b882d667 100644 --- a/src/cmd/extrinsics/transcode/mod.rs +++ b/transcode/src/lib.rs @@ -86,6 +86,7 @@ mod encode; pub mod env_types; mod scon; mod transcoder; +mod util; pub use self::{ scon::{ @@ -346,7 +347,7 @@ mod tests { use scon::Value; use std::str::FromStr; - use crate::cmd::extrinsics::transcode::scon::Hex; + use crate::scon::Hex; use ink_lang as ink; #[ink::contract] diff --git a/src/cmd/extrinsics/transcode/scon/display.rs b/transcode/src/scon/display.rs similarity index 100% rename from src/cmd/extrinsics/transcode/scon/display.rs rename to transcode/src/scon/display.rs diff --git a/src/cmd/extrinsics/transcode/scon/mod.rs b/transcode/src/scon/mod.rs similarity index 100% rename from src/cmd/extrinsics/transcode/scon/mod.rs rename to transcode/src/scon/mod.rs diff --git a/src/cmd/extrinsics/transcode/scon/parse.rs b/transcode/src/scon/parse.rs similarity index 100% rename from src/cmd/extrinsics/transcode/scon/parse.rs rename to transcode/src/scon/parse.rs diff --git a/src/cmd/extrinsics/transcode/transcoder.rs b/transcode/src/transcoder.rs similarity index 100% rename from src/cmd/extrinsics/transcode/transcoder.rs rename to transcode/src/transcoder.rs diff --git a/transcode/src/util.rs b/transcode/src/util.rs new file mode 100644 index 000000000..77106966d --- /dev/null +++ b/transcode/src/util.rs @@ -0,0 +1,24 @@ +// Copyright 2018-2022 Parity Technologies (UK) Ltd. +// This file is part of cargo-contract. +// +// cargo-contract is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// cargo-contract is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with cargo-contract. If not, see . + +/// Decode hex string with or without 0x prefix +pub fn decode_hex(input: &str) -> Result, hex::FromHexError> { + if input.starts_with("0x") { + hex::decode(input.trim_start_matches("0x")) + } else { + hex::decode(input) + } +}