Add publish script (Emurgo#13)

.gitignore

@@ -1,3 +1,5 @@
 node_modules/
 dist/
-rust/target
+publish/
+rust/target
+tsconfig.tsbuildinfo

README.md

@@ -2,16 +2,30 @@
 
 **WARNING** this library is experimental.
 
-This is a library for serialization & deserialization of types related to Cardano's Haskell implementation of Shelley.
+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).
+
+This code is available in:
+
+- Native Rust (this repository)
+- [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)
+
+If you are looking for legacy bindings, you can find them at the following:
+
+- [Byron WASM bindings](https://github.com/input-output-hk/js-cardano-wasm/tree/master/cardano-wallet)
+- [Jormungandr WASM bindings](https://github.com/emurgo/js-chain-libs)
 
 ## Original specs
 
 Here are the location of the original [CDDL](http://cbor.io/tools.html) specifications:
 
-- Byron: [link](https://github.com/input-output-hk/cardano-ledger-specs/blob/master/byron/cddl-spec/byron.cddl)
-- Shelley: [link](https://github.com/input-output-hk/cardano-ledger-specs/blob/master/shelley/chain-and-ledger/cddl-spec/shelley.cddl#L72)
+- Byron: [link](https://github.com/input-output-hk/cardano-ledger-specs/tree/master/byron/cddl-spec)
+- Shelley: [link](https://github.com/input-output-hk/cardano-ledger-specs/tree/master/shelley/chain-and-ledger/executable-spec/cddl-files)
 
-# Building
+## Building
 
 If you need to install Rust, do the following:
 ```
@@ -25,27 +39,20 @@ To build this repository, do the following:
 ```
 git submodule update --init --recursive
 nvm install && nvm use
-npm run rust:build
+npm run rust:build-nodejs
 npm install
 ```
 
-# Testing
+## Testing
 
 ```
+npm run rust:test
 npm run js:test
 ```
 
-# Generating CDDL instances
+## Publishing
 
-First you need to install `cddl`
 ```
-sudo apt install ruby
-sudo gem install cddl
-sudo gem install cbor-diag
+npm run js:publish-nodejs
+npm run js:publish-browser
 ```
-
-You can generate new tests with
-1) `cddl specs/shelley.cddl generate 1 > test/name_here.diag`
-2) `diag2cbor.rb test/name_here.diag > test/name_here.cbor`
-
-You can combine these together with `cddl specs/shelley.cddl generate 1 | diag2cbor.rb > test/name_here.cbor`

package.json

@@ -4,14 +4,18 @@
   "description": "processing Haskell Shelley testnet",
   "main": "dist/index.js",
   "scripts": {
-    "rust:build": "cd rust; wasm-pack build --target=nodejs; wasm-pack pack; cd ..",
+    "rust:build-nodejs": "rimraf ./rust/pkg && cd rust; wasm-pack build --target=nodejs; wasm-pack pack; cd .. && npm run js:flowgen",
+    "rust:build-browser": "rimraf ./rust/pkg && cd rust; wasm-pack build --target=browser; wasm-pack pack; cd .. && npm run js:flowgen",
     "rust:test": "cd rust; cargo test; cd ..",
     "js:build": "rm -rf dist && tsc",
     "js:dev": "rimraf ./dist && node ./src/index.ts",
     "js:lint": "eslint \"src/**/*.ts\"",
     "js:test:watch": "mocha -w",
     "js:test": "mocha",
-    "js:flowgen": "npm run rust:build && flowgen ./rust/pkg/cddl_lib.d.ts -o ./rust/pkg/cddl_lib.js.flow --add-flow-header"
+    "js:flowgen": "flowgen ./rust/pkg/cardano_serialization_lib.d.ts -o ./rust/pkg/cardano_serialization_lib.js.flow --add-flow-header",
+    "js:prepublish": "npm run rust:test && rimraf ./publish && cp -r ./rust/pkg ./publish && cp README.md publish/ && cp LICENSE publish/",
+    "js:publish-nodejs": "npm run rust:build-nodejs && npm run js:prepublish && node ./scripts/publish-helper -nodejs && cd publish && npm publish --access public",
+    "js:publish-browser": "npm run rust:build-browser && npm run js:prepublish && node ./scripts/publish-helper -browser && cd publish && npm publish --access public"
   },
   "husky": {
     "hooks": {
@@ -20,25 +24,29 @@
   },
   "author": "EMURGO",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Emurgo/cardano-serialization-lib.git"
+  },
   "dependencies": {
-    "io-ts": "2.2.6",
+    "io-ts": "2.2.7",
     "cbor": "5.0.2",
     "@types/cbor": "5.0.0"
   },
   "devDependencies": {
     "@types/chai": "4.2.11",
     "@types/mocha": "7.0.2",
-    "@typescript-eslint/eslint-plugin": "3.4.0",
-    "@typescript-eslint/parser": "3.4.0",
+    "@typescript-eslint/eslint-plugin": "3.6.0",
+    "@typescript-eslint/parser": "3.6.0",
     "bip39": "3.0.2",
     "chai": "4.2.0",
-    "eslint": "7.3.1",
+    "eslint": "7.4.0",
     "flowgen": "1.11.0",
     "husky": "4.2.5",
     "mocha": "8.0.1",
     "rust-lib": "file:rust/pkg",
     "source-map-support": "0.5.19",
     "ts-node": "8.10.2",
-    "typescript": "3.9.5"
+    "typescript": "3.9.6"
   }
 }

rust/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "cddl-lib"
+name = "cardano-serialization-lib"
 version = "0.1.0"
 edition = "2018"
 

rust/pkg/cddl_lib.js.flow → rust/pkg/cardano_serialization_lib.js.flow

@@ -1,5 +1,5 @@
 /**
- * Flowtype definitions for cddl_lib
+ * Flowtype definitions for cardano_serialization_lib
  * Generated by Flowgen from a Typescript Definition
  * Flowgen v1.11.0
  * @flow

scripts/.eslintrc.js

@@ -0,0 +1,9 @@
+{
+  "parserOptions": {
+      "ecmaVersion": 6,
+      "sourceType": "module",
+  },
+  "extends": [
+    "eslint:recommended",
+  }
+}

scripts/publish-helper.js

@@ -0,0 +1,12 @@
+const fs = require('fs');
+const oldPkg = require('../publish/package.json');
+
+const flowFile = 'cardano_serialization_lib.js.flow';
+if (oldPkg.files.find(entry => entry === flowFile) == null) {
+  oldPkg.files.push('cardano_serialization_lib.js.flow');
+}
+if (oldPkg.name === 'cardano-serialization-lib') {
+  oldPkg.name = '@emurgo/' + oldPkg.name + process.argv.slice(2)[0];
+}
+console.log(oldPkg);
+fs.writeFileSync('./publish/package.json', JSON.stringify(oldPkg, null, 2));

specs/README.md

@@ -0,0 +1,14 @@
+# Generating CDDL instances
+
+First you need to install `cddl`
+```
+sudo apt install ruby
+sudo gem install cddl
+sudo gem install cbor-diag
+```
+
+You can generate new tests with
+1) `cddl specs/shelley.cddl generate 1 > test/name_here.diag`
+2) `diag2cbor.rb test/name_here.diag > test/name_here.cbor`
+
+You can combine these together with `cddl specs/shelley.cddl generate 1 | diag2cbor.rb > test/name_here.cbor`