@railgun-community/shared-models 1.0.3 → 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 RAILGUN Project Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import * as ArtifactModels from './models/artifact';
+import * as FallbackProviderModels from './models/fallback-provider';
+import * as MerkletreeScanModels from './models/merkletree-scan';
+import * as NetworkConfigModels from './models/network-config';
+import * as ProofModels from './models/proof';
+import * as ResponseTypesModels from './models/response-types';
+import * as WalletModels from './models/wallet';
+declare const _default: {
+    serializeUnsignedTransaction: (transaction: import("@ethersproject/contracts").PopulatedTransaction) => string;
+    deserializeTransaction: (rawTransaction: string, nonce: Optional<number>, chainId: number) => import("@ethersproject/abstract-provider").TransactionRequest;
+    calculateGasLimit: (gasEstimate: import("@ethersproject/bignumber").BigNumber) => import("@ethersproject/bignumber").BigNumber;
+    calculateTotalGas: (transactionGasDetails: ResponseTypesModels.TransactionGasDetails) => import("@ethersproject/bignumber").BigNumber;
+    calculateMaximumGas: (transactionGasDetails: ResponseTypesModels.TransactionGasDetails) => import("@ethersproject/bignumber").BigNumber;
+    sanitizeError: (err: Error) => Error;
+    compareChains: (chainA: ResponseTypesModels.Chain, chainB: ResponseTypesModels.Chain) => boolean;
+    WalletCreationType: typeof WalletModels.WalletCreationType;
+    ChainType: typeof ResponseTypesModels.ChainType;
+    ProofType: typeof ProofModels.ProofType;
+    NetworkName: typeof NetworkConfigModels.NetworkName;
+    BaseTokenWrappedAddress: typeof NetworkConfigModels.BaseTokenWrappedAddress;
+    RailgunProxyDeploymentBlock: typeof NetworkConfigModels.RailgunProxyDeploymentBlock;
+    EVMGasType: typeof NetworkConfigModels.EVMGasType;
+    NETWORK_CONFIG: MapType<NetworkConfigModels.Network>;
+    networkForChain: (chain: ResponseTypesModels.Chain) => Optional<NetworkConfigModels.Network>;
+    MerkletreeScanStatus: typeof MerkletreeScanModels.MerkletreeScanStatus;
+    createFallbackProviderFromJsonConfig: (config: FallbackProviderModels.FallbackProviderJsonConfig, debugMessage?: ((msg: string) => void) | undefined) => import("@ethersproject/providers").FallbackProvider;
+    OFAC_TORNADO_CASH_SANCTIONS_LIST_ETH_ADDRESS: string[];
+    ArtifactName: typeof ArtifactModels.ArtifactName;
+    ArtifactVariant: typeof ArtifactModels.ArtifactVariant;
+    ARTIFACT_URL_PATHS_VARIANTS_V1: ArtifactModels.ArtifactVariantMapping;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,53 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+exports.__esModule = true;
+var ArtifactModels = __importStar(require("./models/artifact"));
+var BlockedAddressModels = __importStar(require("./models/blocked-address"));
+var FallbackProviderModels = __importStar(require("./models/fallback-provider"));
+var FeeTokenModels = __importStar(require("./models/fee-token"));
+var FunctionTypesModels = __importStar(require("./models/function-types"));
+var MerkletreeScanModels = __importStar(require("./models/merkletree-scan"));
+var NetworkConfigModels = __importStar(require("./models/network-config"));
+var ProofModels = __importStar(require("./models/proof"));
+var ResponseTypesModels = __importStar(require("./models/response-types"));
+var TransactionModels = __importStar(require("./models/transaction"));
+var WalletModels = __importStar(require("./models/wallet"));
+var CompareUtils = __importStar(require("./utils/compare"));
+var ErrorUtils = __importStar(require("./utils/error"));
+var GasUtils = __importStar(require("./utils/gas"));
+var SerializerUtils = __importStar(require("./utils/serializer"));
+exports["default"] = __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, ArtifactModels), BlockedAddressModels), FallbackProviderModels), FeeTokenModels), FunctionTypesModels), MerkletreeScanModels), NetworkConfigModels), ProofModels), ResponseTypesModels), TransactionModels), WalletModels), CompareUtils), ErrorUtils), GasUtils), SerializerUtils);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAoD;AACpD,6EAAiE;AACjE,iFAAqE;AACrE,iEAAqD;AACrD,2EAA+D;AAC/D,6EAAiE;AACjE,2EAA+D;AAC/D,0DAA8C;AAC9C,2EAA+D;AAC/D,sEAA0D;AAC1D,4DAAgD;AAEhD,4DAAgD;AAChD,wDAA4C;AAC5C,oDAAwC;AACxC,kEAAsD;AAEtD,gKACK,cAAc,GACd,oBAAoB,GACpB,sBAAsB,GACtB,cAAc,GACd,mBAAmB,GACnB,oBAAoB,GACpB,mBAAmB,GACnB,WAAW,GACX,mBAAmB,GACnB,iBAAiB,GACjB,YAAY,GAEZ,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,eAAe,EAClB","sourcesContent":["import * as ArtifactModels from './models/artifact';\nimport * as BlockedAddressModels from './models/blocked-address';\nimport * as FallbackProviderModels from './models/fallback-provider';\nimport * as FeeTokenModels from './models/fee-token';\nimport * as FunctionTypesModels from './models/function-types';\nimport * as MerkletreeScanModels from './models/merkletree-scan';\nimport * as NetworkConfigModels from './models/network-config';\nimport * as ProofModels from './models/proof';\nimport * as ResponseTypesModels from './models/response-types';\nimport * as TransactionModels from './models/transaction';\nimport * as WalletModels from './models/wallet';\n\nimport * as CompareUtils from './utils/compare';\nimport * as ErrorUtils from './utils/error';\nimport * as GasUtils from './utils/gas';\nimport * as SerializerUtils from './utils/serializer';\n\nexport default {\n  ...ArtifactModels,\n  ...BlockedAddressModels,\n  ...FallbackProviderModels,\n  ...FeeTokenModels,\n  ...FunctionTypesModels,\n  ...MerkletreeScanModels,\n  ...NetworkConfigModels,\n  ...ProofModels,\n  ...ResponseTypesModels,\n  ...TransactionModels,\n  ...WalletModels,\n\n  ...CompareUtils,\n  ...ErrorUtils,\n  ...GasUtils,\n  ...SerializerUtils,\n};\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"response-types.js","sourceRoot":"","sources":["../../src/models/response-types.ts"],"names":[],"mappings":";;;AAmDA,IAAY,SAEX;AAFD,WAAY,SAAS;IACnB,uCAAO,CAAA;AACT,CAAC,EAFW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAEpB","sourcesContent":["import { BigNumber } from '@ethersproject/bignumber';\nimport { MerkletreeScanStatus } from './merkletree-scan';\nimport { EVMGasType, FeesSerialized } from './network-config';\n\nexport type RailgunAPICiphertext = {\n  iv: string;\n  data: string[];\n};\n\nexport type TransactionGasDetails =\n  | TransactionGasDetailsType0\n  | TransactionGasDetailsType2;\n\nexport type TransactionGasDetailsType0 = {\n  evmGasType: EVMGasType.Type0;\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  | TransactionGasDetailsSerializedType2;\n\nexport type TransactionGasDetailsSerializedType0 = {\n  evmGasType: EVMGasType.Type0;\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  tokenBalancesSerialized: RailgunShieldedTokenBalanceSerialized[];\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 RailgunShieldedTokenBalanceSerialized = {\n  tokenAddress: string;\n  balanceString: string;\n};\n\nexport type RailgunProveTransactionResponse = {\n  error?: string;\n};\n\nexport type RailgunPopulateTransactionResponse = {\n  serializedTransaction?: string;\n  error?: string;\n};\n\nexport type RailgunTransactionGasEstimateResponse = {\n  gasEstimateString?: string;\n  error?: string;\n};\n\nexport type RailgunWalletTokenAmount = {\n  tokenAddress: string;\n  amountString: 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\nexport declare type RailgunWalletSendTokenAmount = RailgunWalletTokenAmount & {\n  recipientAddress?: string;\n  walletSource?: string;\n  memoText?: string;\n};\n\nexport declare type RailgunWalletReceiveTokenAmount =\n  RailgunWalletTokenAmount & {\n    memoText?: string;\n  };\n\nexport type TransactionHistoryItem = {\n  txid: string;\n  receiveTokenAmounts: RailgunWalletReceiveTokenAmount[];\n  transferTokenAmounts: RailgunWalletSendTokenAmount[];\n  changeTokenAmounts: RailgunWalletTokenAmount[];\n  relayerFeeTokenAmount?: RailgunWalletTokenAmount;\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":";;;AAmDA,IAAY,SAEX;AAFD,WAAY,SAAS;IACnB,uCAAO,CAAA;AACT,CAAC,EAFW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAEpB","sourcesContent":["import { BigNumber } from '@ethersproject/bignumber';\nimport { MerkletreeScanStatus } from './merkletree-scan';\nimport { EVMGasType, FeesSerialized } from './network-config';\n\nexport type RailgunAPICiphertext = {\n  iv: string;\n  data: string[];\n};\n\nexport type TransactionGasDetails =\n  | TransactionGasDetailsType0\n  | TransactionGasDetailsType2;\n\nexport type TransactionGasDetailsType0 = {\n  evmGasType: EVMGasType.Type0;\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  | TransactionGasDetailsSerializedType2;\n\nexport type TransactionGasDetailsSerializedType0 = {\n  evmGasType: EVMGasType.Type0;\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  tokenBalancesSerialized: RailgunShieldedTokenBalanceSerialized[];\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 RailgunShieldedTokenBalanceSerialized = {\n  tokenAddress: string;\n  balanceString: string;\n};\n\nexport type RailgunProveTransactionResponse = {\n  error?: string;\n};\n\nexport type RailgunPopulateTransactionResponse = {\n  serializedTransaction?: string;\n  error?: string;\n};\n\nexport type RailgunTransactionGasEstimateResponse = {\n  gasEstimateString?: string;\n  error?: string;\n};\n\nexport type RailgunWalletTokenAmount = {\n  tokenAddress: string;\n  amountString: 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\nexport type RailgunWalletSendTokenAmount = RailgunWalletTokenAmount & {\n  recipientAddress?: string;\n  walletSource?: string;\n  memoText?: string;\n};\n\nexport type RailgunWalletReceiveTokenAmount = RailgunWalletTokenAmount & {\n  memoText?: string;\n};\n\nexport type TransactionHistoryItem = {\n  txid: string;\n  receiveTokenAmounts: RailgunWalletReceiveTokenAmount[];\n  transferTokenAmounts: RailgunWalletSendTokenAmount[];\n  changeTokenAmounts: RailgunWalletTokenAmount[];\n  relayerFeeTokenAmount?: RailgunWalletTokenAmount;\n  version: number;\n};\n\nexport type TransactionHistorySerializedResponse = {\n  items?: TransactionHistoryItem[];\n  error?: string;\n};\n"]}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@railgun-community/shared-models",
-  "version": "1.0.3",
+  "version": "1.0.4",
+  "license": "MIT",
   "files": [
     "dist/**/*"
   ],