Skip to content

[WIP] Asset contracts 2.0 #54

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.

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -9,9 +9,9 @@ repository = "https://github.com/ElementsProject/rust-elements/"
documentation = "https://docs.rs/elements/"

[features]
default = [ "json-contract" ]
default = [ "contracts" ]

json-contract = [ "serde_json" ]
contracts = [ "serde", "serde_cbor", "serde_json" ]
"serde-feature" = [
"bitcoin/use-serde",
"serde"
@@ -25,13 +25,13 @@ bitcoin = "0.23"
# to avoid requiring two version of bitcoin_hashes.
bitcoin_hashes = "0.7.6"

# Used for ContractHash::from_json_contract.
serde_json = { version = "<=1.0.44", optional = true }
serde = { version = "1.0", optional = true, features = ["derive"] }

[dependencies.serde]
version = "1.0"
optional = true
# Used for contracts module.
serde_cbor = { version = "0.11.1", optional = true }
serde_json = { version = "<=1.0.44", optional = true }

[dev-dependencies]
rand = "0.6.5"
serde_json = "<=1.0.44"
bitcoin = { version = "0.23", features = ["use-serde"] }
24 changes: 7 additions & 17 deletions src/address.rs
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ use bitcoin::util::base58;
use bitcoin::PublicKey;
use bitcoin::hashes::Hash;
use bitcoin::secp256k1;
#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
use serde;

use blech32;
@@ -75,6 +75,7 @@ impl fmt::Display for AddressError {
}
}

#[allow(deprecated)]
impl error::Error for AddressError {
fn cause(&self) -> Option<&error::Error> {
match *self {
@@ -87,16 +88,7 @@ impl error::Error for AddressError {
}

fn description(&self) -> &str {
match *self {
AddressError::Base58(ref e) => e.description(),
AddressError::Bech32(ref e) => e.description(),
AddressError::Blech32(ref e) => e.description(),
AddressError::InvalidAddress(..) => "was unable to parse the address",
AddressError::UnsupportedWitnessVersion(..) => "unsupported witness version",
AddressError::InvalidBlindingPubKey(..) => "an invalid blinding pubkey was encountered",
AddressError::InvalidWitnessProgramLength => "program length incompatible with version",
AddressError::InvalidWitnessVersion => "invalid witness script version",
}
"description() is deprecated; use Display"
}
}

@@ -603,7 +595,7 @@ impl FromStr for Address {
}
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl<'de> serde::Deserialize<'de> for Address {
#[inline]
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
@@ -646,7 +638,7 @@ impl<'de> serde::Deserialize<'de> for Address {
}
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl serde::Serialize for Address {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
@@ -662,8 +654,6 @@ mod test {
use bitcoin::util::key;
use bitcoin::Script;
use bitcoin::secp256k1::{PublicKey, Secp256k1};
#[cfg(feature = "serde")]
use serde_json;

fn roundtrips(addr: &Address) {
assert_eq!(
@@ -678,9 +668,9 @@ mod test {
"script round-trip failed for {}",
addr,
);
#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
assert_eq!(
serde_json::from_value::<Address>(serde_json::to_value(&addr).unwrap()).ok().as_ref(),
::serde_json::from_value::<Address>(serde_json::to_value(&addr).unwrap()).ok().as_ref(),
Some(addr)
);
}
8 changes: 4 additions & 4 deletions src/block.rs
Original file line number Diff line number Diff line change
@@ -21,8 +21,8 @@ use bitcoin;
use bitcoin::blockdata::script::Script;
use bitcoin::{BitcoinHash, BlockHash, VarInt};
use bitcoin::hashes::{Hash, sha256};
#[cfg(feature = "serde")] use serde::{Deserialize, Deserializer, Serialize, Serializer};
#[cfg(feature = "serde")] use std::fmt;
#[cfg(feature = "serde-feature")] use serde::{Deserialize, Deserializer, Serialize, Serializer};
#[cfg(feature = "serde-feature")] use std::fmt;

use dynafed;
use Transaction;
@@ -49,7 +49,7 @@ pub enum ExtData {
},
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl<'de> Deserialize<'de> for ExtData {
fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
use serde::de;
@@ -149,7 +149,7 @@ impl<'de> Deserialize<'de> for ExtData {
}
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl Serialize for ExtData {
fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
use serde::ser::SerializeStruct;
6 changes: 3 additions & 3 deletions src/confidential.rs
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@
//! Structures representing Pedersen commitments of various types
//!

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
use serde::{Deserialize, Deserializer, Serialize, Serializer};

use std::{io, fmt};
@@ -137,7 +137,7 @@ macro_rules! impl_confidential_commitment {
}
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl Serialize for $name {
fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
use serde::ser::SerializeSeq;
@@ -161,7 +161,7 @@ macro_rules! impl_confidential_commitment {
}
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl<'de> Deserialize<'de> for $name {
fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
use serde::de::{Error, Visitor, SeqAccess};
536 changes: 536 additions & 0 deletions src/contracts.rs

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions src/dynafed.rs
Original file line number Diff line number Diff line change
@@ -18,8 +18,8 @@ use std::io;

use bitcoin;
use bitcoin::hashes::{Hash, sha256, sha256d};
#[cfg(feature = "serde")] use serde::{Deserialize, Deserializer, Serialize, Serializer};
#[cfg(feature = "serde")] use std::fmt;
#[cfg(feature = "serde-feature")] use serde::{Deserialize, Deserializer, Serialize, Serializer};
#[cfg(feature = "serde-feature")] use std::fmt;

use encode::{self, Encodable, Decodable};

@@ -216,7 +216,7 @@ impl Params {
}
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl<'de> Deserialize<'de> for Params {
fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
use serde::de;
@@ -355,7 +355,7 @@ impl<'de> Deserialize<'de> for Params {
}
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl Serialize for Params {
fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
use serde::ser::SerializeStruct;
3 changes: 2 additions & 1 deletion src/encode.rs
Original file line number Diff line number Diff line change
@@ -57,6 +57,7 @@ impl fmt::Display for Error {
}
}

#[allow(deprecated)]
impl error::Error for Error {
fn cause(&self) -> Option<&error::Error> {
match *self {
@@ -66,7 +67,7 @@ impl error::Error for Error {
}

fn description(&self) -> &str {
"an Elements encoding error"
"description() is deprecated; use Display"
}
}

4 changes: 2 additions & 2 deletions src/internal_macros.rs
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ macro_rules! impl_consensus_encoding {

macro_rules! serde_struct_impl {
($name:ident, $($fe:ident),*) => (
#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl<'de> $crate::serde::Deserialize<'de> for $name {
fn deserialize<D>(deserializer: D) -> Result<$name, D::Error>
where
@@ -131,7 +131,7 @@ macro_rules! serde_struct_impl {
}
}

#[cfg(feature = "serde")]
#[cfg(feature = "serde-feature")]
impl $crate::serde::Serialize for $name {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
50 changes: 0 additions & 50 deletions src/issuance.rs
Original file line number Diff line number Diff line change
@@ -39,26 +39,6 @@ const TWO32: [u8; 32] = [

hash_newtype!(ContractHash, sha256::Hash, 32, doc="The hash of an asset contract.", true);

impl ContractHash {
/// Calculate the contract hash of a JSON contract object.
///
/// This method does not perform any validation of the contents of the contract.
/// After basic JSON syntax validation, the object is formatted in a standard way to calculate
/// the hash.
#[cfg(feature = "json-contract")]
pub fn from_json_contract(json: &str) -> Result<ContractHash, ::serde_json::Error> {
// Parsing the JSON into a BTreeMap will recursively order object keys
// lexicographically. This order is respected when we later serialize
// it again.
let ordered: ::std::collections::BTreeMap<String, ::serde_json::Value> =
::serde_json::from_str(json)?;

let mut engine = ContractHash::engine();
::serde_json::to_writer(&mut engine, &ordered).expect("engines don't error");
Ok(ContractHash::from_engine(engine))
}
}

/// An issued asset ID.
#[derive(Copy, Clone, PartialEq, Eq, Default, PartialOrd, Ord, Hash)]
pub struct AssetId(sha256::Midstate);
@@ -262,34 +242,4 @@ mod test {
let token_id = AssetId::from_hex(token_id_hex).unwrap();
assert_eq!(AssetId::reissuance_token_from_entropy(entropy, false), token_id);
}

#[cfg(feature = "json-contract")]
#[test]
fn test_json_contract() {
let tether = ContractHash::from_hex("3c7f0a53c2ff5b99590620d7f6604a7a3a7bfbaaa6aa61f7bfc7833ca03cde82").unwrap();

let correct = r#"{"entity":{"domain":"tether.to"},"issuer_pubkey":"0337cceec0beea0232ebe14cba0197a9fbd45fcf2ec946749de920e71434c2b904","name":"Tether USD","precision":8,"ticker":"USDt","version":0}"#;
let expected = ContractHash::hash(correct.as_bytes());
assert_eq!(tether, expected);
assert_eq!(expected, ContractHash::from_json_contract(&correct).unwrap());

let invalid_json = r#"{"entity":{"domain":"tether.to"},"issuer_pubkey:"#;
assert!(ContractHash::from_json_contract(&invalid_json).is_err());

let unordered = r#"{"precision":8,"ticker":"USDt","entity":{"domain":"tether.to"},"issuer_pubkey":"0337cceec0beea0232ebe14cba0197a9fbd45fcf2ec946749de920e71434c2b904","name":"Tether USD","version":0}"#;
assert_eq!(expected, ContractHash::from_json_contract(&unordered).unwrap());

let unordered = r#"{"precision":8,"name":"Tether USD","ticker":"USDt","entity":{"domain":"tether.to"},"issuer_pubkey":"0337cceec0beea0232ebe14cba0197a9fbd45fcf2ec946749de920e71434c2b904","version":0}"#;
assert_eq!(expected, ContractHash::from_json_contract(&unordered).unwrap());

let spaces = r#"{"precision":8, "name" : "Tether USD", "ticker":"USDt", "entity":{"domain":"tether.to" }, "issuer_pubkey" :"0337cceec0beea0232ebe14cba0197a9fbd45fcf2ec946749de920e71434c2b904","version":0} "#;
assert_eq!(expected, ContractHash::from_json_contract(&spaces).unwrap());

let nested_correct = r#"{"entity":{"author":"Tether Inc","copyright":2020,"domain":"tether.to","hq":"Mars"},"issuer_pubkey":"0337cceec0beea0232ebe14cba0197a9fbd45fcf2ec946749de920e71434c2b904","name":"Tether USD","precision":8,"ticker":"USDt","version":0}"#;
let nested_expected = ContractHash::hash(nested_correct.as_bytes());
assert_eq!(nested_expected, ContractHash::from_json_contract(&nested_correct).unwrap());

let nested_unordered = r#"{"ticker":"USDt","entity":{"domain":"tether.to","hq":"Mars","author":"Tether Inc","copyright":2020},"issuer_pubkey":"0337cceec0beea0232ebe14cba0197a9fbd45fcf2ec946749de920e71434c2b904","name":"Tether USD","precision":8,"version":0}"#;
assert_eq!(nested_expected, ContractHash::from_json_contract(&nested_unordered).unwrap());
}
}
7 changes: 5 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -28,16 +28,19 @@
pub extern crate bitcoin;
#[macro_use]
pub extern crate bitcoin_hashes;
#[cfg(feature = "serde")] extern crate serde;
#[cfg(feature = "serde")] #[macro_use] extern crate serde;
#[cfg(feature = "serde_cbor")] extern crate serde_cbor;
#[cfg(feature = "serde_json")] extern crate serde_json;

#[cfg(test)] extern crate rand;
#[cfg(any(test, feature = "serde_json"))] extern crate serde_json;

#[macro_use] mod internal_macros;
pub mod address;
pub mod blech32;
mod block;
pub mod confidential;
#[cfg(feature = "contracts")]
pub mod contracts;
pub mod dynafed;
pub mod encode;
mod fast_merkle_root;