feat: nep330 build info field of contract metadata

examples/fungible-token/test-contract-defi/src/lib.rs

@@ -16,6 +16,7 @@ pub struct DeFi {
 }
 
 // Have to repeat the same trait for our own implementation.
+#[allow(dead_code)]
 trait ValueReturnTrait {
  fn value_please(&self, amount_to_return: String) -> PromiseOrValue<U128>;
 }

near-sdk-macros/src/core_impl/contract_metadata/build_info.rs

@@ -0,0 +1,84 @@
+#[derive(serde::Serialize)]
+pub(crate) struct BuildInfo {
+ build_environment: String,
+ build_command: Vec<String>,
+ contract_path: String,
+ source_code_snapshot: String,
+}
+
+/// basic parsing errors
+#[derive(Debug)]
+pub(super) enum FieldError {
+ EmptyBuildEnvironment,
+ UnsetOrEmptyBuildCommand,
+ /// `None` value should be used instead for `contract_path`
+ UnsetContractPath,
+ UnsetOrEmptySourceSnapshot,
+}
+
+#[allow(clippy::write_literal)]
+impl std::fmt::Display for FieldError {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ match self {
+ Self::EmptyBuildEnvironment => {
+ write!(f, "`CARGO_NEAR_BUILD_ENVIRONMENT` is set, but it's set to empty string!")
+ }
+ Self::UnsetOrEmptyBuildCommand => {
+ write!(f, "{}{}",
+ "`CARGO_NEAR_BUILD_COMMAND` is required, when `CARGO_NEAR_BUILD_ENVIRONMENT` is set, ",
+ "but it's either not set or empty!"
+ )
+ }
+ Self::UnsetContractPath => {
+ write!(f, "{}{}", "`CARGO_NEAR_CONTRACT_PATH` was provided, ", "but it's not set!")
+ }
+ Self::UnsetOrEmptySourceSnapshot => {
+ write!(f, "{}{}",
+ "`CARGO_NEAR_SOURCE_CODE_GIT_URL` is required, when `CARGO_NEAR_BUILD_ENVIRONMENT` is set, ",
+ "but it's either not set or empty!"
+ )
+ }
+ }
+ }
+}
+
+impl BuildInfo {
+ pub(super) fn from_env() -> Result<Self, FieldError> {
+ macro_rules! env_field {
+ ($field: ident, $env_key: expr, $error: expr) => {
+ let $field = std::env::var($env_key).map_err(|_| $error)?;
+ if $field.is_empty() {
+ return Err($error);
+ }
+ };
+ }
+
+ env_field!(
+ build_environment,
+ "CARGO_NEAR_BUILD_ENVIRONMENT",
+ FieldError::EmptyBuildEnvironment
+ );
+ let build_command = {
+ env_field!(
+ build_command,
+ "CARGO_NEAR_BUILD_COMMAND",
+ FieldError::UnsetOrEmptyBuildCommand
+ );
+ let build_command =
+ build_command.split_whitespace().map(|st| st.to_string()).collect::<Vec<_>>();
+ if build_command.is_empty() {
+ return Err(FieldError::UnsetOrEmptyBuildCommand);
+ }
+ build_command
+ };
+ env_field!(
+ source_code_snapshot,
+ "CARGO_NEAR_SOURCE_CODE_SNAPSHOT",
+ FieldError::UnsetOrEmptySourceSnapshot
+ );
+ let contract_path =
+ std::env::var("CARGO_NEAR_CONTRACT_PATH").map_err(|_| FieldError::UnsetContractPath)?;
+
+ Ok(Self { build_environment, build_command, contract_path, source_code_snapshot })
+ }
+}

near-sdk-macros/src/core_impl/contract_metadata/mod.rs

@@ -2,6 +2,8 @@ use darling::{ast::NestedMeta, Error, FromMeta};
 use proc_macro2::TokenStream;
 use quote::quote;
 
+mod build_info;
+
 #[derive(FromMeta)]
 struct MacroConfig {
  contract_metadata: Option<ContractMetadata>,
@@ -11,8 +13,12 @@ struct MacroConfig {
 pub(crate) struct ContractMetadata {
  version: Option<String>,
  link: Option<String>,
+
  #[darling(multiple, rename = "standard")]
  standards: Vec<Standard>,
+
+ #[darling(skip)]
+ build_info: Option<build_info::BuildInfo>,
 }
 
 impl quote::ToTokens for ContractMetadata {
@@ -47,26 +53,37 @@ struct Standard {
 
 impl ContractMetadata {
  fn populate(mut self) -> Self {
- if self.version.is_none() {
- let version = std::env::var("CARGO_PKG_VERSION").unwrap_or(String::from(""));
- if !version.is_empty() {
- self.version = Some(version);
- }
+ macro_rules! env_field {
+ ($field: expr, $env_result: expr) => {
+ if $field.is_none() {
+ let field_val = $env_result.unwrap_or(String::from(""));
+ if !field_val.is_empty() {
+ $field = Some(field_val);
+ }
+ }
+ };
  }
 
- if self.link.is_none() {
- let repo = std::env::var("CARGO_PKG_REPOSITORY").unwrap_or(String::from(""));
- if !repo.is_empty() {
- self.link = Some(repo);
- }
- }
+ env_field!(
+ self.link,
+ std::env::var("CARGO_NEAR_REPO_LINK_HINT").or(std::env::var("CARGO_PKG_REPOSITORY"))
+ );
+ env_field!(self.version, std::env::var("CARGO_PKG_VERSION"));
 
  // adding nep330 if it is not present
  if self.standards.is_empty()
  || self.standards.iter().all(|s| s.standard.to_ascii_lowercase() != "nep330")
  {
  self.standards
- .push(Standard { standard: "nep330".to_string(), version: "1.1.0".to_string() });
+ .push(Standard { standard: "nep330".to_string(), version: "1.2.0".to_string() });
+ }
+
+ if std::env::var("CARGO_NEAR_BUILD_ENVIRONMENT").is_ok() {
+ self.build_info = Some(
+ build_info::BuildInfo::from_env()
+ .map_err(|err| err.to_string())
+ .expect("Build Details Extension field not provided"),
+ );
  }
 
  self

near-sdk-macros/src/core_impl/info_extractor/attr_sig_info.rs

@@ -165,7 +165,7 @@ impl AttrSigInfo {
 
  self_occurrences.extend(args.iter().flat_map(|arg| arg.self_occurrences.clone()));
 
- *original_attrs = non_bindgen_attrs.clone();
+ original_attrs.clone_from(&non_bindgen_attrs);
 
  if matches!(method_kind, MethodKind::Call(_) | MethodKind::View(_)) {
  report_spans(

near-sdk/compilation_tests/schema_derive_invalids.stderr

@@ -87,7 +87,7 @@ error[E0277]: the trait bound `Inner: JsonSchema` is not satisfied
  i128
  and $N others
 note: required by a bound in `SchemaGenerator::subschema_for`
- --> $CARGO/schemars-0.8.17/src/gen.rs
+ --> $CARGO/schemars-0.8.19/src/gen.rs
  |
  | pub fn subschema_for<T: ?Sized + JsonSchema>(&mut self) -> Schema {
  | ^^^^^^^^^^ required by this bound in `SchemaGenerator::subschema_for`

near-sdk/src/lib.rs

@@ -3,6 +3,7 @@
 #![allow(clippy::redundant_closure)]
 // We want to enable all clippy lints, but some of them generate false positives.
 #![allow(clippy::missing_const_for_fn, clippy::redundant_pub_crate)]
+#![allow(clippy::multiple_bound_locations)]
 
 #[cfg(test)]
 extern crate quickcheck;