@railgun-community/shared-models 4.1.3 → 4.1.5

package/dist/models/response-types.d.ts

@@ -168,8 +168,16 @@ declare type ReceiveAdditionalData = {
 };
 export declare type RailgunReceiveERC20Amount = RailgunERC20Amount & ReceiveAdditionalData;
 export declare type RailgunReceiveNFTAmount = RailgunNFTAmount & ReceiveAdditionalData;
+export declare enum TransactionHistoryItemCategory {
+    Shield = "Shield",
+    Unshield = "Unshield",
+    TransferSend = "TransferSend",
+    TransferReceive = "TransferReceive",
+    Unknown = "Unknown"
+}
 export declare type TransactionHistoryItem = {
     txid: string;
+    version: number;
     receiveERC20Amounts: RailgunReceiveERC20Amount[];
     transferERC20Amounts: RailgunSendERC20Amount[];
     changeERC20Amounts: RailgunERC20Amount[];
@@ -178,7 +186,7 @@ export declare type TransactionHistoryItem = {
     receiveNFTAmounts: RailgunReceiveNFTAmount[];
     transferNFTAmounts: RailgunSendNFTAmount[];
     unshieldNFTAmounts: RailgunUnshieldNFTAmount[];
-    version: number;
+    category: TransactionHistoryItemCategory;
 };
 export declare type TransactionHistorySerializedResponse = {
     items?: TransactionHistoryItem[];

package/dist/models/response-types.js

@@ -1,6 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.NFTTokenType = exports.ChainType = exports.EVMGasType = void 0;
+exports.TransactionHistoryItemCategory = exports.NFTTokenType = exports.ChainType = exports.EVMGasType = void 0;
 /**
  * Type0 / Type1 = non-EIP-1559 (gasPrice).
  * Type2 = EIP-1559 (maxFeePerGas and maxPriorityFeePerGas).
@@ -23,4 +23,12 @@ var NFTTokenType;
     NFTTokenType[NFTTokenType["ERC721"] = 1] = "ERC721";
     NFTTokenType[NFTTokenType["ERC1155"] = 2] = "ERC1155";
 })(NFTTokenType = exports.NFTTokenType || (exports.NFTTokenType = {}));
+var TransactionHistoryItemCategory;
+(function (TransactionHistoryItemCategory) {
+    TransactionHistoryItemCategory["Shield"] = "Shield";
+    TransactionHistoryItemCategory["Unshield"] = "Unshield";
+    TransactionHistoryItemCategory["TransferSend"] = "TransferSend";
+    TransactionHistoryItemCategory["TransferReceive"] = "TransferReceive";
+    TransactionHistoryItemCategory["Unknown"] = "Unknown";
+})(TransactionHistoryItemCategory = exports.TransactionHistoryItemCategory || (exports.TransactionHistoryItemCategory = {}));
 //# sourceMappingURL=response-types.js.map

package/dist/models/response-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"response-types.js","sourceRoot":"","sources":["../../src/models/response-types.ts"],"names":[],"mappings":";;;AASA;;;GAGG;AACH,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,6CAAS,CAAA;IACT,6CAAS,CAAA;AACX,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AA0DD,IAAY,SAEX;AAFD,WAAY,SAAS;IACnB,uCAAO,CAAA;AACT,CAAC,EAFW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAEpB;AA6ED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,mDAAU,CAAA;IACV,qDAAW,CAAA;AACb,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB","sourcesContent":["import { BigNumber } from '@ethersproject/bignumber';\nimport { MerkletreeScanStatus } from './merkletree-scan';\nimport { FeesSerialized } from './network-config';\n\nexport type RailgunAPICiphertext = {\n  iv: string;\n  data: string[];\n};\n\n/**\n * Type0 / Type1 = non-EIP-1559 (gasPrice).\n * Type2 = EIP-1559 (maxFeePerGas and maxPriorityFeePerGas).\n */\nexport enum EVMGasType {\n  Type0 = 0,\n  Type1 = 1,\n  Type2 = 2,\n}\n\nexport type TransactionGasDetails =\n  | TransactionGasDetailsType0\n  | TransactionGasDetailsType1\n  | TransactionGasDetailsType2;\n\nexport type TransactionGasDetailsType0 = {\n  evmGasType: EVMGasType.Type0;\n  gasEstimate: BigNumber;\n  gasPrice: BigNumber;\n};\n\nexport type TransactionGasDetailsType1 = {\n  evmGasType: EVMGasType.Type1;\n  gasEstimate: BigNumber;\n  gasPrice: BigNumber;\n};\n\nexport type TransactionGasDetailsType2 = {\n  evmGasType: EVMGasType.Type2;\n  gasEstimate: BigNumber;\n  maxFeePerGas: BigNumber;\n  maxPriorityFeePerGas: BigNumber;\n};\n\nexport type TransactionGasDetailsSerialized =\n  | TransactionGasDetailsSerializedType0\n  | TransactionGasDetailsSerializedType1\n  | TransactionGasDetailsSerializedType2;\n\nexport type TransactionGasDetailsSerializedType0 = {\n  evmGasType: EVMGasType.Type0;\n  gasEstimateString: string;\n  gasPriceString: string;\n};\n\nexport type TransactionGasDetailsSerializedType1 = {\n  evmGasType: EVMGasType.Type1;\n  gasEstimateString: string;\n  gasPriceString: string;\n};\n\nexport type TransactionGasDetailsSerializedType2 = {\n  evmGasType: EVMGasType.Type2;\n  gasEstimateString: string;\n  maxFeePerGasString: string;\n  maxPriorityFeePerGasString: string;\n};\n\nexport type StartRailgunEngineResponse = {\n  error?: string;\n};\n\nexport type DownloadInitialArtifactsResponse = {\n  error?: string;\n};\n\nexport enum ChainType {\n  EVM = 0,\n}\n\nexport type Chain = {\n  type: ChainType;\n  id: number;\n};\n\nexport type RailgunBalancesEvent = {\n  chain: Chain;\n  erc20Amounts: RailgunERC20Amount[];\n  nftAmounts: RailgunNFTAmount[];\n  railgunWalletID: string;\n};\n\nexport type MerkletreeScanUpdateEvent = {\n  chain: Chain;\n  scanStatus: MerkletreeScanStatus;\n  progress: number;\n};\n\nexport type LoadProviderResponse = {\n  feesSerialized?: FeesSerialized;\n  error?: string;\n};\n\nexport type RailgunWalletInfo = {\n  id: string;\n  railgunAddress: string;\n};\n\nexport type LoadRailgunWalletResponse = {\n  railgunWalletInfo?: RailgunWalletInfo;\n  error?: string;\n};\n\nexport type UnloadRailgunWalletResponse = {\n  error?: string;\n};\n\nexport type RailgunWalletAddressDataSerialized = {\n  masterPublicKey: string;\n  viewingPublicKey: string;\n};\n\nexport type RailgunBalanceResponse = {\n  error?: string;\n};\n\nexport type RailgunProveTransactionResponse = {\n  error?: string;\n};\n\nexport declare type RailgunTxidFromNullifiersResponse = {\n  txid?: string;\n  error?: string;\n};\n\nexport type RailgunPopulateTransactionResponse = {\n  serializedTransaction?: string;\n  nullifiers?: string[];\n  error?: string;\n};\n\nexport type RailgunTransactionGasEstimateResponse = {\n  gasEstimateString?: string;\n  error?: string;\n};\n\nexport type RailgunERC20Amount = {\n  tokenAddress: string;\n  amountString: string;\n};\n\nexport type RailgunERC20AmountRecipient = RailgunERC20Amount & {\n  recipientAddress: string;\n};\n\n/**\n * Synced NFT types from TokenType (@railgun-community/engine).\n */\nexport enum NFTTokenType {\n  ERC721 = 1,\n  ERC1155 = 2,\n}\n\nexport type RailgunNFTAmount = {\n  nftAddress: string;\n  nftTokenType: NFTTokenType;\n  tokenSubID: string;\n  amountString: string;\n};\n\nexport type RailgunNFTAmountRecipient = RailgunNFTAmount & {\n  recipientAddress: string;\n};\n\nexport type EncryptDataWithSharedKeyResponse = {\n  encryptedData: [string, string];\n  randomPubKey: string;\n  sharedKey: Uint8Array;\n};\n\nexport type EncryptDataWithSharedKeySerialized = {\n  encryptedData: [string, string];\n  randomPubKey: string;\n  sharedKey: string;\n};\n\nexport type ValidateCachedProvedTransactionResponse = {\n  isValid: boolean;\n  error?: string;\n};\n\nexport type Pbkdf2Response = string;\n\ntype SendAdditionalData = {\n  recipientAddress: Optional<string>;\n  walletSource: Optional<string>;\n  memoText: Optional<string>;\n};\n\nexport type RailgunSendERC20Amount = RailgunERC20Amount & SendAdditionalData;\n\nexport type RailgunSendNFTAmount = RailgunNFTAmount & SendAdditionalData;\n\ntype UnshieldAdditonalData = {\n  unshieldFee: Optional<string>;\n};\n\nexport type RailgunUnshieldERC20Amount = RailgunSendERC20Amount &\n  UnshieldAdditonalData;\n\nexport type RailgunUnshieldNFTAmount = RailgunSendNFTAmount &\n  UnshieldAdditonalData;\n\ntype ReceiveAdditionalData = {\n  senderAddress: Optional<string>;\n  memoText: Optional<string>;\n  shieldFee: Optional<string>;\n};\n\nexport type RailgunReceiveERC20Amount = RailgunERC20Amount &\n  ReceiveAdditionalData;\n\nexport type RailgunReceiveNFTAmount = RailgunNFTAmount & ReceiveAdditionalData;\n\nexport type TransactionHistoryItem = {\n  txid: string;\n  receiveERC20Amounts: RailgunReceiveERC20Amount[];\n  transferERC20Amounts: RailgunSendERC20Amount[];\n  changeERC20Amounts: RailgunERC20Amount[];\n  relayerFeeERC20Amount?: RailgunERC20Amount;\n  unshieldERC20Amounts: RailgunUnshieldERC20Amount[];\n  receiveNFTAmounts: RailgunReceiveNFTAmount[];\n  transferNFTAmounts: RailgunSendNFTAmount[];\n  unshieldNFTAmounts: RailgunUnshieldNFTAmount[];\n  version: number;\n};\n\nexport type TransactionHistorySerializedResponse = {\n  items?: TransactionHistoryItem[];\n  error?: string;\n};\n"]}
+{"version":3,"file":"response-types.js","sourceRoot":"","sources":["../../src/models/response-types.ts"],"names":[],"mappings":";;;AASA;;;GAGG;AACH,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,6CAAS,CAAA;IACT,6CAAS,CAAA;AACX,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AA0DD,IAAY,SAEX;AAFD,WAAY,SAAS;IACnB,uCAAO,CAAA;AACT,CAAC,EAFW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAEpB;AA6ED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,mDAAU,CAAA;IACV,qDAAW,CAAA;AACb,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB;AA+DD,IAAY,8BAMX;AAND,WAAY,8BAA8B;IACxC,mDAAiB,CAAA;IACjB,uDAAqB,CAAA;IACrB,+DAA6B,CAAA;IAC7B,qEAAmC,CAAA;IACnC,qDAAmB,CAAA;AACrB,CAAC,EANW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,QAMzC","sourcesContent":["import { BigNumber } from '@ethersproject/bignumber';\nimport { MerkletreeScanStatus } from './merkletree-scan';\nimport { FeesSerialized } from './network-config';\n\nexport type RailgunAPICiphertext = {\n  iv: string;\n  data: string[];\n};\n\n/**\n * Type0 / Type1 = non-EIP-1559 (gasPrice).\n * Type2 = EIP-1559 (maxFeePerGas and maxPriorityFeePerGas).\n */\nexport enum EVMGasType {\n  Type0 = 0,\n  Type1 = 1,\n  Type2 = 2,\n}\n\nexport type TransactionGasDetails =\n  | TransactionGasDetailsType0\n  | TransactionGasDetailsType1\n  | TransactionGasDetailsType2;\n\nexport type TransactionGasDetailsType0 = {\n  evmGasType: EVMGasType.Type0;\n  gasEstimate: BigNumber;\n  gasPrice: BigNumber;\n};\n\nexport type TransactionGasDetailsType1 = {\n  evmGasType: EVMGasType.Type1;\n  gasEstimate: BigNumber;\n  gasPrice: BigNumber;\n};\n\nexport type TransactionGasDetailsType2 = {\n  evmGasType: EVMGasType.Type2;\n  gasEstimate: BigNumber;\n  maxFeePerGas: BigNumber;\n  maxPriorityFeePerGas: BigNumber;\n};\n\nexport type TransactionGasDetailsSerialized =\n  | TransactionGasDetailsSerializedType0\n  | TransactionGasDetailsSerializedType1\n  | TransactionGasDetailsSerializedType2;\n\nexport type TransactionGasDetailsSerializedType0 = {\n  evmGasType: EVMGasType.Type0;\n  gasEstimateString: string;\n  gasPriceString: string;\n};\n\nexport type TransactionGasDetailsSerializedType1 = {\n  evmGasType: EVMGasType.Type1;\n  gasEstimateString: string;\n  gasPriceString: string;\n};\n\nexport type TransactionGasDetailsSerializedType2 = {\n  evmGasType: EVMGasType.Type2;\n  gasEstimateString: string;\n  maxFeePerGasString: string;\n  maxPriorityFeePerGasString: string;\n};\n\nexport type StartRailgunEngineResponse = {\n  error?: string;\n};\n\nexport type DownloadInitialArtifactsResponse = {\n  error?: string;\n};\n\nexport enum ChainType {\n  EVM = 0,\n}\n\nexport type Chain = {\n  type: ChainType;\n  id: number;\n};\n\nexport type RailgunBalancesEvent = {\n  chain: Chain;\n  erc20Amounts: RailgunERC20Amount[];\n  nftAmounts: RailgunNFTAmount[];\n  railgunWalletID: string;\n};\n\nexport type MerkletreeScanUpdateEvent = {\n  chain: Chain;\n  scanStatus: MerkletreeScanStatus;\n  progress: number;\n};\n\nexport type LoadProviderResponse = {\n  feesSerialized?: FeesSerialized;\n  error?: string;\n};\n\nexport type RailgunWalletInfo = {\n  id: string;\n  railgunAddress: string;\n};\n\nexport type LoadRailgunWalletResponse = {\n  railgunWalletInfo?: RailgunWalletInfo;\n  error?: string;\n};\n\nexport type UnloadRailgunWalletResponse = {\n  error?: string;\n};\n\nexport type RailgunWalletAddressDataSerialized = {\n  masterPublicKey: string;\n  viewingPublicKey: string;\n};\n\nexport type RailgunBalanceResponse = {\n  error?: string;\n};\n\nexport type RailgunProveTransactionResponse = {\n  error?: string;\n};\n\nexport declare type RailgunTxidFromNullifiersResponse = {\n  txid?: string;\n  error?: string;\n};\n\nexport type RailgunPopulateTransactionResponse = {\n  serializedTransaction?: string;\n  nullifiers?: string[];\n  error?: string;\n};\n\nexport type RailgunTransactionGasEstimateResponse = {\n  gasEstimateString?: string;\n  error?: string;\n};\n\nexport type RailgunERC20Amount = {\n  tokenAddress: string;\n  amountString: string;\n};\n\nexport type RailgunERC20AmountRecipient = RailgunERC20Amount & {\n  recipientAddress: string;\n};\n\n/**\n * Synced NFT types from TokenType (@railgun-community/engine).\n */\nexport enum NFTTokenType {\n  ERC721 = 1,\n  ERC1155 = 2,\n}\n\nexport type RailgunNFTAmount = {\n  nftAddress: string;\n  nftTokenType: NFTTokenType;\n  tokenSubID: string;\n  amountString: string;\n};\n\nexport type RailgunNFTAmountRecipient = RailgunNFTAmount & {\n  recipientAddress: string;\n};\n\nexport type EncryptDataWithSharedKeyResponse = {\n  encryptedData: [string, string];\n  randomPubKey: string;\n  sharedKey: Uint8Array;\n};\n\nexport type EncryptDataWithSharedKeySerialized = {\n  encryptedData: [string, string];\n  randomPubKey: string;\n  sharedKey: string;\n};\n\nexport type ValidateCachedProvedTransactionResponse = {\n  isValid: boolean;\n  error?: string;\n};\n\nexport type Pbkdf2Response = string;\n\ntype SendAdditionalData = {\n  recipientAddress: Optional<string>;\n  walletSource: Optional<string>;\n  memoText: Optional<string>;\n};\n\nexport type RailgunSendERC20Amount = RailgunERC20Amount & SendAdditionalData;\n\nexport type RailgunSendNFTAmount = RailgunNFTAmount & SendAdditionalData;\n\ntype UnshieldAdditonalData = {\n  unshieldFee: Optional<string>;\n};\n\nexport type RailgunUnshieldERC20Amount = RailgunSendERC20Amount &\n  UnshieldAdditonalData;\n\nexport type RailgunUnshieldNFTAmount = RailgunSendNFTAmount &\n  UnshieldAdditonalData;\n\ntype ReceiveAdditionalData = {\n  senderAddress: Optional<string>;\n  memoText: Optional<string>;\n  shieldFee: Optional<string>;\n};\n\nexport type RailgunReceiveERC20Amount = RailgunERC20Amount &\n  ReceiveAdditionalData;\n\nexport type RailgunReceiveNFTAmount = RailgunNFTAmount & ReceiveAdditionalData;\n\nexport enum TransactionHistoryItemCategory {\n  Shield = 'Shield',\n  Unshield = 'Unshield',\n  TransferSend = 'TransferSend',\n  TransferReceive = 'TransferReceive',\n  Unknown = 'Unknown',\n}\n\nexport type TransactionHistoryItem = {\n  txid: string;\n  version: number;\n  receiveERC20Amounts: RailgunReceiveERC20Amount[];\n  transferERC20Amounts: RailgunSendERC20Amount[];\n  changeERC20Amounts: RailgunERC20Amount[];\n  relayerFeeERC20Amount?: RailgunERC20Amount;\n  unshieldERC20Amounts: RailgunUnshieldERC20Amount[];\n  receiveNFTAmounts: RailgunReceiveNFTAmount[];\n  transferNFTAmounts: RailgunSendNFTAmount[];\n  unshieldNFTAmounts: RailgunUnshieldNFTAmount[];\n  category: TransactionHistoryItemCategory;\n};\n\nexport type TransactionHistorySerializedResponse = {\n  items?: TransactionHistoryItem[];\n  error?: string;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@railgun-community/shared-models",
-  "version": "4.1.3",
+  "version": "4.1.5",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [