@stacks/network 3.0.0 → 3.2.1-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/network",
-  "version": "3.0.0",
+  "version": "3.2.1-beta.0",
   "description": "Library for Stacks network operations",
   "keywords": [
     "stacks",
@@ -23,14 +23,16 @@
   },
   "scripts": {
     "start": "tsc -b tsconfig.build.json --watch --verbose",
-    "build": "npm run clean && npm run build:cjs && npm run build:esm",
+    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:umd && npm run build:polyfill",
     "build:cjs": "tsc -b tsconfig.build.json",
     "build:esm": "tsc -p tsconfig.build.json --module ES6 --outDir ./dist/esm",
     "build:umd": "webpack --config webpack.config.js",
+    "build:polyfill": "NODE_OPTIONS=--max-old-space-size=8192 rollup -c ../../configs/rollup.config.js && rimraf dist/polyfill/dist",
     "clean": "rimraf dist && tsc -b tsconfig.build.json --clean",
     "typecheck": "tsc --noEmit",
     "typecheck:watch": "npm run typecheck -- --watch",
-    "prepublishOnly": "npm run test && npm run build && npm run build:umd",
+    "pack": "npm pack",
+    "prepublishOnly": "npm run test && npm run build",
     "test": "jest",
     "test:watch": "jest --watch --coverage=false"
   },
@@ -38,25 +40,28 @@
     "url": "https://github.com/blockstack/blockstack.js/issues"
   },
   "dependencies": {
-    "@stacks/common": "^3.0.0"
+    "@stacks/common": "^3.2.1-beta.0"
   },
   "devDependencies": {
     "@types/jest": "^26.0.22",
     "jest": "^26.6.3",
     "jest-fetch-mock": "^3.0.3",
     "jest-module-name-mapper": "^0.1.5",
+    "process": "^0.11.10",
     "rimraf": "^3.0.2",
     "ts-jest": "^26.5.5",
     "ts-loader": "^9.1.1",
     "typescript": "^4.2.4",
     "webpack": "^5.36.1",
+    "webpack-bundle-analyzer": "^4.5.0",
     "webpack-cli": "^4.6.0"
   },
   "sideEffects": false,
+  "typings": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
-  "typings": "dist/index.d.ts",
-  "umd:main": "dist/index.umd.js",
-  "unpkg": "dist/index.umd.js",
-  "gitHead": "728b58358f2876d282f511ba1fc6c4fa9a1ac2f3"
+  "browser": "dist/polyfill/index.js",
+  "umd:main": "dist/umd/index.js",
+  "unpkg": "dist/umd/index.js",
+  "gitHead": "bf5692b4b8eade0bc390b149bd6f7aafdda24f2d"
 }

package/src/index.ts

@@ -8,48 +8,10 @@ export interface NetworkConfig {
   url: string;
 }
 
-export interface StacksNetwork {
-  version: TransactionVersion;
-  chainId: ChainID;
-  bnsLookupUrl: string;
-  readonly coreApiUrl: string;
-  broadcastEndpoint: string;
-  transferFeeEstimateEndpoint: string;
-  transactionFeeEstimateEndpoint: string;
-  accountEndpoint: string;
-  contractAbiEndpoint: string;
-  readOnlyFunctionCallEndpoint: string;
-  isMainnet(): boolean;
-  getBroadcastApiUrl: () => string;
-  getTransferFeeEstimateApiUrl: () => string;
-  getTransactionFeeEstimateApiUrl: () => string;
-  getAccountApiUrl: (address: string) => string;
-  getAbiApiUrl: (address: string, contract: string) => string;
-  getReadOnlyFunctionCallApiUrl: (
-    contractAddress: string,
-    contractName: string,
-    functionName: string
-  ) => string;
-  getInfoUrl: () => string;
-  getBlockTimeInfoUrl: () => string;
-  getPoxInfoUrl: () => string;
-  getRewardsUrl: (address: string, options?: any) => string;
-  getRewardHoldersUrl: (address: string, options?: any) => string;
-  getRewardsTotalUrl: (address: string) => string;
-  getStackerInfoUrl: (contractAddress: string, contractName: string) => string;
-
-  /**
-   * Get WHOIS-like information for a name, including the address that owns it,
-   * the block at which it expires, and the zone file anchored to it (if available).
-   *
-   * This is intended for use in third-party wallets or in DApps that register names.
-   * @param fullyQualifiedName the name to query.  Can be on-chain of off-chain.
-   * @return a promise that resolves to the WHOIS-like information
-   */
-  getNameInfo: (fullyQualifiedName: string) => any;
-}
+export const StacksNetworks = ['mainnet', 'testnet'] as const;
+export type StacksNetworkName = typeof StacksNetworks[number];
 
-export class StacksMainnet implements StacksNetwork {
+export class StacksNetwork {
   version = TransactionVersion.Mainnet;
   chainId = ChainID.Mainnet;
   bnsLookupUrl = 'https://stacks-node-api.mainnet.stacks.co';
@@ -62,10 +24,33 @@ export class StacksMainnet implements StacksNetwork {
 
   readonly coreApiUrl: string;
 
-  constructor(networkUrl: NetworkConfig = { url: HIRO_MAINNET_DEFAULT }) {
-    this.coreApiUrl = networkUrl.url;
+  constructor(networkConfig: NetworkConfig) {
+    this.coreApiUrl = networkConfig.url;
   }
 
+  static fromName = (networkName: StacksNetworkName): StacksNetwork => {
+    switch (networkName) {
+      case 'mainnet':
+        return new StacksMainnet();
+      case 'testnet':
+        return new StacksTestnet();
+      default:
+        throw new Error(
+          `Invalid network name provided. Must be one of the following: ${StacksNetworks.join(
+            ', '
+          )}`
+        );
+    }
+  };
+
+  static fromNameOrNetwork = (network: StacksNetworkName | StacksNetwork) => {
+    if (typeof network !== 'string' && 'version' in network) {
+      return network;
+    }
+
+    return StacksNetwork.fromName(network);
+  };
+
   isMainnet = () => this.version === TransactionVersion.Mainnet;
   getBroadcastApiUrl = () => `${this.coreApiUrl}${this.broadcastEndpoint}`;
   getTransferFeeEstimateApiUrl = () => `${this.coreApiUrl}${this.transferFeeEstimateEndpoint}`;
@@ -133,7 +118,16 @@ export class StacksMainnet implements StacksNetwork {
   }
 }
 
-export class StacksTestnet extends StacksMainnet implements StacksNetwork {
+export class StacksMainnet extends StacksNetwork {
+  version = TransactionVersion.Mainnet;
+  chainId = ChainID.Mainnet;
+
+  constructor(networkUrl: NetworkConfig = { url: HIRO_MAINNET_DEFAULT }) {
+    super(networkUrl);
+  }
+}
+
+export class StacksTestnet extends StacksNetwork {
   version = TransactionVersion.Testnet;
   chainId = ChainID.Testnet;
 
@@ -142,7 +136,7 @@ export class StacksTestnet extends StacksMainnet implements StacksNetwork {
   }
 }
 
-export class StacksMocknet extends StacksMainnet implements StacksNetwork {
+export class StacksMocknet extends StacksNetwork {
   version = TransactionVersion.Testnet;
   chainId = ChainID.Testnet;
 

package/CHANGELOG.md

@@ -1,52 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [2.0.1](https://github.com/blockstack/blockstack.js/compare/v2.0.1-beta.2...v2.0.1) (2021-08-09)
-
-**Note:** Version bump only for package @stacks/network
-
-
-
-
-
-## [2.0.1-beta.2](https://github.com/blockstack/blockstack.js/compare/v2.0.1-beta.1...v2.0.1-beta.2) (2021-08-06)
-
-**Note:** Version bump only for package @stacks/network
-
-
-
-
-
-## [2.0.1-beta.1](https://github.com/blockstack/blockstack.js/compare/v2.0.0-beta.1...v2.0.1-beta.1) (2021-07-26)
-
-
-### Bug Fixes
-
-* BREAKING CHANGE: make coreApiUrl readonly for stacks network and initialize in constructor ([5d8cf6d](https://github.com/blockstack/blockstack.js/commit/5d8cf6d366665dace2df8102049d3f7ac1bf437e))
-* broken types following diverged network config changes ([1cd9612](https://github.com/blockstack/blockstack.js/commit/1cd96128334465c461665cf079532f66b893b938))
-* removeread only and add private field to prevent run time assignment ([62709aa](https://github.com/blockstack/blockstack.js/commit/62709aa5b6483299718063482bc26d6e94cc8c1c))
-
-
-### Features
-
-* add regtest to list of available networks ([f572477](https://github.com/blockstack/blockstack.js/commit/f572477ca0e5bc5e862c8a4e2fcc276655ee55a3)), closes [#1041](https://github.com/blockstack/blockstack.js/issues/1041)
-
-
-
-
-
-# [2.0.0-beta.2](https://github.com/blockstack/blockstack.js/compare/v2.0.0-beta.1...v2.0.0-beta.2) (2021-07-26)
-
-
-### Bug Fixes
-
-* BREAKING CHANGE: make coreApiUrl readonly for stacks network and initialize in constructor ([5d8cf6d](https://github.com/blockstack/blockstack.js/commit/5d8cf6d366665dace2df8102049d3f7ac1bf437e))
-* broken types following diverged network config changes ([1cd9612](https://github.com/blockstack/blockstack.js/commit/1cd96128334465c461665cf079532f66b893b938))
-* removeread only and add private field to prevent run time assignment ([62709aa](https://github.com/blockstack/blockstack.js/commit/62709aa5b6483299718063482bc26d6e94cc8c1c))
-
-
-### Features
-
-* add regtest to list of available networks ([f572477](https://github.com/blockstack/blockstack.js/commit/f572477ca0e5bc5e862c8a4e2fcc276655ee55a3)), closes [#1041](https://github.com/blockstack/blockstack.js/issues/1041)