@leofcoin/launch-chain 0.3.4 → 0.3.6

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 vandeurenglenn
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 vandeurenglenn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,11 +1,13 @@
 # lauch-chain
+
 > launch chain & peernet (reuses exposed transports when already running)
 
 ## usage
+
 ```js
 import launch from '@leofcoin/launch-chain'
 
-const {chain, endpoints, mode} = await launch()
+const { chain, endpoints, mode } = await launch()
 // chain is undefined when mode is remote
 // endpoints contain urls to connect to the desired remote
 // when mode is remote means an instance is already running
@@ -13,6 +15,7 @@ const {chain, endpoints, mode} = await launch()
 ```
 
 ## options
+
 ### default
 
 ```js
@@ -31,7 +34,8 @@ const {chain, endpoints, mode} = await launch()
 }
 ```
 
-### disabling options 
+### disabling options
+
 ```js
 stars: [] // note that disabling stars results in no peer discovery
 {
@@ -41,22 +45,21 @@ stars: [] // note that disabling stars results in no peer discovery
 ```
 
 ## build for browser
+
 no prebuild are provided since the esm switch, everything is written with the browser in mind so some simple ignores are enough to build.
 
 ### rollup
+
 ```js
-external: [
-  '@koush/wrtc',
-  '@leofcoin/endpoints/ws',
-  '@leofcoin/endpoints/http'
-]
+external: ['@koush/wrtc', '@leofcoin/endpoints/ws', '@leofcoin/endpoints/http']
 ```
 
 ### webpack
+
 ```js
-externals: {    
+externals: {
   '@koush/wrtc': false,
   '@leofcoin/endpoints/ws': false,
   '@leofcoin/endpoints/http': false
 }
-```
+```

package/{index.js → exports/index.js}

@@ -11,12 +11,16 @@ const defaultOptions = {
     stars: networks.leofcoin.peach.stars,
     forceRemote: false,
     mode: 'direct',
-    ws: [{
+    ws: [
+        {
             port: 4040
-        }],
-    http: [{
+        }
+    ],
+    http: [
+        {
             port: 8080
-        }]
+        }
+    ]
 };
 /**
  *
@@ -106,7 +110,7 @@ const launch = async (options, password) => {
     else if (options.mode === 'direct') {
         await new Node({ network: options.network, stars: options.stars, networkVersion: options.networkVersion }, password);
         await nodeConfig({ network: options.network, stars: options.stars, networkVersion: options.networkVersion });
-        chain = await new Chain();
+        chain = await new Chain({ network: options.network, stars: options.stars, networkVersion: options.networkVersion });
         if (options.ws) {
             const importee = await import('@leofcoin/endpoints/ws');
             const wsServer = importee.default;
@@ -135,7 +139,7 @@ const launch = async (options, password) => {
     else {
         await new Node({ network: options.network, stars: options.stars, networkVersion: options.networkVersion }, password);
         await nodeConfig({ network: options.network, stars: options.stars, networkVersion: options.networkVersion });
-        chain = await new Chain();
+        chain = await new Chain({ network: options.network, stars: options.stars, networkVersion: options.networkVersion });
         if (options.ws) {
             const importee = await import('@leofcoin/endpoints/ws');
             const wsServer = importee.default;

package/package.json

@@ -1,36 +1,41 @@
-{
-  "name": "@leofcoin/launch-chain",
-  "version": "0.3.4",
-  "description": "",
-  "exports": {
-    ".": "./index.js"
-  },
-  "types": "./index.d.ts",
-  "type": "module",
-  "scripts": {
-    "build": "rollup -c",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/leofcoin/launch-chain.git"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/leofcoin/launch-chain/issues"
-  },
-  "homepage": "https://github.com/leofcoin/launch-chain#readme",
-  "dependencies": {
-    "@leofcoin/chain": "^1.4.8",
-    "@leofcoin/endpoint-clients": "^0.3.5",
-    "@leofcoin/endpoints": "^0.2.10",
-    "@leofcoin/networks": "^1.0.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-typescript": "^11.0.0",
-    "rollup": "^3.9.1",
-    "tslib": "^2.4.1"
-  }
-}
+{
+  "name": "@leofcoin/launch-chain",
+  "version": "0.3.6",
+  "description": "",
+  "exports": {
+    ".": {
+      "import": "./exports/index.js",
+      "types": "./exports/index.d.ts"
+    }
+  },
+  "files": [
+    "exports"
+  ],
+  "type": "module",
+  "scripts": {
+    "build": "rollup -c",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leofcoin/launch-chain.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/leofcoin/launch-chain/issues"
+  },
+  "homepage": "https://github.com/leofcoin/launch-chain#readme",
+  "dependencies": {
+    "@leofcoin/chain": "^1.6.2",
+    "@leofcoin/endpoint-clients": "^0.3.9",
+    "@leofcoin/endpoints": "^0.3.3",
+    "@leofcoin/networks": "^1.1.5"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.6",
+    "rollup": "^4.12.1",
+    "tslib": "^2.6.2"
+  }
+}

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/rollup.config.js

@@ -1,13 +0,0 @@
-import typescript from '@rollup/plugin-typescript';
-import tsconfig from './tsconfig.json' assert { type: 'json'};
-
-export default [{
-  input: ['./src/index.ts'],
-  output: {
-    format: 'es',
-    dir: './'
-  },
-  plugins: [
-    typescript(tsconfig)
-  ]
-}]

package/src/index.ts

@@ -1,224 +0,0 @@
-import Node from '@leofcoin/chain/node'
-import Chain from '@leofcoin/chain/chain'
-import nodeConfig from '@leofcoin/lib/node-config'
-import WSClient from '@leofcoin/endpoint-clients/ws'
-import HttpClient from '@leofcoin/endpoint-clients/http'
-import networks from '@leofcoin/networks'
-
-type launchMode = 'direct' | 'remote' | 'server'
-
-type endpointReturns = {
-  http?: string[],
-  ws?: string[],
-}
-
-type clientReturns = {
-  http?: HttpClient[],
-  ws?: WSClient[],
-}
-
-type launchReturn = {
-  chain: Chain,
-  mode: launchMode,
-  endpoints: endpointReturns,
-  clients: clientReturns
-}
-
-type endpointOptions = {
-  port: number,
-  url?: string
-}
-
-type launchOptions = {
-  network?: string,
-  networkVersion?: string,
-  stars: string[],
-  forceRemote: boolean,
-  mode?: launchMode,
-  ws?: endpointOptions[] | undefined,
-  http?: endpointOptions[] | undefined,
-}
-
-const defaultOptions: launchOptions = {
-  network: 'leofcoin:peach',
-  networkVersion: 'peach',
-  stars: networks.leofcoin.peach.stars,
-  forceRemote: false,
-  mode: 'direct',
-  ws: [{
-    port: 4040
-  }],
-  http: [{
-    port: 8080
-  }]
-}
-
-/**
- * 
- * @param {string} url 
- * @param {string} networkVersion network/testnet-network sepperate by -
- * @returns Promise(boolean)
- */
-const getHttp = async (url: string, networkVersion: string): Promise<undefined | HttpClient> => {
-  try {
-    const client = new HttpClient(url, networkVersion)
-    await client.network()
-    return client
-  } catch (error) {
-    return undefined
-  }
-}
-
-const tryWs = (url: string, networkVersion: string): Promise<WSClient> => new Promise(async (resolve, reject) => {
-  try {
-    const socket = await new WSClient(url, networkVersion)
-    await socket.init()
-    resolve(socket)
-  } catch (error) {
-    reject(error)
-  }
-})
-
-/**
- * 
- * @param {string} url 
- * @param {string} networkVersion network/testnet-network sepperate by -
- * @returns Promise(boolean)
- */
-const getWS = async (url: string, networkVersion: string): Promise<WSClient> => {
-  try {
-    const ws = await tryWs(url, networkVersion)
-    return ws
-  } catch (error) {
-    return undefined
-  }
-}
-
-/**
- * 
- * @param {string} httpURL 
- * @param {string} wsURL 
- * @param {string} networkVersion 
- * @returns Promise({http: boolean, ws: boolean})
- */
-const hasClient = async (httpURL: string, wsURL: string, networkVersion: string) => {
-  const ws = await getWS(wsURL, networkVersion)
-  const http = await getHttp(httpURL, networkVersion)
-  return {http, ws}
-}
-
-// chain is undefined when mode is remote
-// endpoints contain urls to connect to the desired remote
-// when mode is remote means an instance is already running
-// when mode is direct means chain is directly available and no endpoint is needed to interact with it
-/**
- * 
- * @param {object} options { ws: boolean || {url: string, port: number}, http: boolean || {url: string, port: number}, network}
- * @returns '{ mode: string, endpoints: object, chain}'
- */
-const launch = async (options: launchOptions, password: string): Promise<launchReturn> => {
-  if (!options) options = defaultOptions
-  else options = {...defaultOptions, ...options }
-
-  const clients: clientReturns = {
-    http: [],
-    ws: []
-  }
-
-  const endpoints: endpointReturns = {
-    http: [],
-    ws: []
-  }
-
-  let chain: Chain
-  
-  if (options.mode === 'remote') {
-    if (options.http) {
-      for (const endpoint of options.http) {
-        if (endpoint.port && !endpoint.url) endpoint.url = `http://localhost:${endpoint.port}`
-        const client = await getHttp(endpoint.url, options.networkVersion)
-        if (client) endpoints.http.push(endpoint.url) && clients.http.push(client)
-      }
-    }
-  
-    if (options.ws) {
-      for (const endpoint of options.ws) {
-        if (endpoint.port && !endpoint.url) endpoint.url = `ws://localhost:${endpoint.port}`      
-        const client = await getWS(endpoint.url, options.networkVersion)
-        client && endpoints.ws.push(endpoint.url) && clients.ws.push(client)
-      }
-    }
-    if (endpoints.http.length === 0 && endpoints.ws.length === 0) throw new Error(`no remotes connected`)
-  } else if (options.mode === 'direct') {
-    await new Node({ network: options.network, stars: options.stars, networkVersion: options.networkVersion }, password)
-    await nodeConfig({ network: options.network, stars: options.stars, networkVersion: options.networkVersion })
-
-    chain = await new Chain()
-
-    if (options.ws) {
-      const importee = await import('@leofcoin/endpoints/ws')
-      const wsServer = importee.default
-
-      for (const endpoint of options.ws) {
-        if (endpoint.port && !endpoint.url) endpoint.url = `ws://localhost:${endpoint.port}`
-        
-        await wsServer(chain, endpoint.port, options.networkVersion)
-        endpoints.ws.push(endpoint.url)
-        
-        const client = await getWS(endpoint.url, options.networkVersion)
-        client && clients.ws.push(client)
-      } 
-    }
-
-    if (options.http) {
-      const importee = await import('@leofcoin/endpoints/http')
-      const httpServer = importee.default
-
-      for (const endpoint of options.http) {
-        if (endpoint.port && !endpoint.url) endpoint.url = `http://localhost:${endpoint.port}`
-
-        await httpServer(chain, endpoint.port, options.networkVersion)
-        endpoints.http.push(endpoint.url)
-
-        const client = await getHttp(endpoint.url, options.networkVersion)
-        client && clients.http.push(client)
-      }
-    }
-  } else {
-    await new Node({ network: options.network, stars: options.stars, networkVersion: options.networkVersion }, password)
-    await nodeConfig({ network: options.network, stars: options.stars, networkVersion: options.networkVersion })
-
-    chain = await new Chain()
-
-    if (options.ws) {
-      const importee = await import('@leofcoin/endpoints/ws')
-      const wsServer = importee.default
-
-      for (const endpoint of options.ws) {
-        if (endpoint.port && !endpoint.url) endpoint.url = `ws://localhost:${endpoint.port}`
-        await wsServer(chain, endpoint.port, options.networkVersion)
-        endpoints.ws.push(endpoint.url)
-      } 
-    }
-
-    if (options.http) {
-      const importee = await import('@leofcoin/endpoints/http')
-      const httpServer = importee.default
-
-      for (const endpoint of options.http) {
-        if (endpoint.port && !endpoint.url) endpoint.url = `http://localhost:${endpoint.port}`
-        await httpServer(chain, endpoint.port, options.networkVersion)
-        endpoints.http.push(endpoint.url)
-      }
-    }
-  }
-  
-  return {
-    chain,
-    mode: options.mode,
-    endpoints,
-    clients
-  }
-}
-
-export { launch as default}

package/test.js

@@ -1,8 +0,0 @@
-import launch from './index.js'
-
-const {chain, endpoints, clients, mode } = await launch({
-  network: 'leofcoin:peach',
-  networkVersion: 'peach',
-  mode: 'direct'
-})
-console.log(await clients.ws[0].networkStats());

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "NodeNext",
-    "outDir": "./",
-    "moduleResolution":"nodenext",
-    "allowJs": true,
-    "declaration": true
-  },
-  "include": [
-    "./src/**/*"
-  ],
-  "exclude": ["./node_modules"]
-}