wapi-client 0.9.1 → 0.9.4

package/dist/lib/validator.cjs

@@ -257,7 +257,7 @@ var ajv = new import_ajv.default({
   coerceTypes: true,
   // Client side allows looser input, API will not
   formats: {
-    validkey: /^[A-Za-z_][A-Za-z0-9_-]+?$/
+    validkey: /^(?!.*\.\.)[a-zA-Z_][a-zA-Z0-9_.-]*[a-zA-Z0-9_-]$/
   },
   strict: false
 });

package/dist/lib/validator.js

@@ -224,7 +224,7 @@ var ajv = new Ajv({
   coerceTypes: true,
   // Client side allows looser input, API will not
   formats: {
-    validkey: /^[A-Za-z_][A-Za-z0-9_-]+?$/
+    validkey: /^(?!.*\.\.)[a-zA-Z_][a-zA-Z0-9_.-]*[a-zA-Z0-9_-]$/
   },
   strict: false
 });

package/dist/lib/ws-types.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="ws" />
 import WebSocket from 'modern-isomorphic-ws';
 export interface ErrorEvent {
     error: unknown;

package/dist/txs/create-distribution/create-distribution.enums.d.ts

@@ -2,8 +2,8 @@ import { ITxGeneralOptions, ITxDistributorLeftoverRule } from '../tx-consts.enum
 import { UniqueWalletFilter } from '../get-wallet/get-wallet.enums';
 import { UniqueTokenFilter } from '../get-token/get-token.enums';
 import { UniqueTransferGroupFilter } from '../get-transfer-group/get-transfer-group.enums';
-import { TransferTable } from '../../db/transfer/transfer.enums';
 import { TransferGroupTable } from '../../db/transfer-group/transfer-group.enums';
+import { TransferTable } from '../../db/transfer/transfer.enums';
 /**
  * Optional flags for input
  */

package/dist/txs/find-balance-many/find-balance-many.enums.d.ts

@@ -1,6 +1,6 @@
 import { ITxLimitingOptions, ITxGeneralOptions, ITxSelectOptions, ITxDeselectOptions, ITxMetadataOptions, ITxOrderingInput, ITxFindMetadata } from '../tx-consts.enums';
-import { DbFilterMetadata, DbFilterFunctionWhereInner, DbFilterFunctionWherePrimitive, DbFilterFunctionWherePrimitiveForeign, DbFilterFunctionWhereObject, DbFilterFunctionWhereIns, DbFilterFunctionWhereNulls, DbFilterFunctionWhereMetadataIns, DbFilterFunctionWhereMetadataNulls } from '../../db/consts.enums';
 import { TransferLogTableFields } from '../../db/transfer-log/transfer-log.enums';
+import { DbFilterMetadata, DbFilterFunctionWhereInner, DbFilterFunctionWherePrimitive, DbFilterFunctionWherePrimitiveForeign, DbFilterFunctionWhereObject, DbFilterFunctionWhereIns, DbFilterFunctionWhereNulls, DbFilterFunctionWhereMetadataIns, DbFilterFunctionWhereMetadataNulls } from '../../db/consts.enums';
 import { UniqueWalletFilter } from '../get-wallet/get-wallet.enums';
 import { UniqueTokenFilter } from '../get-token/get-token.enums';
 import { UniqueTransferFilter } from '../get-transfer/get-transfer.enums';

package/dist/txs/find-token-many/find-token-many.enums.d.ts

@@ -1,12 +1,13 @@
 import { ITxLimitingOptions, ITxGeneralOptions, ITxSelectOptions, ITxDeselectOptions, ITxMetadataOptions, ITxOrderingInput, ITxFindMetadata } from '../tx-consts.enums';
-import { DbFilterMetadata, DbFilterFunctionWhereInner, DbFilterFunctionWherePrimitive, DbFilterFunctionWherePrimitiveForeign, DbFilterFunctionWhereObject, DbFilterFunctionWhereIns, DbFilterFunctionWhereNulls, DbFilterFunctionWhereMetadataIns, DbFilterFunctionWhereMetadataPrimitive, DbFilterFunctionWhereMetadataNulls } from '../../db/consts.enums';
 import { TokenTableFields } from '../../db/token/token.enums';
+import { DbFilterMetadata, DbFilterFunctionWhereInner, DbFilterFunctionWherePrimitive, DbFilterFunctionWherePrimitiveForeign, DbFilterFunctionWhereObject, DbFilterFunctionWhereIns, DbFilterFunctionWhereNulls, DbFilterFunctionWhereMetadataIns, DbFilterFunctionWhereMetadataPrimitive, DbFilterFunctionWhereMetadataNulls } from '../../db/consts.enums';
 import { UniqueWalletFilter } from '../get-wallet/get-wallet.enums';
-import { Token } from '../get-token/get-token.enums';
+import { Token, TokenWithBalance } from '../get-token/get-token.enums';
 /**
  * Optional flags for input
  */
 export interface FindTokenManyAdditionalOptions {
+    include_balance?: boolean;
 }
 /**
  * Optional flags for input ordering
@@ -77,6 +78,6 @@ export interface FindTokenManyTxOutput {
     /**
      * Found tokens
      */
-    tokens: Token[];
+    tokens: Token[] | TokenWithBalance[];
     metadata: ITxFindMetadata;
 }

package/dist/txs/find-token-many/find-token-many.schema.input.json

@@ -42,6 +42,12 @@
       "description": "Optional flags for input",
       "type": "object",
       "default": {},
+      "properties": {
+        "include_balance": {
+          "description": "Return the total system balance of token",
+          "type": "boolean"
+        }
+      },
       "$typescript": "{\"additionalProperties\":false}"
     },
     "find_token_many_ordering_options": {

package/dist/txs/find-token-many/find-token-many.schema.output.json

@@ -9,7 +9,14 @@
       "description": "Found tokens",
       "type": "array",
       "items": {
-        "$ref": "/txs/get-token/get-token.schema.output.json#/definitions/token"
+        "anyOf": [
+          {
+            "$ref": "/txs/get-token/get-token.schema.output.json#/definitions/token"
+          },
+          {
+            "$ref": "/txs/get-token/get-token.schema.output.json#/definitions/token_with_balance"
+          }
+        ]
       }
     },
     "metadata": {

package/dist/txs/find-transfer-group-many/find-transfer-group-many.enums.d.ts

@@ -1,13 +1,12 @@
 import { ITxLimitingOptions, ITxGeneralOptions, ITxSelectOptions, ITxDeselectOptions, ITxMetadataOptions, ITxOrderingInput, ITxFindMetadata } from '../tx-consts.enums';
-import { UniqueWalletFilter } from '../get-wallet/get-wallet.enums';
+import { TransferGroupTableFields } from '../../db/transfer-group/transfer-group.enums';
 import { DbFilterMetadata, DbFilterFunctionWhereInner, DbFilterFunctionWherePrimitive, DbFilterFunctionWherePrimitiveIdentifier, DbFilterFunctionWhereObject, DbFilterFunctionWhereIns, DbFilterFunctionWhereNulls, DbFilterFunctionWhereMetadataIns, DbFilterFunctionWhereMetadataPrimitive, DbFilterFunctionWhereMetadataNulls } from '../../db/consts.enums';
 import { UniqueTransferGroupFilter, TransferGroup } from '../get-transfer-group/get-transfer-group.enums';
-import { TransferGroupTableFields } from '../../db/transfer-group/transfer-group.enums';
 export interface FindTransferGroupManyAdditionalOptions {
     /**
      * Return running balance for each transfer_group for wallet in question
      */
-    return_transfers?: UniqueWalletFilter;
+    return_transfers_count?: boolean;
 }
 /**
  * Optional flags for input ordering
@@ -82,10 +81,17 @@ export interface FindTransferGroupManyTxInput {
  *
  * @category Output
  */
+export interface TransferGroupTransfersCount {
+    /**
+     * Number of transfers in the transfer_group
+     */
+    transfers_count?: number;
+}
+export type TransferGroupWithTransfersCount = TransferGroup & TransferGroupTransfersCount;
 export interface FindTransferGroupManyTxOutput {
     /**
      * Found transfers
      */
-    transfer_groups: TransferGroup[];
+    transfer_groups: TransferGroupWithTransfersCount[];
     metadata: ITxFindMetadata;
 }

package/dist/txs/find-transfer-group-many/find-transfer-group-many.schema.input.json

@@ -42,9 +42,10 @@
       "$typescript": "{\"additionalProperties\":false}",
       "type": "object",
       "properties": {
-        "return_transfers": {
-          "description": "Return running balance for each transfer_group for wallet in question",
-          "$ref": "/txs/get-wallet/get-wallet.schema.input.json#/definitions/unique_wallet_filter"
+        "return_transfers_count": {
+          "description": "Return number of transfers in the transfer_group",
+          "type": "boolean",
+          "default": false
         }
       }
     },

package/dist/txs/find-transfer-group-many/find-transfer-group-many.schema.output.json

@@ -9,13 +9,35 @@
       "description": "Found transfers",
       "type": "array",
       "items": {
-        "$ref": "/txs/get-transfer-group/get-transfer-group.schema.output.json#/definitions/transfer_group"
+        "$ref": "#/definitions/transfer_group_with_transfers_count"
       }
     },
     "metadata": {
       "$ref": "/txs/tx-consts.schema.json#/definitions/i_tx_find_metadata"
     }
   },
+  "definitions": {
+    "transfer_group_transfers_count": {
+      "type": "object",
+      "properties": {
+        "transfers_count": {
+          "description": "Number of transfers in the group",
+          "type": "number"
+        }
+      },
+      "$typescript": "{\"additionalProperties\": false}"
+    },
+    "transfer_group_with_transfers_count": {
+      "allOf": [
+        {
+          "$ref": "/txs/get-transfer-group/get-transfer-group.schema.output.json#/definitions/transfer_group"
+        },
+        {
+          "$ref": "#/definitions/transfer_group_transfers_count"
+        }
+      ]
+    }
+  },
   "required": ["transfer_groups", "metadata"],
   "additionalProperties": false
 }

package/dist/txs/find-transfer-many/find-transfer-many.enums.d.ts

@@ -1,7 +1,7 @@
 import { ITxLimitingOptions, ITxGeneralOptions, ITxSelectOptions, ITxDeselectOptions, ITxMetadataOptions, ITxOrderingInput, ITxFindMetadata } from '../tx-consts.enums';
 import { UniqueWalletFilter } from '../get-wallet/get-wallet.enums';
-import { DbFilterMetadata, DbFilterFunctionWhereInner, DbFilterFunctionWherePrimitive, DbFilterFunctionWherePrimitiveForeign, DbFilterFunctionWherePrimitiveIdentifier, DbFilterFunctionWhereObject, DbFilterFunctionWhereIns, DbFilterFunctionWhereNulls, DbFilterFunctionWhereMetadataIns, DbFilterFunctionWhereMetadataPrimitive, DbFilterFunctionWhereMetadataNulls } from '../../db/consts.enums';
 import { TransferTableAccessibleFields } from '../../db/transfer/transfer.enums';
+import { DbFilterMetadata, DbFilterFunctionWhereInner, DbFilterFunctionWherePrimitive, DbFilterFunctionWherePrimitiveForeign, DbFilterFunctionWherePrimitiveIdentifier, DbFilterFunctionWhereObject, DbFilterFunctionWhereIns, DbFilterFunctionWhereNulls, DbFilterFunctionWhereMetadataIns, DbFilterFunctionWhereMetadataPrimitive, DbFilterFunctionWhereMetadataNulls } from '../../db/consts.enums';
 import { UniqueTokenFilter } from '../get-token/get-token.enums';
 import { UniqueTransferGroupFilter } from '../get-transfer-group/get-transfer-group.enums';
 import { Transfer } from '../get-transfer/get-transfer.enums';

package/dist/txs/get-balance-history/get-balance-history.enums.d.ts

@@ -86,6 +86,10 @@ export interface BalanceHistory {
      * Current finished and pending balance sum
      */
     amount?: number;
+    /**
+     * The status of the change to balance
+     */
+    status?: 'pending' | 'finished';
     /**
      * Latest control_hash associated with wallet token combination
      */
@@ -173,7 +177,7 @@ export interface BalanceHistory {
      */
     transfer_status_finalized_at?: string | null;
 }
-export type BalanceHistoryFields = 'transfer_id' | 'transfer_identifier' | 'transfer_control_hash' | 'transfer_from_wallet_id' | 'transfer_from_wallet_foreign' | 'transfer_to_wallet_id' | 'transfer_to_wallet_foreign' | 'transfer_amount' | 'transfer_type' | 'transfer_status' | 'transfer_force' | 'transfer_created_at' | 'transfer_updated_at' | 'transfer_metadata' | 'transfer_transfer_group_id' | 'transfer_transfer_group_identifier' | 'transfer_reverses_id' | 'transfer_reverses_identifier' | 'transfer_status_finalized_at' | 'balance_id' | 'token_id' | 'token_foreign' | 'wallet_id' | 'wallet_foreign' | 'pending_amount' | 'pending_amount_to' | 'pending_amount_from' | 'finished_amount' | 'amount' | 'latest_control_hash' | 'updated_at' | 'status';
+export type BalanceHistoryFields = 'transfer_id' | 'transfer_identifier' | 'transfer_control_hash' | 'transfer_from_wallet_id' | 'transfer_from_wallet_foreign' | 'transfer_to_wallet_id' | 'transfer_to_wallet_foreign' | 'transfer_amount' | 'transfer_type' | 'transfer_status' | 'transfer_force' | 'transfer_created_at' | 'transfer_updated_at' | 'transfer_metadata' | 'transfer_transfer_group_id' | 'transfer_transfer_group_identifier' | 'transfer_reverses_id' | 'transfer_reverses_identifier' | 'transfer_status_finalized_at' | 'balance_id' | 'token_id' | 'token_foreign' | 'wallet_id' | 'wallet_foreign' | 'pending_amount' | 'pending_amount_to' | 'pending_amount_from' | 'finished_amount' | 'amount' | 'latest_control_hash' | 'updated_at' | 'status' | 'available_balance';
 /**
  * Output of getBalanceHistory
  *

package/dist/txs/get-balance-history/get-balance-history.schema.output.json

@@ -64,6 +64,11 @@
           "description": "Current finished and pending balance sum",
           "type": "number"
         },
+        "status": {
+          "description": "The status of the change to balance",
+          "type": ["string"],
+          "enum": ["pending", "finished"]
+        },
         "latest_control_hash": {
           "description": "Latest control_hash associated with wallet token combination",
           "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/latest_control_hash"
@@ -170,7 +175,8 @@
         "amount",
         "latest_control_hash",
         "updated_at",
-        "status"
+        "status",
+        "available_balance"
       ]
     }
   },

package/dist/txs/get-token/get-token.enums.d.ts

@@ -12,6 +12,10 @@ export interface GetTokenAdditionalOptions {
      * If true then the returning object is only guaranteed to have id
      */
     return_only_id?: boolean;
+    /**
+     * Return the total system balance of token
+     */
+    include_balance?: boolean;
 }
 /**
  * ID based filter for token
@@ -101,6 +105,44 @@ export interface Token {
      */
     belongs_to_foreign?: string | null;
 }
+export interface TokenWithBalance extends Token {
+    /**
+     * Latest transfer affecting the balance
+     */
+    balance_transfer_id: number | null;
+    /**
+     * Current pending balance
+     */
+    balance_pending_amount: number | null;
+    /**
+     * Sum of incoming pending transfers
+     */
+    balance_pending_amount_to: number | null;
+    /**
+     * Sum of outgoing pending transfers
+     */
+    balance_pending_amount_from: number | null;
+    /**
+     * Current finished balance
+     */
+    balance_finished_amount: number | null;
+    /**
+     * Current finished and pending balance sum
+     */
+    balance_amount: number | null;
+    /**
+     * Available balance that is sum of pending_amount_from and finished_amount
+     */
+    balance_available_balance: number | null;
+    /**
+     * Latest control_hash associated with wallet token combination
+     */
+    balance_latest_control_hash: number | null;
+    /**
+     * Last modification date of balance
+     */
+    balance_updated_at: number | null;
+}
 /**
  * Output of getToken
  *
@@ -110,5 +152,5 @@ export interface GetTokenTxOutput {
     /**
      * requested token
      */
-    token?: Token;
+    token?: Token | TokenWithBalance;
 }

package/dist/txs/get-token/get-token.schema.input.json

@@ -26,7 +26,6 @@
       "type": "object",
       "properties": {
         "ignore_cache": {
-          "description": "If true then result is returned from cache layer if possible",
           "type": "boolean",
           "default": false
         },
@@ -39,6 +38,11 @@
           "type": "boolean",
           "description": "If true then the returning object is only guaranteed to have id",
           "default": false
+        },
+        "include_balance": {
+          "type": "boolean",
+          "description": "Return the total system balance of token",
+          "default": false
         }
       },
       "default": {},

package/dist/txs/get-token/get-token.schema.output.json

@@ -7,7 +7,14 @@
   "properties": {
     "token": {
       "description": "requested token",
-      "$ref": "#/definitions/token"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/token"
+        },
+        {
+          "$ref": "#/definitions/token_with_balance"
+        }
+      ]
     }
   },
   "definitions": {
@@ -49,7 +56,61 @@
         }
       },
       "required": ["id"],
-      "additionalProperties": false
+      "$typescript": "{\"additionalProperties\": false}"
+    },
+    "token_with_balance": {
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/token"
+        },
+
+        {
+          "$ref": "#/definitions/token_balance"
+        }
+      ]
+    },
+    "token_balance": {
+      "type": "object",
+      "properties": {
+        "balance_transfer_id": {
+          "description": "Latest transfer id",
+          "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/transfer_id"
+        },
+        "balance_pending_amount": {
+          "description": "Current pending balance",
+          "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/pending_amount"
+        },
+        "balance_pending_amount_to": {
+          "description": "Sum of incoming pending transfers",
+          "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/pending_amount_to"
+        },
+        "balance_pending_amount_from": {
+          "description": "Sum of outgoing pending transfers",
+          "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/pending_amount_from"
+        },
+        "balance_finished_amount": {
+          "description": "Current finished balance",
+          "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/finished_amount"
+        },
+        "balance_amount": {
+          "description": "Current finished and pending balance sum",
+          "type": "number"
+        },
+        "balance_available_balance": {
+          "description": "Available balance that is sum of pending_amount_from and finished_amount",
+          "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/available_balance"
+        },
+        "balance_latest_control_hash": {
+          "description": "Latest control_hash associated with wallet token combination",
+          "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/latest_control_hash"
+        },
+        "balance_updated_at": {
+          "description": "Last modification date of balance",
+          "$ref": "/db/transfer-log/transfer-log.schema.json#/properties/created_at"
+        }
+      },
+      "$typescript": "{\"additionalProperties\": false}"
     }
   },
   "additionalProperties": false

package/dist/txs/get-token-many/get-token-many.enums.d.ts

@@ -1,4 +1,4 @@
-import { UniqueTokenFilter } from '../get-token/get-token.enums';
+import { TokenWithBalance, UniqueTokenFilter } from '../get-token/get-token.enums';
 import { ITxGeneralOptions } from '../tx-consts.enums';
 import { TokenTable, TokenTableOptional } from '../../db/token/token.enums';
 /**
@@ -14,6 +14,10 @@ export interface GetTokenManyAdditionalOptions {
      * If true then the returning object is only guaranteed to have id
      */
     return_only_id?: boolean;
+    /**
+     * Return the total system balance of token
+     */
+    include_balance?: boolean;
 }
 export type GetTokenManyTxOptions = ITxGeneralOptions & GetTokenManyAdditionalOptions;
 /**
@@ -25,7 +29,7 @@ export interface GetTokenManyTxInput {
     tokens: UniqueTokenFilter[];
     options?: GetTokenManyTxOptions;
 }
-export type TokenResult = TokenTable | TokenTableOptional | null;
+export type TokenResult = TokenTable | TokenTableOptional | TokenWithBalance | null;
 /**
  * Output of getTokenMany
  *

package/dist/txs/get-token-many/get-token-many.schema.input.json

@@ -41,6 +41,11 @@
           "type": "boolean",
           "description": "If true then the returning object is only guaranteed to have id",
           "default": false
+        },
+        "include_balance": {
+          "type": "boolean",
+          "description": "Return the total system balance of token",
+          "default": false
         }
       },
       "default": {},

package/dist/txs/get-token-many/get-token-many.schema.output.json

@@ -21,6 +21,9 @@
         {
           "$ref": "/db/token/token.schema.optional.json"
         },
+        {
+          "$ref": "/txs/get-token/get-token.schema.output.json#/definitions/token_with_balance"
+        },
         {
           "type": "null"
         }

package/dist/txs/update-transfer-group/update-transfer-group.enums.d.ts

@@ -1,7 +1,7 @@
 import { UniqueTransferGroupFilter } from '../get-transfer-group/get-transfer-group.enums';
 import { ITxGeneralOptionsWithoutTx, ITxMetadataAction } from '../tx-consts.enums';
-import { TransferGroupTable } from '../../db/transfer-group/transfer-group.enums';
 import { TransferGroupStatus, TransferStatus } from '../../db/consts.enums';
+import { TransferGroupTable } from '../../db/transfer-group/transfer-group.enums';
 import { Transfer } from '../get-transfer/get-transfer.enums';
 /**
  * Optional flags for input