SHARD-1210: Add release commands

README.md

@@ -7,7 +7,7 @@ The foundational technology upon which all Shardus applications are built
 You can install Shardus Core via npm:
 
 ```sh
-npm i @shardus/core
+npm i @shardeum-foundation/core
 ```
 
 ## Installing and Building Locally
@@ -40,7 +40,7 @@ Additionally, you can link this project from another project using the following
 {
   ...
   "dependencies": {
-    "@shardus/core": "../shardus-core"
+    "@shardeum-foundation/core": "../shardus-core"
   },
   ...
 }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@shardus/core",
-  "version": "2.13.4-0",
+  "name": "@shardeum-foundation/core",
+  "version": "2.13.4-prerelease.2",
   "engines": {
     "node": "18.19.1"
   },
@@ -40,7 +40,11 @@
     "test-watch": "jest --watch",
     "depcheck": "depcheck --skip-missing --ignores webpack,webpack-cli,prettier,typescript-eslint,typescript-estree,@mapbox/node-pre-gyp,@types/estree",
     "format-check": "prettier --check './src/**/*.ts'",
-    "format-fix": "prettier --write './src/**/*.ts'"
+    "format-fix": "prettier --write './src/**/*.ts'",
+    "release:prerelease": "npm run prepare && npm version prerelease --preid=prerelease && git push --follow-tags && npm publish --tag prerelease",
+    "release:patch": "npm run prepare && npm version patch && git push --follow-tags && npm publish",
+    "release:minor": "npm run prepare && npm version minor && git push --follow-tags && npm publish",
+    "release:major": "npm run prepare && npm version major && git push --follow-tags && npm publish"
   },
   "repository": {
     "type": "git",
@@ -50,11 +54,11 @@
     "access": "public"
   },
   "dependencies": {
+    "@shardeum-foundation/lib-crypto-utils": "4.1.6-prerelease.0",
+    "@shardeum-foundation/lib-net": "1.4.1-prerelease.0",
+    "@shardeum-foundation/lib-types": "1.2.22-prerelease.1",
     "@hapi/sntp": "3.1.1",
     "@mapbox/node-pre-gyp": "1.0.10",
-    "@shardus/crypto-utils": "git+https://github.com/shardeum/lib-crypto-utils#dev",
-    "@shardus/net": "git+https://github.com/shardeum/lib-net#dev",
-    "@shardus/types": "git+https://github.com/shardeum/lib-types#dev",
     "@types/better-sqlite3": "7.6.3",
     "body-parser": "1.18.3",
     "bytenode": "1.3.4",
@@ -119,4 +123,4 @@
     "tough-cookie": "4.1.3",
     "postcss": "8.4.31"
   }
-}
+}

src/crypto/computePowGenerator.ts

@@ -1,4 +1,4 @@
-import * as crypto from '@shardus/crypto-utils'
+import * as crypto from '@shardeum-foundation/lib-crypto-utils'
 crypto.init('69fa4195670576c0160d660c3be36556ff8d504725be8a59b5a96509e0c994bc')
 
 function hex2bin(hex) {

src/crypto/index.ts

@@ -1,12 +1,12 @@
-import * as crypto from '@shardus/crypto-utils'
+import * as crypto from '@shardeum-foundation/lib-crypto-utils'
 import { ChildProcess, fork, Serializable } from 'child_process'
 import fs from 'fs'
 import Log4js from 'log4js'
 import path from 'path'
 import Logger, { logFlags } from '../logger'
 import * as Shardus from '../shardus/shardus-types'
 import Storage from '../storage'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 
 export type HashableObject = (object | string) & { sign?: Shardus.Sign }
 

src/debug/debug.ts

@@ -8,7 +8,7 @@ import { nestedCountersInstance } from '../utils/nestedCounters'
 import { logFlags } from '../logger'
 import { currentCycle } from '../p2p/CycleCreator'
 import * as ProblemNodeHandler from '../p2p/ProblemNodeHandler'
-import { Node } from '@shardus/types/build/src/p2p/NodeListTypes'
+import { Node } from '@shardeum-foundation/lib-types/build/src/p2p/NodeListTypes'
 import { nodes } from '../p2p/NodeList'
 const tar = require('tar-fs')
 const fs = require('fs')

src/http/index.ts

@@ -1,7 +1,7 @@
 import { parse as parseUrl } from 'url'
 import got from 'got'
 import { logFlags } from '../logger'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 import { stringifyReduceLimit } from '../utils'
 
 let _logger = null

src/load-detection/index.ts

@@ -6,7 +6,7 @@ import { profilerInstance, NodeLoad } from '../utils/profiler'
 import * as Context from '../p2p/Context'
 import { memoryReportingInstance } from '../utils/memoryReporting'
 import { isDebugModeMiddleware } from '../network/debugMiddleware'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 
 interface LoadDetection {
   highThreshold: number /** if load > highThreshold, then scale up request */

src/logger/index.ts

@@ -7,7 +7,7 @@ import * as http from '../http'
 import * as Shardus from '../shardus/shardus-types'
 import { profilerInstance } from '../utils/profiler'
 import { nestedCountersInstance } from '../utils/nestedCounters'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 const log4jsExtend = require('log4js-extend')
 import got from 'got'
 import { parse as parseUrl } from 'url'

src/network/debugMiddleware.ts

@@ -1,15 +1,15 @@
 import { isDebugMode, getDevPublicKeys, ensureKeySecurity, getMultisigPublicKeys } from '../debug'
 import * as Context from '../p2p/Context'
-import * as crypto from '@shardus/crypto-utils'
+import * as crypto from '@shardeum-foundation/lib-crypto-utils'
 import { DevSecurityLevel } from '../shardus/shardus-types'
 import SERVER_CONFIG from '../config/server'
 import { logFlags } from '../logger'
 import { nestedCountersInstance } from '../utils/nestedCounters'
-import { Utils } from '@shardus/types'
-import { SignedObject } from '@shardus/crypto-utils'
+import { Utils } from '@shardeum-foundation/lib-types'
+import { SignedObject } from '@shardeum-foundation/lib-crypto-utils'
 import * as CycleChain from '../p2p/CycleChain'
 import { contactArchiver, getStatusHistoryCopy } from '../p2p/Self'
-import { NodeStatus } from '@shardus/types/build/src/p2p/P2PTypes'
+import { NodeStatus } from '@shardeum-foundation/lib-types/build/src/p2p/P2PTypes'
 import { getNewestCycle } from '../p2p/Sync'
 
 const MAX_COUNTER_BUFFER_MILLISECONDS = 10000 // <- Nonce are essentially just timestamp. This number dictate how much time range we will tolerance.

src/network/index.ts

@@ -1,6 +1,6 @@
 import Sntp from '@hapi/sntp'
-import { Sn } from '@shardus/net'
-import { AppHeader } from '@shardus/net/build/src/types'
+import { Sn } from '@shardeum-foundation/lib-net'
+import { AppHeader } from '@shardeum-foundation/lib-net/build/src/types'
 import bodyParser from 'body-parser'
 import cors from 'cors'
 import { EventEmitter } from 'events'
@@ -19,7 +19,7 @@ import { formatErrorMessage } from '../utils'
 import { nestedCountersInstance } from '../utils/nestedCounters'
 import { profilerInstance } from '../utils/profiler'
 import NatAPI = require('nat-api')
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 
 /** TYPES */
 export interface IPInfo {

src/p2p/Active.ts

@@ -1,6 +1,6 @@
 import { Logger } from 'log4js'
 import { logFlags } from '../logger'
-import { P2P } from '@shardus/types'
+import { P2P } from '@shardeum-foundation/lib-types'
 import * as utils from '../utils'
 import { validateTypes } from '../utils'
 import * as Comms from './Comms'
@@ -10,12 +10,12 @@ import * as CycleChain from './CycleChain'
 import * as NodeList from './NodeList'
 import * as Self from './Self'
 import { profilerInstance } from '../utils/profiler'
-import { NodeStatus } from '@shardus/types/build/src/p2p/P2PTypes'
+import { NodeStatus } from '@shardeum-foundation/lib-types/build/src/p2p/P2PTypes'
 import { nestedCountersInstance } from '../utils/nestedCounters'
 import { getSortedStandbyJoinRequests } from './Join/v2'
 import { selectNodesFromReadyList } from './Join/v2/syncFinished'
 import { isDebugModeMiddleware } from '../network/debugMiddleware'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 import { nodeListFromStates } from "./Join";
 import { checkGossipPayload } from '../utils/GossipValidation'
 

src/p2p/Apoptosis.ts

@@ -18,7 +18,7 @@ it is saved and gossiped to other nodes.
 When the apoptosized field of a cycle record contains the node id
 of a particular node, the node is removed from the node list.
 */
-import { P2P } from '@shardus/types'
+import { P2P } from '@shardeum-foundation/lib-types'
 import { Handler } from 'express'
 import { isDebugMode } from '../debug'
 import { logFlags } from '../logger'
@@ -47,7 +47,7 @@ import { robustQuery } from './Utils'
 import { TypeIdentifierEnum } from '../types/enum/TypeIdentifierEnum'
 import { SQLDataTypes } from '../storage/utils/schemaDefintions'
 import { InternalRouteEnum } from '../types/enum/InternalRouteEnum'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 import { BadRequest, serializeResponseError } from '../types/ResponseError'
 import { RequestErrorEnum } from '../types/enum/RequestErrorEnum'
 import { getStreamWithTypeCheck, requestErrorHandler } from '../types/Helpers'

src/p2p/Archivers.ts

@@ -1,4 +1,4 @@
-import { hexstring, P2P, publicKey, StateManager } from '@shardus/types'
+import { hexstring, P2P, publicKey, StateManager } from '@shardeum-foundation/lib-types'
 import deepmerge from 'deepmerge'
 import * as http from '../http'
 import { logFlags } from '../logger'
@@ -23,16 +23,16 @@ import * as NodeList from './NodeList'
 import Timeout = NodeJS.Timeout
 import { apoptosizeSelf } from './Apoptosis'
 import { randomInt } from 'crypto'
-import { CycleRecord } from '@shardus/types/build/src/p2p/CycleCreatorTypes'
-import { StateMetaData } from '@shardus/types/build/src/p2p/SnapshotTypes'
-import { DataRequest, JoinedArchiver } from '@shardus/types/build/src/p2p/ArchiversTypes'
+import { CycleRecord } from '@shardeum-foundation/lib-types/build/src/p2p/CycleCreatorTypes'
+import { StateMetaData } from '@shardeum-foundation/lib-types/build/src/p2p/SnapshotTypes'
+import { DataRequest, JoinedArchiver } from '@shardeum-foundation/lib-types/build/src/p2p/ArchiversTypes'
 import * as CycleChain from './CycleChain'
 import rfdc from 'rfdc'
 import { shardusGetTime } from '../network'
 import { reportLostArchiver } from '../p2p/LostArchivers/functions'
-import { ActiveNode } from '@shardus/types/build/src/p2p/SyncTypes'
+import { ActiveNode } from '@shardeum-foundation/lib-types/build/src/p2p/SyncTypes'
 import { Result, ResultAsync } from 'neverthrow'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 import { arch } from 'os'
 import { checkGossipPayload } from '../utils/GossipValidation'
 

src/p2p/Comms.ts

@@ -1,5 +1,5 @@
-import { AppHeader } from '@shardus/net/build/src/types'
-import { P2P } from '@shardus/types'
+import { AppHeader } from '@shardeum-foundation/lib-net/build/src/types'
+import { P2P } from '@shardeum-foundation/lib-types'
 import { Logger } from 'log4js'
 import { logFlags } from '../logger'
 import { ipInfo, shardusGetTime } from '../network'
@@ -25,7 +25,7 @@ import { RequestErrorEnum } from '../types/enum/RequestErrorEnum'
 import { getStreamWithTypeCheck, requestErrorHandler } from '../types/Helpers'
 import { TypeIdentifierEnum } from '../types/enum/TypeIdentifierEnum'
 import { InternalError, ResponseError, serializeResponseError } from '../types/ResponseError'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 import { nodeListFromStates } from './Join'
 
 /** ROUTES */

src/p2p/CycleAutoScale.ts

@@ -1,7 +1,7 @@
 import deepmerge from 'deepmerge'
 import { Logger } from 'log4js'
 import { logFlags } from '../logger'
-import { P2P } from '@shardus/types'
+import { P2P } from '@shardeum-foundation/lib-types'
 import { sleep, validateTypes, fastIsPicked } from '../utils'
 import * as Comms from './Comms'
 import { config, crypto, logger, stateManager } from './Context'
@@ -14,7 +14,7 @@ import { nestedCountersInstance } from '../utils/nestedCounters'
 import { enterRecovery, enterSafety } from './Modes'
 import { getOurNodeIndex } from './Utils'
 import { shardusGetTime } from '../network'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 
 /** STATE */
 

src/p2p/CycleChain.ts

@@ -1,6 +1,6 @@
 import { Logger } from 'log4js'
 import { crypto, logger, stateManager } from './Context'
-import { hexstring, P2P } from '@shardus/types'
+import { hexstring, P2P } from '@shardeum-foundation/lib-types'
 import { nodes } from './NodeList'
 import { nestedCountersInstance } from '../utils/nestedCounters'
 import { logFlags } from '../logger'

src/p2p/CycleCreator.ts

@@ -1,7 +1,7 @@
 import deepmerge from 'deepmerge'
 import { Logger } from 'log4js'
 import { logFlags } from '../logger'
-import { P2P } from '@shardus/types'
+import { P2P } from '@shardeum-foundation/lib-types'
 import * as utils from '../utils'
 // don't forget to add new modules here
 import * as Active from './Active'
@@ -25,7 +25,7 @@ import * as LostArchivers from './LostArchivers'
 import { compareQuery, Comparison } from './Utils'
 import { errorToStringFull, formatErrorMessage } from '../utils'
 import { nestedCountersInstance } from '../utils/nestedCounters'
-import { randomBytes } from '@shardus/crypto-utils'
+import { randomBytes } from '@shardeum-foundation/lib-crypto-utils'
 import { digestCycle, syncNewCycles } from './Sync'
 import { shardusGetTime } from '../network'
 import { InternalBinaryHandler } from '../types/Handler'
@@ -47,7 +47,7 @@ import path from 'path'
 import { getStreamWithTypeCheck, requestErrorHandler } from '../types/Helpers'
 import { RequestErrorEnum } from '../types/enum/RequestErrorEnum'
 import { BadRequest, InternalError, NotFound, serializeResponseError } from '../types/ResponseError'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 import { nodeListFromStates } from './Join'
 import { AJVSchemaEnum } from '../types/enum/AJVSchemaEnum'
 

src/p2p/CycleParser.ts

@@ -1,5 +1,5 @@
 import deepmerge from 'deepmerge'
-import { P2P } from '@shardus/types'
+import { P2P } from '@shardeum-foundation/lib-types'
 import { reversed } from '../utils'
 import * as CycleCreator from './CycleCreator'
 

src/p2p/GlobalAccounts.ts

@@ -5,7 +5,7 @@
  */
 
 import { logFlags } from '../logger'
-import { P2P } from '@shardus/types'
+import { P2P } from '@shardeum-foundation/lib-types'
 import ShardFunctions from '../state-manager/shardFunctions'
 import * as utils from '../utils'
 import * as Comms from './Comms'
@@ -22,7 +22,7 @@ import { RequestErrorEnum } from '../types/enum/RequestErrorEnum'
 import { getStreamWithTypeCheck, requestErrorHandler } from '../types/Helpers'
 import { TypeIdentifierEnum } from '../types/enum/TypeIdentifierEnum'
 import { MakeReceiptReq, deserializeMakeReceiptReq, serializeMakeReceiptReq } from '../types/MakeReceipReq'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 
 /** ROUTES */
 // [TODO] - need to add validattion of types to the routes

src/p2p/Join/index.ts

@@ -1,8 +1,8 @@
 import deepmerge from 'deepmerge'
 import { version } from '../../../package.json'
 import * as http from '../../http'
 import { logFlags } from '../../logger'
-import { hexstring, P2P } from '@shardus/types'
+import { hexstring, P2P } from '@shardeum-foundation/lib-types'
 import * as utils from '../../utils'
 import { validateTypes, isEqualOrNewerVersion } from '../../utils'
 import * as Comms from '../Comms'
@@ -11,7 +11,7 @@
 import * as CycleCreator from '../CycleCreator'
 import * as NodeList from '../NodeList'
 import * as Self from '../Self'
 import { getOurNodeIndex, robustQuery } from '../Utils'
 import { isBogonIP, isInvalidIP, isIPv6 } from '../../utils/functions/checkIP'
 import { nestedCountersInstance } from '../../utils/nestedCounters'
 import { Logger } from 'log4js'
@@ -28,9 +28,9 @@
 import { err, ok, Result } from 'neverthrow'
 import { drainSelectedPublicKeys, forceSelectSelf } from './v2/select'
 import { deleteStandbyNode, drainNewUnjoinRequests, processNewUnjoinRequest } from './v2/unjoin'
-import { JoinRequest } from '@shardus/types/build/src/p2p/JoinTypes'
+import { JoinRequest } from '@shardeum-foundation/lib-types/build/src/p2p/JoinTypes'
 import { updateNodeState } from '../Self'
 import { HTTPError } from 'got'
 import {
   drainLostAfterSelectionNodes,
   drainSyncStarted,
@@ -41,14 +41,14 @@
 //import { getLastCycleStandbyRefreshRequest, resetLastCycleStandbyRefreshRequests, drainNewStandbyRefreshRequests } from './v2/standbyRefresh'
 import { drainNewStandbyRefreshRequests, addStandbyRefresh } from './v2/standbyRefresh'
 import rfdc from 'rfdc'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 import { neverGoActive } from '../Active'
 
 /** STATE */
 
 let p2pLogger: Logger
 let mainLogger: Logger
 const clone = rfdc()
 
 let requests: P2P.JoinTypes.JoinRequest[]
 let seen: Set<P2P.P2PTypes.Node['publicKey']>
@@ -60,8 +60,8 @@
 let queuedUnjoinRequestsForNextCycle: P2P.JoinTypes.SignedUnjoinRequest[] = []
 let queuedUnjoinRequestsForThisCycle: P2P.JoinTypes.SignedUnjoinRequest[] = []
 
 let cyclesToDelaySyncStarted = -1
 let cyclesToDelaySyncFinished = -1
 
 // whats this for? I was just going to use newStandbyRefreshRequests
 //let keepInStandbyCollector: Map<string, StandbyRefreshRequest>
@@ -447,7 +447,7 @@
 
           // Select the most recent nodes for removal
           for (let i = standbyList.length - 1; i >= 0 && removeCount < nodesToRemoveCount; i--) {
             const node = standbyList[i]
 
             // check if the node is not already marked for removal
             if (!standbyRemoveSet.has(node.nodeInfo.publicKey)) {
@@ -1655,7 +1655,7 @@
   let result: P2P.NodeListTypes.Node[] = []
 
   for (const state of states) {
     if (stateMappings[state]) {
       result = result.concat(stateMappings[state])
     }
   }

src/p2p/Join/routes.ts

@@ -7,7 +7,7 @@ import * as NodeList from '../NodeList'
 import * as Self from '../Self'
 import * as utils from '../../utils'
 import { Handler } from 'express'
-import { P2P } from '@shardus/types'
+import { P2P } from '@shardeum-foundation/lib-types'
 import {
   addJoinRequest,
   computeSelectionNum,
@@ -38,10 +38,10 @@ import {
   JoinRequest,
   SignedUnjoinRequest,
   StartedSyncingRequest,
-} from '@shardus/types/build/src/p2p/JoinTypes'
+} from '@shardeum-foundation/lib-types/build/src/p2p/JoinTypes'
 import { addSyncStarted } from './v2/syncStarted'
 import { addStandbyRefresh } from './v2/standbyRefresh'
-import { Utils } from '@shardus/types'
+import { Utils } from '@shardeum-foundation/lib-types'
 import { testFailChance } from '../../utils'
 import { shardusGetTime } from '../../network'
 import { verifyPayload } from '../../types/ajv/Helpers'

src/p2p/Join/v2/acceptance.ts

@@ -1,12 +1,12 @@
-import { hexstring, P2P } from "@shardus/types";
+import { hexstring, P2P } from "@shardeum-foundation/lib-types";
+import { JoinedConsensor } from "@shardeum-foundation/lib-types/build/src/p2p/JoinTypes";
+import { SignedObject } from "@shardeum-foundation/lib-types/build/src/p2p/P2PTypes";
 import { err, ok } from "neverthrow";
 import { EventEmitter } from "events";
 import { Result } from "neverthrow";
 import * as http from '../../../http'
 import { getRandom } from "../../../utils";
 import { crypto } from "../../Context";
-import { JoinedConsensor } from "@shardus/types/build/src/p2p/JoinTypes";
-import { SignedObject } from "@shardus/types/build/src/p2p/P2PTypes";
 import { getActiveNodesFromArchiver, getRandomAvailableArchiver } from "../../Utils";
 import * as Self from "../../Self";