@0x/types - npm Package Compare versions

Comparing version 2.5.0-beta.0 to 2.5.0-beta.1

CHANGELOG.json

 [
     {
+        "version": "2.5.0-beta.1",
+        "changes": [
+            {
+                "note": "Add `SendTransactionOpts` and `AwaitTransactionSuccessOpts` types for contract wrappers",
+                "pr": 2243
+            },
+            {
+                "note": "All references to network ID have been removed, and references to chain ID have been introduced instead",
+                "pr": 2313
+            }
+        ],
+        "timestamp": 1573159180
+    },
+    {
         "version": "2.5.0-beta.0",
@@ -4,0 +18,0 @@ "changes": [

CHANGELOG.md

@@ -8,2 +8,7 @@ <!--
 
+## v2.5.0-beta.1 - _November 7, 2019_
+
+    * Add `SendTransactionOpts` and `AwaitTransactionSuccessOpts` types for contract wrappers (#2243)
+    * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313)
+
 ## v2.5.0-beta.0 - _October 3, 2019_
@@ -10,0 +15,0 @@

lib/index.d.ts

 import { BigNumber } from 'bignumber.js';
-import { ContractAbi, ContractEventArg, ContractNetworks, DecodedLogArgs, DevdocOutput, LogWithDecodedArgs } from 'ethereum-types';
+import { ContractAbi, ContractChains, ContractEventArg, DecodedLogArgs, DevdocOutput, LogWithDecodedArgs } from 'ethereum-types';
 export interface Order {
@@ -87,4 +87,4 @@ chainId: number;
     abi: ContractAbi;
-    networks: {
-        [networkId: number]: {
+    chains: {
+        [chainId: number]: {
             address: string;
@@ -419,3 +419,3 @@ };
 export interface RequestOpts {
-    networkId?: number;
+    chainId?: number;
 }
@@ -582,2 +582,13 @@ export interface PagedRequestOpts {
 }
+/**
+ * * shouldValidate: Flag indicating whether the library should make attempts to validate a transaction before
+ * broadcasting it. For example, order has a valid signature, maker has sufficient funds, etc. Default=true.
+ * * pollingIntervalMs: Used with `awaitTransactionSuccessAsync` to determine polling interval in milliseconds
+ * * timeoutMs: Used with `awaitTransactionSuccessAsync` to determine timeout in milliseconds
+ */
+export interface SendTransactionOpts {
+    shouldValidate?: boolean;
+    pollingIntervalMs?: number;
+    timeoutMs?: number;
+}
 export interface ElementType {
@@ -642,19 +653,2 @@ name: string;
 }
-export interface SimpleContractArtifact {
-    schemaVersion: string;
-    contractName: string;
-    compilerOutput: SimpleStandardContractOutput;
-    networks: ContractNetworks;
-}
-export interface SimpleStandardContractOutput {
-    abi: ContractAbi;
-    evm: SimpleEvmOutput;
-    devdoc?: DevdocOutput;
-}
-export interface SimpleEvmOutput {
-    bytecode: SimpleEvmBytecodeOutput;
-}
-export interface SimpleEvmBytecodeOutput {
-    object: string;
-}
 export interface DutchAuctionDetails {
@@ -750,2 +744,36 @@ beginTimeSeconds: BigNumber;
 }
+/**
+ * Used with `sendTransactionAsync`
+ * * shouldValidate: Flag indicating whether the library should make attempts to validate a transaction before
+ * broadcasting it. For example, order has a valid signature, maker has sufficient funds, etc. Default=true.
+ */
+export interface SendTransactionOpts {
+    shouldValidate?: boolean;
+}
+/**
+ * Used with `awaitTransactionSuccessAsync`
+ * * pollingIntervalMs: Determine polling intervals in milliseconds
+ * * timeoutMs: Determines timeout in milliseconds
+ */
+export interface AwaitTransactionSuccessOpts extends SendTransactionOpts {
+    pollingIntervalMs?: number;
+    timeoutMs?: number;
+}
+export interface SimpleContractArtifact {
+    schemaVersion: string;
+    contractName: string;
+    compilerOutput: SimpleStandardContractOutput;
+    chains: ContractChains;
+}
+export interface SimpleStandardContractOutput {
+    abi: ContractAbi;
+    evm: SimpleEvmOutput;
+    devdoc?: DevdocOutput;
+}
+export interface SimpleEvmOutput {
+    bytecode: SimpleEvmBytecodeOutput;
+}
+export interface SimpleEvmBytecodeOutput {
+    object: string;
+}
 //# sourceMappingURL=index.d.ts.map

package.json

 {
     "name": "@0x/types",
-    "version": "2.5.0-beta.0",
+    "version": "2.5.0-beta.1",
     "engines": {
@@ -26,3 +26,3 @@ "node": ">=6.12"
     "devDependencies": {
-        "@0x/tslint-config": "^3.0.1",
+        "@0x/tslint-config": "^3.1.0-beta.1",
         "make-promises-safe": "^1.1.0",
@@ -36,3 +36,3 @@ "shx": "^0.2.2",
         "bignumber.js": "~8.0.2",
-        "ethereum-types": "^2.2.0-beta.0"
+        "ethereum-types": "^2.2.0-beta.1"
     },
@@ -42,3 +42,3 @@ "publishConfig": {
     },
-    "gitHead": "c60d1e50c53f4763f7c5ac99f8d3c7860c15a2b7"
+    "gitHead": "3b9d84fa5841e419239690e74235b92fbf6b4ba5"
 }

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

Improved metrics

Total package byte prevSize

86675

increased by2.66%

Lines of code

1637

increased by2.63%

Dependency changes

• Updatedethereum-types@^2.2.0-beta.1