@waves/js-test-env - npm Package Compare versions

Comparing version 0.3.0-beta.4 to 0.3.0-beta.5

augmentedGlobal.d.ts

@@ -1,4 +0,1 @@
-// /**
-//  * @module global
-//  */
 import {
@@ -14,3 +11,5 @@ IAliasParams,
     IDataParams,
-    IDataTransaction, IInvokeScriptParams, IInvokeScriptTransaction,
+    IDataTransaction,
+    IInvokeScriptParams,
+    IInvokeScriptTransaction,
     IIssueParams,
@@ -26,9 +25,14 @@ IIssueTransaction,
     IReissueTransaction,
-    ISetAssetScriptParams, ISetAssetScriptTransaction,
+    ISetAssetScriptParams,
+    ISetAssetScriptTransaction,
     ISetScriptParams,
-    ISetScriptTransaction, ISponsorshipParams, ISponsorshipTransaction,
+    ISetScriptTransaction,
+    ISponsorshipParams,
+    ISponsorshipTransaction,
     ITransferParams,
     ITransferTransaction,
     TOrder,
-    TSeedTypes, TTx, TTxParams,
+    TSeedTypes,
+    TTx,
+    TTxParams,
     WithId,
@@ -40,247 +44,266 @@ WithTxType,
 
+/**
+ * Contains seeds generated by setupAccounts function
+ * E.g:
+ * ```ts
+ * await setupAccounts({foo:10, bar: 20})
+ * console.log(accounts.foo, accounts.bar) // these variables now contain seeds from accounts with 10 and 20 wavelets
+ * ```
+ */
+export const accounts: Record<string, string>;
 
-declare global {
-    /**
-     * Contains seeds generated by setupAccounts function
-     * E.g:
-     * ```ts
-     * await setupAccounts({foo:10, bar: 20})
-     * console.log(accounts.foo, accounts.bar) // these variables now contain seeds from accounts with 10 and 20 wavelets
-     * ```
-     */
-    export const accounts: Record<string, string>;
 
+/// TRANSACTION CREATORS
+/**
+ * Creates alias transaction or signs already formed one. Creates alias for address.
+ * Alias could be used in place of address later
+ */
+export function alias(params: IAliasParams, seed?: TSeedTypes): IAliasTransaction & WithId
 
-    /// TRANSACTION CREATORS
-    /**
-     * Creates alias transaction or signs already formed one. Creates alias for address.
-     * Alias could be used in place of address later
-     */
-    export function alias(params: import('@waves/waves-transactions').IAliasParams, seed?: TSeedTypes): IAliasTransaction & WithId
+/**
+ * Creates burn transaction or signs already formed one. Burn transaction destroys tokens. You cannot burn WAVES
+ */
+export function burn(params: IBurnParams, seed?: TSeedTypes): IBurnTransaction & WithId
 
-    /**
-     * Creates burn transaction or signs already formed one. Burn transaction destroys tokens. You cannot burn WAVES
-     */
-    export function burn(params: IBurnParams, seed?: TSeedTypes): IBurnTransaction & WithId
+/**
+ * Creates cancel-lease transaction or signs already formed one
+ */
+export function cancelLease(params: ICancelLeaseParams, seed?: TSeedTypes): ICancelLeaseTransaction & WithId
 
-    /**
-     * Creates cancel-lease transaction or signs already formed one
-     */
-    export function cancelLease(params: ICancelLeaseParams, seed?: TSeedTypes): ICancelLeaseTransaction & WithId
+/**
+ * Creates cancel-order request or signs already formed one
+ */
+export function cancelOrder(params: ICancelOrderParams, seed?: TSeedTypes): ICancelOrder
 
-    /**
-     * Creates cancel-order request or signs already formed one
-     */
-    export function cancelOrder(params: ICancelOrderParams, seed?: TSeedTypes): ICancelOrder
+/**
+ * Creates data transaction or signs already formed one
+ */
+export function data(params: IDataParams, seed?: TSeedTypes): IDataTransaction & WithId
 
-    /**
-     * Creates data transaction or signs already formed one
-     */
-    export function data(params: IDataParams, seed?: TSeedTypes): IDataTransaction & WithId
+/**
+ * Creates issue transaction or signs already formed one
+ */
+export function issue(params: IIssueParams, seed?: TSeedTypes): IIssueTransaction & WithId
 
-    /**
-     * Creates issue transaction or signs already formed one
-     */
-    export function issue(params: IIssueParams, seed?: TSeedTypes): IIssueTransaction & WithId
+/**
+ * Creates reissue transaction or signs already formed one
+ */
+export function reissue(params: IReissueParams, seed?: TSeedTypes): IReissueTransaction & WithId
 
-    /**
-     * Creates reissue transaction or signs already formed one
-     */
-    export function reissue(params: IReissueParams, seed?: TSeedTypes): IReissueTransaction & WithId
+/**
+ * Creates lease transaction or signs already formed one
+ */
+export function lease(params: ILeaseParams, seed?: TSeedTypes): ILeaseTransaction & WithId
 
-    /**
-     * Creates lease transaction or signs already formed one
-     */
-    export function lease(params: ILeaseParams, seed?: TSeedTypes): ILeaseTransaction & WithId
+/**
+ * Creates mass-transfer transaction or signs already formed one
+ */
+export function massTransfer(params: IMassTransferParams, seed?: TSeedTypes): IMassTransferTransaction & WithId
 
-    /**
-     * Creates mass-transfer transaction or signs already formed one
-     */
-    export function massTransfer(params: IMassTransferParams, seed?: TSeedTypes): IMassTransferTransaction & WithId
+/**
+ * Creates order or signs already formed one
+ */
+export function order(params: IOrderParams, seed?: TSeedTypes): TOrder & WithId
 
-    /**
-     * Creates order or signs already formed one
-     */
-    export function order(params: IOrderParams, seed?: TSeedTypes): TOrder & WithId
+/**
+ * Creates transfer transaction or signs already formed one
+ */
+export function transfer(params: ITransferParams, seed?: TSeedTypes): ITransferTransaction & WithId
 
-    /**
-     * Creates transfer transaction or signs already formed one
-     */
-    export function transfer(params: ITransferParams, seed?: TSeedTypes): ITransferTransaction & WithId
+/**
+ * Creates set-script transaction or signs already formed one
+ */
+export function setScript(params: ISetScriptParams, seed?: TSeedTypes): ISetScriptTransaction & WithId
 
-    /**
-     * Creates set-script transaction or signs already formed one
-     */
-    export function setScript(params: ISetScriptParams, seed?: TSeedTypes): ISetScriptTransaction & WithId
+/**
+ * Creates set-asset-script transaction or signs already formed one
+ */
+export function setAssetScript(params: ISetAssetScriptParams, seed?: TSeedTypes): ISetAssetScriptTransaction & WithId
 
-    /**
-     * Creates set-asset-script transaction or signs already formed one
-     */
-    export function setAssetScript(params: ISetAssetScriptParams, seed?: TSeedTypes): ISetAssetScriptTransaction & WithId
+/**
+ * Creates invoke-script transaction or signs already formed one
+ */
+export function invokeScript(params: IInvokeScriptParams, seed?: TSeedTypes): IInvokeScriptTransaction & WithId
 
-    /**
-     * Creates invoke-script transaction or signs already formed one
-     */
-    export function invokeScript(params: IInvokeScriptParams, seed?: TSeedTypes): IInvokeScriptTransaction & WithId
+/**
+ * Creates sponsorship transaction or signs already formed one
+ */
+export function sponsorship(params: ISponsorshipParams, seed?: TSeedTypes): ISponsorshipTransaction & WithId
 
-    /**
-     * Creates sponsorship transaction or signs already formed one
-     */
-    export function sponsorship(params: ISponsorshipParams, seed?: TSeedTypes): ISponsorshipTransaction & WithId
+/**
+ * Signs arbitrary transaction
+ */
+export function signTx(params: TTx | (TTxParams & WithTxType), seed?: TSeedTypes): TTx
 
-    /**
-     * Signs arbitrary transaction
-     */
-    export function signTx(params: TTx | (TTxParams & WithTxType), seed?: TSeedTypes): TTx
 
+/// NODE INTERACTION
+/**
+ * Resolves when specified txId is mined into the block
+ * By default has 20s timeout and uses current environment node
+ */
+export function waitForTx(txId: string, options?: INodeRequestOptions): Promise<TTx>
 
-    /// NODE INTERACTION
-    /**
-     * Resolves when specified txId is mined into the block
-     * By default has 20s timeout and uses current environment node
-     */
-    export function waitForTx(txId: string, options?: INodeRequestOptions): Promise<TTx>
+/**
+ * Resolves N blocks after specified txId is mined into the block
+ * By default has 20s timeout and uses current environment node
+ */
+export function waitForTxWithNConfirmations(txId: string, confirmations: number, options?: INodeRequestOptions): Promise<TTx>
 
-    /**
-     * Resolves N blocks after specified txId is mined into the block
-     * By default has 20s timeout and uses current environment node
-     */
-    export function waitForTxWithNConfirmations(txId: string, confirmations: number, options?: INodeRequestOptions): Promise<TTx>
+/**
+ * Resolves N blocks after current blockchain height
+ * By default has 20s timeout and uses current environment node
+ */
+export function waitNBlocks(blocksCount: number, options?: INodeRequestOptions): Promise<void>
 
-    /**
-     * Resolves N blocks after current blockchain height
-     * By default has 20s timeout and uses current environment node
-     */
-    export function waitNBlocks(blocksCount: number, options?: INodeRequestOptions): Promise<void>
+/**
+ * Current blockchain height
+ * By default has 20s timeout and uses current environment node
+ */
+export function currentHeight(apiBase?: string): Promise<number>
 
-    /**
-     * Current blockchain height
-     * By default has 20s timeout and uses current environment node
-     */
-    export function currentHeight(apiBase?: string): Promise<number>
+/**
+ * Resolves after target height has been reached
+ * By default has 20s timeout and uses current environment node
+ */
+export function waitForHeight(target: number, options?: INodeRequestOptions): Promise<void>
 
-    /**
-     * Resolves after target height has been reached
-     * By default has 20s timeout and uses current environment node
-     */
-    export function waitForHeight(target: number, options?: INodeRequestOptions): Promise<void>
+/**
+ * Get account effective balance
+ * By default uses current environment address and node
+ */
+export function balance(address?: string, apiBase?: string): Promise<number>
 
-    /**
-     * Get account effective balance
-     * By default uses current environment address and node
-     */
-    export function balance(address?: string, apiBase?: string): Promise<number>
+/**
+ * Retrieve information about specific asset account balance
+ * By default uses current environment address and node
+ */
+export function assetBalance(assetId: string, address?: string, apiBase?: string): Promise<any>
 
-    /**
-     * Retrieve information about specific asset account balance
-     * By default uses current environment address and node
-     */
-    export function assetBalance(assetId: string, address?: string, apiBase?: string): Promise<any>
+/**
+ * Retrieve full information about waves account balance. Effective, generating etc
+ * By default uses current environment address and node
+ */
+export function balanceDetails(address?: string, apiBase?: string): Promise<any>
 
-    /**
-     * Retrieve full information about waves account balance. Effective, generating etc
-     * By default uses current environment address and node
-     */
-    export function balanceDetails(address?: string, apiBase?: string): Promise<any>
+/**
+ * Get full account dictionary
+ * By default uses current environment address and node
+ */
+export function accountData(address?: string, apiBase?: string): Promise<Record<string, IDataEntry>>
 
-    /**
-     * Get full account dictionary
-     * By default uses current environment address and node
-     */
-    export function accountData(address?: string, apiBase?: string): Promise<Record<string, IDataEntry>>
+/**
+ * Get data from account dictionary by key
+ * By default uses current environment address and node
+ */
+export function accountDataByKey(key: string, address?: string, apiBase?: string): Promise<IDataEntry>
 
-    /**
-     * Get data from account dictionary by key
-     * By default uses current environment address and node
-     */
-    export function accountDataByKey(key: string, address?: string, apiBase?: string): Promise<IDataEntry>
+/**
+ * Get invokeScript tx state changes
+ * By default uses current environment address and node
+ */
+export function stateChanges(invokeScriptTxId: string, apiBase?: string): Promise<any>
 
-    /**
-     * Get invokeScript tx state changes
-     * By default uses current environment address and node
-     */
-    export function stateChanges(invokeScriptTxId: string, apiBase?: string): Promise<any>
+/**
+ * Sends transaction to waves node
+ * By default uses current environment address and node
+ */
+export function broadcast(tx: TTx, apiBase?: string): Promise<any>
 
-    /**
-     * Sends transaction to waves node
-     * By default uses current environment address and node
-     */
-    export function broadcast(tx: TTx, apiBase?: string): Promise<any>
 
-
 // UTILITY
-    /**
-     * Returns file content as string. Either from 'ride' folder or WEB IDE storage
-     */
-    export function file(name?: string): string
+/**
+ * Returns file content as string. Either from 'ride' folder or WEB IDE storage
+ */
+export function file(name?: string): string
 
-    /**
-     * Shorthand for file()
-     */
-    export function contract(): Promise<string>
+/**
+ * Shorthand for file()
+ */
+export function contract(): Promise<string>
 
-    /**
-     * Generates key pair from seed
-     * By default uses current environment seed
-     */
-    export function keyPair(seed?: string): { publicKey: string, privateKey: string }
+/**
+ * Generates key pair from seed
+ * By default uses current environment seed
+ */
+export function keyPair(seed?: string): { publicKey: string, privateKey: string }
 
-    /**
-     * Generates public key from seed
-     * By default uses current environment seed
-     */
-    export function publicKey(seed?: string): string
+/**
+ * Generates public key from seed
+ * By default uses current environment seed
+ */
+export function publicKey(seed?: string): string
 
-    /**
-     * Generates private key from seed
-     * By default uses current environment seed
-     */
-    export function privateKey(seed?: string): string
+/**
+ * Generates private key from seed
+ * By default uses current environment seed
+ */
+export function privateKey(seed?: string): string
 
-    /**
-     * Generates address
-     * By default uses current environment seed and chainId
-     */
-    export function address(seed?: string, chainId?: string): string
+/**
+ * Generates address
+ * By default uses current environment seed and chainId
+ */
+export function address(seed?: string, chainId?: string): string
 
+/**
+ * Returns base64 representations of compiled ride file
+ */
+export function compile(code: string): string
+
+/**
+ * Signs arbitrary bytes
+ * By default uses current environment seed and chainId
+ */
+export function signBytes(bytes: Uint8Array, seed?: string): string
+
+
+export interface ISetupAccountsOptions {
     /**
-     * Returns base64 representations of compiled ride file
+     * Generated accounts have seed like 'name#' + nonce. E.g.: foo#ff4682. By default nonce is chosen randomly
+     * you can set nonce to have consistent seeds between tests
      */
-    export function compile(code: string): string
-
+    nonce?: string,
     /**
-     * Signs arbitrary bytes
-     * By default uses current environment seed and chainId
+     * Seed phrase for account, from which waves will be transferred to generated accounts.
+     * If not set current account will be used
      */
-    export function signBytes(bytes: Uint8Array, seed?: string): string
+    masterSeed?: string,
+}
 
+/**
+ * Generates test accounts with balances. Sends waves to generated accounts from master seed. Saves account seeds `accounts`
+ * E.g.: setupAccounts({foo:1000}). Now accounts['foo'] contains seed phrase for account and this account has
+ * 1000 wavelets
+ * By default uses current environment node and seed as masterSeed
+ */
+export function setupAccounts(balances: Record<string, number>, options?: ISetupAccountsOptions): Promise<Record<string, string>>
 
-    export interface ISetupAccountsOptions {
-        /**
-         * Generated accounts have seed like 'name#' + nonce. E.g.: foo#ff4682. By default nonce is chosen randomly
-         * you can set nonce to have consistent seeds between tests
-         */
-        nonce?: string,
-        /**
-         * Seed phrase for account, from which waves will be transferred to generated accounts.
-         * If not set current account will be used
-         */
-        masterSeed?: string,
-    }
+/**
+ * Shorthand for `chai.expect` [[chai]]
+ */
+export function expect(target: any, message?: string): any
 
-    /**
-     * Generates test accounts with balances. Sends waves to generated accounts from master seed. Saves account seeds `accounts`
-     * E.g.: setupAccounts({foo:1000}). Now accounts['foo'] contains seed phrase for account and this account has
-     * 1000 wavelets
-     * By default uses current environment node and seed as masterSeed
-     */
-    export function setupAccounts(balances: Record<string, number>, options?: ISetupAccountsOptions): Promise<Record<string, string>>
+/**
+ * Waves-crypto library https://www.npmjs.com/package/@waves/waves-crypto
+ * Available in global scope:
+ * ```js
+ * const addressBytes = crypto.base58Decode('3N77yhDrPTdLFjzNPZcBQPZLDg11EHAB7xF')
+ * ```
+ */
+export module wavesCrypto {
 
-    /**
-     * waves-crypto library https://www.npmjs.com/package/@waves/waves-crypto
-     */
-    export module wavesCrypto {
+}
 
-    }
 
+/**
+ * Chai assertion library https://www.chaijs.com/
+ * with chaiAsPromised plugin https://www.chaijs.com/plugins/chai-as-promised/
+ *  * Available in global scope:
+ * ```js
+ * chai.expect(2 === 3).to.be.false
+ * ```
+ * You can always use shorthand for [[expect]]
+ */
+export module chai {
+
 }

index.js

@@ -6,2 +6,5 @@ "use strict";
 const ride_js_1 = require("@waves/ride-js");
+const chai_1 = tslib_1.__importDefault(require("chai"));
+const chai_as_promised_1 = tslib_1.__importDefault(require("chai-as-promised"));
+chai_1.default.use(chai_as_promised_1.default);
 function addEnvFunctionsToGlobal(global, options) {
@@ -21,2 +24,4 @@ function withDefaults(options = {}) {
     global.wavesCrypto = wt.libs.crypto;
+    global.chai = chai_1.default;
+    global.expect = chai_1.default.expect;
     global.alias = injectEnv(wt.alias);
@@ -23,0 +28,0 @@ global.burn = injectEnv(wt.burn);

package.json

 {
   "name": "@waves/js-test-env",
-  "version": "0.3.0-beta.4",
+  "version": "0.3.0-beta.5",
   "description": "",
@@ -25,5 +25,9 @@ "main": "dist/index.js",
     "@waves/waves-transactions": "^3.12.1",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
     "tslib": "^1.10.0"
   },
   "devDependencies": {
+    "@types/chai": "^4.1.7",
+    "@types/chai-as-promised": "^7.1.0",
     "@types/node": "^12.0.8",
@@ -30,0 +34,0 @@ "tslint": "^5.17.0",

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16300

increased by0.43%

Lines of code

360

increased by7.78%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

5

increased by66.67%

Dev dependency count

7

increased by40%

Dependency changes

• + Addedchai@^4.2.0

• + Addedchai-as-promised@^7.1.1

• + Addedassertion-error@1.1.0(transitive)

• + Addedchai@4.5.0(transitive)

• + Addedchai-as-promised@7.1.2(transitive)

• + Addedcheck-error@1.0.3(transitive)

• + Addeddeep-eql@4.1.4(transitive)

• + Addedget-func-name@2.0.2(transitive)

• + Addedloupe@2.3.7(transitive)

• + Addedpathval@1.1.1(transitive)

• + Addedtype-detect@4.1.0(transitive)