rename to_json_dapp() to to_js_eip12;

Author: greenhat

bindings/ergo-lib-wasm/src/ergo_box.rs

@@ -170,9 +170,9 @@ impl ErgoBox {
             .map_err(|e| JsValue::from_str(&format!("{}", e)))
     }
 
-    /// JSON representation (same as [`Self::to_json`],
-    /// but with box value encoding as string)
-    pub fn to_json_dapp(&self) -> Result<JsValue, JsValue> {
+    /// JSON representation according to EIP-12 https://github.com/ergoplatform/eips/pull/23
+    /// (similar to [`Self::to_json`], but with box value and token amount encoding as strings)
+    pub fn to_js_eip12(&self) -> Result<JsValue, JsValue> {
         let box_dapp: ErgoBoxJsonDapp = self.0.clone().into();
         JsValue::from_serde(&box_dapp).map_err(|e| JsValue::from_str(&format!("{}", e)))
     }

bindings/ergo-lib-wasm/src/transaction.rs

@@ -77,9 +77,9 @@ impl Transaction {
             .map_err(|e| JsValue::from_str(&format!("{}", e)))
     }
 
-    /// JSON representation (same as [`Self::to_json`],
-    /// but with box value and token amount encoding as strings)
-    pub fn to_json_dapp(&self) -> Result<JsValue, JsValue> {
+    /// JSON representation according to EIP-12 https://github.com/ergoplatform/eips/pull/23
+    /// (similar to [`Self::to_json`], but with box value and token amount encoding as strings)
+    pub fn to_js_eip12(&self) -> Result<JsValue, JsValue> {
         let tx_dapp: TransactionJsonDapp = self.0.clone().into();
         JsValue::from_serde(&tx_dapp).map_err(|e| JsValue::from_str(&format!("{}", e)))
     }
@@ -152,9 +152,9 @@ impl UnsignedTransaction {
             .map_err(|e| JsValue::from_str(&format!("{}", e)))
     }
 
-    /// JSON representation (same as [`Self::to_json`],
-    /// but with box value and token amount encoding as strings)
-    pub fn to_json_dapp(&self) -> Result<JsValue, JsValue> {
+    /// JSON representation according to EIP-12 https://github.com/ergoplatform/eips/pull/23
+    /// (similar to [`Self::to_json`], but with box value and token amount encoding as strings)
+    pub fn to_js_eip12(&self) -> Result<JsValue, JsValue> {
         let tx_dapp: UnsignedTransactionJsonDapp = self.0.clone().into();
         JsValue::from_serde(&tx_dapp).map_err(|e| JsValue::from_str(&format!("{}", e)))
     }

bindings/ergo-lib-wasm/tests/test_box.js

@@ -37,7 +37,7 @@ it('ErgoBox.to_json_dapp() test', async () => {
         "spentTransactionId": null,
         "mainChain": true
     }]).get(0);
-    const j_obj = box.to_json_dapp();
+    const j_obj = box.to_js_eip12();
     assert(j_obj instanceof Object);
     assert(j_obj.value == "2875858910", "should be a string of '2875858910'");
     assert(j_obj.assets[0].amount == "99999999998", "should be a string of '99999999998'");

ergo-lib/CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased] - ReleaseDate
 
 ### Added 
-- WASM `to_json_dapp()` (along `to_json_dapp()`) that encodes the same JSON as `to_json()` but box value and token amount encodes as strings to avoid accuracy loss in JS [#346](https://github.com/ergoplatform/sigma-rust/pull/346);
+- WASM `to_js_eip12()` (along `to_json()`) that encodes JSON according to [EIP-12](https://github.com/ergoplatform/eips/pull/23) (similar to JSON by `to_json()`, but box value and token amount encodes as strings to avoid accuracy loss in JS) [#346](https://github.com/ergoplatform/sigma-rust/pull/346);
 - `Coll.slice` [#309](https://github.com/ergoplatform/sigma-rust/pull/309);
 - Byte-wise XOR for byte arrays [#310](https://github.com/ergoplatform/sigma-rust/pull/310);
 - `Constant::from_i64_str_array` and `to_i64_str_array` for `Coll[Long]` encoding [#311](https://github.com/ergoplatform/sigma-rust/pull/311);