@railgun-community/shared-models 4.0.0-test → 4.0.2-test

package/dist/models/artifact.d.ts

@@ -1,25 +1,18 @@
-/// <reference types="node" />
+export declare type Artifact = {
+    zkey: ArrayLike<number>;
+    wasm: Optional<ArrayLike<number>>;
+    dat: Optional<ArrayLike<number>>;
+    vkey: object;
+};
 export declare enum ArtifactName {
     ZKEY = "zkey",
     WASM = "wasm",
     VKEY = "vkey",
     DAT = "dat"
 }
-export declare type ArtifactGroup = {
-    [ArtifactName.ZKEY]: Buffer;
-    [ArtifactName.VKEY]: object;
-    [ArtifactName.WASM]: Optional<Buffer>;
-    [ArtifactName.DAT]: Optional<Buffer>;
-};
 export declare type ArtifactMapping = {
-    [ArtifactName.ZKEY]: string;
-    [ArtifactName.WASM]: string;
-    [ArtifactName.VKEY]: string;
-    [ArtifactName.DAT]: string;
+    [name in ArtifactName]: string;
 };
 export declare type ArtifactDownloadedGroup = {
-    [ArtifactName.ZKEY]: boolean;
-    [ArtifactName.WASM]: boolean;
-    [ArtifactName.VKEY]: boolean;
-    [ArtifactName.DAT]: boolean;
+    [name in ArtifactName]: boolean;
 };

package/dist/models/artifact.js.map

@@ -1 +1 @@
-{"version":3,"file":"artifact.js","sourceRoot":"","sources":["../../src/models/artifact.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,6BAAa,CAAA;IACb,6BAAa,CAAA;IACb,2BAAW,CAAA;AACb,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB","sourcesContent":["export enum ArtifactName {\n  ZKEY = 'zkey',\n  WASM = 'wasm',\n  VKEY = 'vkey',\n  DAT = 'dat',\n}\n\nexport type ArtifactGroup = {\n  [ArtifactName.ZKEY]: Buffer;\n  [ArtifactName.VKEY]: object;\n  [ArtifactName.WASM]: Optional<Buffer>;\n  [ArtifactName.DAT]: Optional<Buffer>;\n};\n\nexport type ArtifactMapping = {\n  [ArtifactName.ZKEY]: string;\n  [ArtifactName.WASM]: string;\n  [ArtifactName.VKEY]: string;\n  [ArtifactName.DAT]: string;\n};\n\nexport type ArtifactDownloadedGroup = {\n  [ArtifactName.ZKEY]: boolean;\n  [ArtifactName.WASM]: boolean;\n  [ArtifactName.VKEY]: boolean;\n  [ArtifactName.DAT]: boolean;\n};\n"]}
+{"version":3,"file":"artifact.js","sourceRoot":"","sources":["../../src/models/artifact.ts"],"names":[],"mappings":";;;AAOA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,6BAAa,CAAA;IACb,6BAAa,CAAA;IACb,2BAAW,CAAA;AACb,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB","sourcesContent":["export type Artifact = {\n  zkey: ArrayLike<number>;\n  wasm: Optional<ArrayLike<number>>;\n  dat: Optional<ArrayLike<number>>;\n  vkey: object;\n};\n\nexport enum ArtifactName {\n  ZKEY = 'zkey',\n  WASM = 'wasm',\n  VKEY = 'vkey',\n  DAT = 'dat',\n}\n\nexport type ArtifactMapping = {\n  [name in ArtifactName]: string;\n};\n\nexport type ArtifactDownloadedGroup = {\n  [name in ArtifactName]: boolean;\n};\n"]}

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

@@ -149,15 +149,21 @@ export declare type ValidateCachedProvedTransactionResponse = {
 };
 export declare type Pbkdf2Response = string;
 declare type SendAdditionalData = {
-    recipientAddress?: string;
-    walletSource?: string;
-    memoText?: string;
+    recipientAddress: Optional<string>;
+    walletSource: Optional<string>;
+    memoText: Optional<string>;
 };
 export declare type RailgunSendERC20Amount = RailgunERC20Amount & SendAdditionalData;
 export declare type RailgunSendNFTAmount = RailgunNFTAmount & SendAdditionalData;
+declare type UnshieldAdditonalData = {
+    unshieldFee: Optional<string>;
+};
+export declare type RailgunUnshieldERC20Amount = RailgunSendERC20Amount & UnshieldAdditonalData;
+export declare type RailgunUnshieldNFTAmount = RailgunSendNFTAmount & UnshieldAdditonalData;
 declare type ReceiveAdditionalData = {
-    senderAddress?: string;
-    memoText?: string;
+    senderAddress: Optional<string>;
+    memoText: Optional<string>;
+    shieldFee: Optional<string>;
 };
 export declare type RailgunReceiveERC20Amount = RailgunERC20Amount & ReceiveAdditionalData;
 export declare type RailgunReceiveNFTAmount = RailgunNFTAmount & ReceiveAdditionalData;
@@ -167,10 +173,10 @@ export declare type TransactionHistoryItem = {
     transferERC20Amounts: RailgunSendERC20Amount[];
     changeERC20Amounts: RailgunERC20Amount[];
     relayerFeeERC20Amount?: RailgunERC20Amount;
-    unshieldERC20Amounts: RailgunSendERC20Amount[];
+    unshieldERC20Amounts: RailgunUnshieldERC20Amount[];
     receiveNFTAmounts: RailgunReceiveNFTAmount[];
     transferNFTAmounts: RailgunSendNFTAmount[];
-    unshieldNFTAmounts: RailgunSendNFTAmount[];
+    unshieldNFTAmounts: RailgunUnshieldNFTAmount[];
     version: number;
 };
 export declare type TransactionHistorySerializedResponse = {

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?: string;\n  walletSource?: string;\n  memoText?: string;\n};\n\nexport type RailgunSendERC20Amount = RailgunERC20Amount & SendAdditionalData;\n\nexport type RailgunSendNFTAmount = RailgunNFTAmount & SendAdditionalData;\n\ntype ReceiveAdditionalData = {\n  senderAddress?: string;\n  memoText?: 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: RailgunSendERC20Amount[];\n  receiveNFTAmounts: RailgunReceiveNFTAmount[];\n  transferNFTAmounts: RailgunSendNFTAmount[];\n  unshieldNFTAmounts: RailgunSendNFTAmount[];\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","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"]}

package/package.json

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