neo3 1.0.9

Production-ready Rust SDK for Neo N3 blockchain with high-level API, unified error handling, and enterprise features
Documentation
#![allow(missing_docs)]

use crate::{
	builder::{SignerTrait, SignerType, WitnessRule, WitnessScope},
	crypto::Secp256r1PublicKey,
	deserialize_scopes, deserialize_script_hash, deserialize_vec_script_hash,
	neo_types::{deserialize_vec_public_key, serialize_vec_public_key},
	serialize_scopes, serialize_script_hash, serialize_vec_script_hash,
};
use neo3::TypeError;
use primitive_types::H160;
use serde::{Deserialize, Serialize};
use std::hash::{Hash, Hasher};

#[derive(Default, Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct RTransactionSigner {
	#[serde(rename = "account")]
	#[serde(serialize_with = "serialize_script_hash")]
	#[serde(deserialize_with = "deserialize_script_hash")]
	pub account: H160,

	#[serde(rename = "scopes", default)]
	#[serde(serialize_with = "serialize_scopes")]
	#[serde(deserialize_with = "deserialize_scopes")]
	pub scopes: Vec<WitnessScope>,

	#[serde(rename = "allowedcontracts", default)]
	#[serde(serialize_with = "serialize_vec_script_hash")]
	#[serde(deserialize_with = "deserialize_vec_script_hash")]
	pub allowed_contracts: Vec<H160>,

	#[serde(rename = "allowedgroups", default)]
	#[serde(serialize_with = "serialize_vec_public_key")]
	#[serde(deserialize_with = "deserialize_vec_public_key")]
	pub allowed_groups: Vec<Secp256r1PublicKey>,

	#[serde(rename = "rules", default)]
	// #[serde(default)]
	pub rules: Vec<WitnessRule>,
}

impl Hash for RTransactionSigner {
	fn hash<H: Hasher>(&self, state: &mut H) {
		self.account.hash(state);
		self.scopes.hash(state);
		self.allowed_contracts.hash(state);
		self.allowed_groups.hash(state);
		self.rules.hash(state);
	}
}

impl RTransactionSigner {
	pub fn new(account: H160, scopes: Vec<WitnessScope>) -> Self {
		Self { account, scopes, allowed_contracts: vec![], allowed_groups: vec![], rules: vec![] }
	}

	pub fn new_full(
		account: H160,
		scopes: Vec<WitnessScope>,
		allowed_contracts: Vec<H160>,
		allowed_groups: Vec<Secp256r1PublicKey>,
		rules: Vec<WitnessRule>,
	) -> Self {
		Self { account, scopes, allowed_contracts, allowed_groups, rules }
	}

	pub fn get_first_scope(&self) -> Result<&WitnessScope, TypeError> {
		if self.scopes.is_empty() {
			return Err(TypeError::IndexOutOfBounds(
				"This transaction signer does not have any witness scopes. It might be malformed, since every transaction signer needs to have a witness scope specified.".to_string(),
			));
		}
		self.get_scope(0)
	}

	pub fn get_scope(&self, index: usize) -> Result<&WitnessScope, TypeError> {
		if index >= self.scopes.len() {
			return Err(TypeError::IndexOutOfBounds(format!(
				"This transaction signer only has {} witness scopes. Tried to access index {}.",
				self.scopes.len(),
				index
			)));
		}
		Ok(&self.scopes[index])
	}

	pub fn get_first_allowed_contract(&self) -> Result<&H160, TypeError> {
		if self.allowed_contracts.is_empty() {
			return Err(TypeError::IndexOutOfBounds(
				"This transaction signer does not allow any specific contract.".to_string(),
			));
		}
		self.get_allowed_contract(0)
	}

	pub fn get_allowed_contract(&self, index: usize) -> Result<&H160, TypeError> {
		if index >= self.allowed_contracts.len() {
			return Err(TypeError::IndexOutOfBounds(format!(
				"This transaction signer only allows {} contracts. Tried to access index {}.",
				self.allowed_contracts.len(),
				index
			)));
		}
		Ok(&self.allowed_contracts[index])
	}

	pub fn get_first_allowed_group(&self) -> Result<&Secp256r1PublicKey, TypeError> {
		if self.allowed_groups.is_empty() {
			return Err(TypeError::IndexOutOfBounds(
				"This transaction signer does not allow any specific group.".to_string(),
			));
		}
		self.get_allowed_group(0)
	}

	pub fn get_allowed_group(&self, index: usize) -> Result<&Secp256r1PublicKey, TypeError> {
		if index >= self.allowed_groups.len() {
			return Err(TypeError::IndexOutOfBounds(format!(
				"This transaction signer only allows {} groups. Tried to access index {}.",
				self.allowed_groups.len(),
				index
			)));
		}
		Ok(&self.allowed_groups[index])
	}

	pub fn get_first_rule(&self) -> Result<&WitnessRule, TypeError> {
		if self.rules.is_empty() {
			return Err(TypeError::IndexOutOfBounds(
				"This transaction signer does not have any witness rules.".to_string(),
			));
		}
		self.get_rule(0)
	}

	pub fn get_rule(&self, index: usize) -> Result<&WitnessRule, TypeError> {
		if index >= self.rules.len() {
			return Err(TypeError::IndexOutOfBounds(format!(
				"This transaction signer only has {} witness rules. Tried to access index {}.",
				self.rules.len(),
				index
			)));
		}
		Ok(&self.rules[index])
	}
}

impl SignerTrait for RTransactionSigner {
	fn get_type(&self) -> SignerType {
		SignerType::TransactionSigner
	}

	fn get_signer_hash(&self) -> &H160 {
		&self.account
	}

	fn set_signer_hash(&mut self, signer_hash: H160) {
		self.account = signer_hash;
	}

	fn get_scopes(&self) -> &Vec<WitnessScope> {
		&self.scopes
	}

	fn get_scopes_mut(&mut self) -> &mut Vec<WitnessScope> {
		&mut self.scopes
	}

	fn set_scopes(&mut self, scopes: Vec<WitnessScope>) {
		self.scopes = scopes;
	}

	fn get_allowed_contracts(&self) -> &Vec<H160> {
		&self.allowed_contracts
	}

	fn get_allowed_contracts_mut(&mut self) -> &mut Vec<H160> {
		&mut self.allowed_contracts
	}

	fn get_allowed_groups(&self) -> &Vec<Secp256r1PublicKey> {
		&self.allowed_groups
	}

	fn get_allowed_groups_mut(&mut self) -> &mut Vec<Secp256r1PublicKey> {
		&mut self.allowed_groups
	}

	fn get_rules(&self) -> &Vec<WitnessRule> {
		&self.rules
	}

	fn get_rules_mut(&mut self) -> &mut Vec<WitnessRule> {
		&mut self.rules
	}
}

// impl NeoSerializable for TransactionSigner {
// 	type Error = TransactionError;

// 	fn size(&self) -> usize {
// 		let mut size = (NeoConstants::HASH160_SIZE + 1) as usize;
// 		if self.scopes.contains(&WitnessScope::CustomContracts) {
// 			size += &self.allowed_contracts.clone().unwrap().var_size();
// 		}
// 		if self.scopes.contains(&WitnessScope::CustomGroups) {
// 			size += &self.allowed_groups.clone().unwrap().var_size();
// 		}

// 		if self.scopes.contains(&WitnessScope::WitnessRules) {
// 			size += &self.rules.clone().unwrap().var_size();
// 		}

// 		size
// 	}

// 	fn encode(&self, writer: &mut Encoder) {
// 		writer.write_serializable_fixed(self.get_signer_hash());
// 		writer.write_u8(WitnessScope::combine(self.scopes.as_slice()));
// 		if self.scopes.contains(&WitnessScope::CustomContracts) {
// 			writer.write_serializable_variable_list(self.allowed_contracts.as_ref().unwrap());
// 		}
// 		if self.scopes.contains(&WitnessScope::CustomGroups) {
// 			writer.write_serializable_variable_list(self.allowed_groups.as_ref().unwrap());
// 		}
// 		if self.scopes.contains(&WitnessScope::WitnessRules) {
// 			writer.write_serializable_variable_list(self.rules.as_ref().unwrap());
// 		}
// 	}

// 	fn decode(reader: &mut Decoder) -> Result<Self, Self::Error>
// 	where
// 		Self: Sized,
// 	{
// 		let mut signer = TransactionSigner::default();
// 		signer.set_signer_hash(reader.read_serializable().unwrap());
// 		let scopes = WitnessScope::split(reader.read_u8());
// 		signer.set_scopes(scopes);
// 		if signer.get_scopes().contains(&WitnessScope::CustomContracts) {
// 			signer.allowed_contracts = Some(reader.read_serializable_list().unwrap());
// 		}
// 		if signer.get_scopes().contains(&WitnessScope::CustomGroups) {
// 			signer.allowed_groups = Some(reader.read_serializable_list().unwrap());
// 		}
// 		if signer.get_scopes().contains(&WitnessScope::WitnessRules) {
// 			signer.rules = Some(reader.read_serializable_list().unwrap());
// 		}
// 		Ok(signer)
// 	}

// 	fn to_array(&self) -> Vec<u8> {
// 		let writer = &mut Encoder::new();
// 		self.encode(writer);
// 		writer.to_bytes()
// 	}
// }