@emurgo/cardano-serialization-lib-nodejs - npm Package Compare versions

Comparing version 0.2.2 to 1.0.0

cardano_serialization_lib.d.ts

@@ -1798,18 +1798,28 @@ /* tslint:disable */
 * @param {BigNum} minimum_utxo_val
+* @param {BigNum} pool_deposit
+* @param {BigNum} key_deposit
 * @returns {TransactionBuilder}
 */
-  static new(linear_fee: LinearFee, minimum_utxo_val: BigNum): TransactionBuilder;
+  static new(linear_fee: LinearFee, minimum_utxo_val: BigNum, pool_deposit: BigNum, key_deposit: BigNum): TransactionBuilder;
 /**
+* does not include refunds or withdrawals
 * @returns {BigNum}
 */
-  get_input_total(): BigNum;
+  get_explicit_input(): BigNum;
 /**
+* withdrawals and refunds
 * @returns {BigNum}
 */
-  get_feeless_output_total(): BigNum;
+  get_implicit_input(): BigNum;
 /**
+* does not include fee
 * @returns {BigNum}
 */
+  get_explicit_output(): BigNum;
+/**
+* @returns {BigNum}
+*/
   get_fee_or_calc(): BigNum;
 /**
+* Warning: this function will mutate the /fee/ field
 * @param {Address} address
@@ -1816,0 +1826,0 @@ * @returns {boolean}

package.json

 {
   "name": "@emurgo/cardano-serialization-lib-nodejs",
-  "version": "0.2.2",
+  "version": "1.0.0",
   "files": [
@@ -5,0 +5,0 @@ "cardano_serialization_lib_bg.wasm",

README.md

 # Cardano Serialization Lib
 
-**WARNING** this library is experimental.
-
 This is a library for serialization & deserialization of data structures used in Cardano's Haskell implementation of Shelley along with useful utility functions.
 
-Serialization/deserialization code is generated automatically from the CDDL specification using [cddl-codegen](https://github.com/Emurgo/cddl-codegen).
+## How can I use this library
 
-This code is available in:
+Rust is wonderfully portable! You can easily bind to the native Rust library from any common programming language (even C and WebAssembly)!
 
-- Native Rust (this repository)
+##### NPM packages
+
+- [NodeJS WASM package](https://www.npmjs.com/package/@emurgo/cardano-serialization-lib-nodejs)
+- [Browser (chrome/firefox) WASM package](https://www.npmjs.com/package/@emurgo/cardano-serialization-lib-browser)
+
+##### Mobile bindings
+
 - [React-Native mobile bindings](https://github.com/Emurgo/react-native-haskell-shelley)
-- [nodejs WASM package](https://www.npmjs.com/package/@emurgo/cardano-serialization-lib-nodejs)
-- [browser WASM package](https://www.npmjs.com/package/@emurgo/cardano-serialization-lib-browser)
 
+## Benefits of using this library
+
+Serialization/deserialization code is automatically generated from Cardano's official specification, which guarantees it can easily stay up to date! We do this using an EMURGO-written tool called [cddl-codegen](https://github.com/Emurgo/cddl-codegen) which be re-use to automatically generate a Rust library for Cardano metadata specifications!
+
+It is also very easy to create scripts in Rust or WASM to share with stake pools of embed inside an online tool. No more crazy cardano-cli bash scripts!
+
+Powerful and flexible enough to be used to power wallets and exchanges! (Yes, it's used in production!)
+
+## What about other versions of Cardano?
+
 If you are looking for legacy bindings, you can find them at the following:
@@ -21,3 +33,3 @@
 
-## Original specs
+## Original binary specifications
 
@@ -24,0 +36,0 @@ Here are the location of the original [CDDL](http://cbor.io/tools.html) specifications:

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1142898

increased by0.29%

Lines of code

7329

increased by0.34%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

71

increased by20.34%

No dependency changes