@xchainjs/xchain-arbitrum 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +46 -0
  3. package/lib/client.d.ts +4 -0
  4. package/lib/const.d.ts +17 -0
  5. package/lib/index.d.ts +2 -0
  6. package/lib/index.esm.js +93 -0
  7. package/lib/index.esm.js.map +1 -0
  8. package/lib/index.js +104 -0
  9. package/lib/index.js.map +1 -0
  10. package/package.json +55 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 THORChain
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,46 @@
1
+ # `@xchainjs/xchain-arbitrum`
2
+
3
+ ## Modules
4
+
5
+ - `client` - Custom client for communicating with Arbitrum by using [`ethers`](https://github.com/ethers-io/ethers.js)
6
+
7
+ ## Installation
8
+
9
+ ```sh
10
+ yarn add @xchainjs/xchain-arbitrum
11
+ ```
12
+
13
+ Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-arbitrum`.
14
+
15
+ ```sh
16
+ yarn add @xchainjs/xchain-evm @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios ethers
17
+ ```
18
+
19
+ ## Documentation
20
+
21
+ ### [`xchain arbitrum`](http://docs.xchainjs.org/xchain-client/xchain-arbitrum/)
22
+
23
+ [`How xchain-arbitrum works`](http://docs.xchainjs.org/xchain-client/xchain-arbitrum/how-it-works.html)\
24
+ [`How to use xchain-arbitrum`](http://docs.xchainjs.org/xchain-client/xchain-arbitrum/how-to-use.html)
25
+
26
+ ## Service Providers
27
+
28
+ This package uses the following service providers:
29
+
30
+ | Function | Service | Notes |
31
+ | ------------------------- | --------- | ---------------------------------------------------------------------------------- |
32
+ | ETH balances | Arbirscan | https://api.arbiscan.io/apis#accounts (module=`account`, action=`balance`) |
33
+ | Token balances | Arbiscan | https://api.arbiscan.io/apis#tokens (module=`account`, action=`tokenbalance`) |
34
+ | ETH transaction history | Arbiscan | https://api.arbiscan.io/apis#accounts (module=`account`, action=`txlistinternal`) |
35
+ | Token transaction history | Arbiscan | https://api.arbiscan.io/apis#accounts (module=`account`, action=`tokentx`) |
36
+ | Explorer | Arbiscan | https://arbiscan.io/ |
37
+
38
+ Etherscan API rate limits: https://arbiscan.io/apis
39
+
40
+ - This package uses `etherjs` library, by default it uses several providers. (`https://docs.ethers.io/v5/api-keys/`)
41
+
42
+ // set in env variables so default config can access.
43
+ `ARBISCAN_API_KEY={YOUR_ARBISCAN_API_KEY}`
44
+
45
+ //Default config can access.
46
+ process.env.ARBISCAN_API_KEY
package/lib/client.d.ts ADDED
@@ -0,0 +1,4 @@
1
+ import { Client as XchainEvmClient } from '@xchainjs/xchain-evm';
2
+ export declare class Client extends XchainEvmClient {
3
+ constructor(config?: import("@xchainjs/xchain-evm").EVMClientParams);
4
+ }
package/lib/const.d.ts ADDED
@@ -0,0 +1,17 @@
1
+ import { EVMClientParams } from '@xchainjs/xchain-evm';
2
+ import { Asset } from '@xchainjs/xchain-util';
3
+ export declare const ARB_DECIMAL = 18;
4
+ export declare const LOWER_FEE_BOUND = 100000000;
5
+ export declare const UPPER_FEE_BOUND = 1000000000;
6
+ export declare const ARB_GAS_ASSET_DECIMAL = 18;
7
+ /**
8
+ * Chain identifier for ARB.
9
+ *
10
+ */
11
+ export declare const ARBChain: "ARB";
12
+ /**
13
+ * Base "chain" asset of Arbitrum chain.
14
+ *
15
+ */
16
+ export declare const AssetARB: Asset;
17
+ export declare const defaultArbParams: EVMClientParams;
package/lib/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export * from './client';
2
+ export * from './const';
package/lib/index.esm.js ADDED
@@ -0,0 +1,93 @@
1
+ import { Client as Client$1 } from '@xchainjs/xchain-evm';
2
+ import { Network, ExplorerProvider } from '@xchainjs/xchain-client';
3
+ import { EtherscanProvider } from '@xchainjs/xchain-evm-providers';
4
+ import { ethers, BigNumber } from 'ethers';
5
+
6
+ const ARB_DECIMAL = 18;
7
+ const LOWER_FEE_BOUND = 100000000;
8
+ const UPPER_FEE_BOUND = 1000000000;
9
+ const ARB_GAS_ASSET_DECIMAL = 18;
10
+ /**
11
+ * Chain identifier for ARB.
12
+ *
13
+ */
14
+ const ARBChain = 'ARB';
15
+ /**
16
+ * Base "chain" asset of Arbitrum chain.
17
+ *
18
+ */
19
+ const AssetARB = { chain: ARBChain, symbol: 'ARB', ticker: 'ETH', synth: false };
20
+ // =====Ethers providers=====
21
+ const ARBITRUM_MAINNET_ETHERS_PROVIDER = new ethers.providers.JsonRpcProvider('https://arb1.arbitrum.io/rpc');
22
+ const ARBITRUM_TESTNET_ETHERS_PROVIDER = new ethers.providers.JsonRpcProvider('https://goerli-rollup.arbitrum.io/rpc');
23
+ const ethersJSProviders = {
24
+ [Network.Mainnet]: ARBITRUM_MAINNET_ETHERS_PROVIDER,
25
+ [Network.Testnet]: ARBITRUM_TESTNET_ETHERS_PROVIDER,
26
+ [Network.Stagenet]: ARBITRUM_MAINNET_ETHERS_PROVIDER,
27
+ };
28
+ // =====ONLINE providers=====
29
+ const ARB_ONLINE_PROVIDER_MAINNET = new EtherscanProvider(ARBITRUM_MAINNET_ETHERS_PROVIDER, 'https://api.arbiscan.io', process.env.ARBISCAN_API_KEY || '', ARBChain, AssetARB, 18);
30
+ const ARB_ONLINE_PROVIDER_TESTNET = new EtherscanProvider(ARBITRUM_TESTNET_ETHERS_PROVIDER, 'https://api-goerli.arbiscan.io', process.env.ARBISCAN_API_KEY || '', ARBChain, AssetARB, 18);
31
+ const arbProviders = {
32
+ [Network.Mainnet]: ARB_ONLINE_PROVIDER_MAINNET,
33
+ [Network.Testnet]: ARB_ONLINE_PROVIDER_TESTNET,
34
+ [Network.Stagenet]: ARB_ONLINE_PROVIDER_MAINNET,
35
+ };
36
+ // =====Explorers=====
37
+ const ARB_MAINNET_EXPLORER = new ExplorerProvider('https://arbiscan.io/', 'https://arbiscan.io/address/%%ADDRESS%%', 'https://arbiscan.io/tx/%%TX_ID%%');
38
+ const ARB_TESTNET_EXPLORER = new ExplorerProvider('https://goerli.arbiscan.io', 'https://goerli.arbiscan.io/address/%%ADDRESS%%', 'https://goerli.arbiscan.io/tx/%%TX_ID%%');
39
+ const arbExplorerProviders = {
40
+ [Network.Mainnet]: ARB_MAINNET_EXPLORER,
41
+ [Network.Testnet]: ARB_TESTNET_EXPLORER,
42
+ [Network.Stagenet]: ARB_MAINNET_EXPLORER,
43
+ };
44
+ // =====Explorers=====
45
+ const ethRootDerivationPaths = {
46
+ [Network.Mainnet]: `m/44'/60'/0'/0/`,
47
+ [Network.Testnet]: `m/44'/60'/0'/0/`,
48
+ [Network.Stagenet]: `m/44'/60'/0'/0/`,
49
+ };
50
+ const defaults = {
51
+ [Network.Mainnet]: {
52
+ approveGasLimit: BigNumber.from(200000),
53
+ transferGasAssetGasLimit: BigNumber.from(23000),
54
+ transferTokenGasLimit: BigNumber.from(100000),
55
+ gasPrice: BigNumber.from(0.2 * Math.pow(10, 9)),
56
+ },
57
+ [Network.Testnet]: {
58
+ approveGasLimit: BigNumber.from(200000),
59
+ transferGasAssetGasLimit: BigNumber.from(23000),
60
+ transferTokenGasLimit: BigNumber.from(100000),
61
+ gasPrice: BigNumber.from(0.2 * Math.pow(10, 9)),
62
+ },
63
+ [Network.Stagenet]: {
64
+ approveGasLimit: BigNumber.from(200000),
65
+ transferGasAssetGasLimit: BigNumber.from(23000),
66
+ transferTokenGasLimit: BigNumber.from(100000),
67
+ gasPrice: BigNumber.from(0.2 * Math.pow(10, 9)),
68
+ },
69
+ };
70
+ const defaultArbParams = {
71
+ chain: ARBChain,
72
+ gasAsset: AssetARB,
73
+ gasAssetDecimals: ARB_GAS_ASSET_DECIMAL,
74
+ defaults,
75
+ providers: ethersJSProviders,
76
+ explorerProviders: arbExplorerProviders,
77
+ dataProviders: [arbProviders],
78
+ network: Network.Testnet,
79
+ feeBounds: {
80
+ lower: LOWER_FEE_BOUND,
81
+ upper: UPPER_FEE_BOUND,
82
+ },
83
+ rootDerivationPaths: ethRootDerivationPaths,
84
+ };
85
+
86
+ class Client extends Client$1 {
87
+ constructor(config = defaultArbParams) {
88
+ super(config);
89
+ }
90
+ }
91
+
92
+ export { ARBChain, ARB_DECIMAL, ARB_GAS_ASSET_DECIMAL, AssetARB, Client, LOWER_FEE_BOUND, UPPER_FEE_BOUND, defaultArbParams };
93
+ //# sourceMappingURL=index.esm.js.map
package/lib/index.esm.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.esm.js","sources":["../src/const.ts","../src/client.ts"],"sourcesContent":["import { ExplorerProvider, Network } from '@xchainjs/xchain-client'\nimport { EVMClientParams } from '@xchainjs/xchain-evm'\nimport { EtherscanProvider } from '@xchainjs/xchain-evm-providers'\nimport { Asset } from '@xchainjs/xchain-util'\nimport { BigNumber, ethers } from 'ethers'\n\nexport const ARB_DECIMAL = 18\n\nexport const LOWER_FEE_BOUND = 100_000_000\nexport const UPPER_FEE_BOUND = 1_000_000_000\n\nexport const ARB_GAS_ASSET_DECIMAL = 18\n\n/**\n * Chain identifier for ARB.\n *\n */\nexport const ARBChain = 'ARB' as const\n\n/**\n * Base \"chain\" asset of Arbitrum chain.\n *\n */\nexport const AssetARB: Asset = { chain: ARBChain, symbol: 'ARB', ticker: 'ETH', synth: false }\n\n// =====Ethers providers=====\nconst ARBITRUM_MAINNET_ETHERS_PROVIDER = new ethers.providers.JsonRpcProvider('https://arb1.arbitrum.io/rpc')\nconst ARBITRUM_TESTNET_ETHERS_PROVIDER = new ethers.providers.JsonRpcProvider('https://goerli-rollup.arbitrum.io/rpc')\n\nconst ethersJSProviders = {\n [Network.Mainnet]: ARBITRUM_MAINNET_ETHERS_PROVIDER,\n [Network.Testnet]: ARBITRUM_TESTNET_ETHERS_PROVIDER,\n [Network.Stagenet]: ARBITRUM_MAINNET_ETHERS_PROVIDER,\n}\n\n// =====ONLINE providers=====\n\nconst ARB_ONLINE_PROVIDER_MAINNET = new EtherscanProvider(\n ARBITRUM_MAINNET_ETHERS_PROVIDER,\n 'https://api.arbiscan.io',\n process.env.ARBISCAN_API_KEY || '',\n ARBChain,\n AssetARB,\n 18,\n)\n\nconst ARB_ONLINE_PROVIDER_TESTNET = new EtherscanProvider(\n ARBITRUM_TESTNET_ETHERS_PROVIDER,\n 'https://api-goerli.arbiscan.io',\n process.env.ARBISCAN_API_KEY || '',\n ARBChain,\n AssetARB,\n 18,\n)\n\nconst arbProviders = {\n [Network.Mainnet]: ARB_ONLINE_PROVIDER_MAINNET,\n [Network.Testnet]: ARB_ONLINE_PROVIDER_TESTNET,\n [Network.Stagenet]: ARB_ONLINE_PROVIDER_MAINNET,\n}\n\n// =====Explorers=====\nconst ARB_MAINNET_EXPLORER = new ExplorerProvider(\n 'https://arbiscan.io/',\n 'https://arbiscan.io/address/%%ADDRESS%%',\n 'https://arbiscan.io/tx/%%TX_ID%%',\n)\nconst ARB_TESTNET_EXPLORER = new ExplorerProvider(\n 'https://goerli.arbiscan.io',\n 'https://goerli.arbiscan.io/address/%%ADDRESS%%',\n 'https://goerli.arbiscan.io/tx/%%TX_ID%%',\n)\nconst arbExplorerProviders = {\n [Network.Mainnet]: ARB_MAINNET_EXPLORER,\n [Network.Testnet]: ARB_TESTNET_EXPLORER,\n [Network.Stagenet]: ARB_MAINNET_EXPLORER,\n}\n// =====Explorers=====\n\nconst ethRootDerivationPaths = {\n [Network.Mainnet]: `m/44'/60'/0'/0/`,\n [Network.Testnet]: `m/44'/60'/0'/0/`,\n [Network.Stagenet]: `m/44'/60'/0'/0/`,\n}\n\nconst defaults = {\n [Network.Mainnet]: {\n approveGasLimit: BigNumber.from(200000),\n transferGasAssetGasLimit: BigNumber.from(23000),\n transferTokenGasLimit: BigNumber.from(100000),\n gasPrice: BigNumber.from(0.2 * 10 ** 9),\n },\n [Network.Testnet]: {\n approveGasLimit: BigNumber.from(200000),\n transferGasAssetGasLimit: BigNumber.from(23000),\n transferTokenGasLimit: BigNumber.from(100000),\n gasPrice: BigNumber.from(0.2 * 10 ** 9),\n },\n [Network.Stagenet]: {\n approveGasLimit: BigNumber.from(200000),\n transferGasAssetGasLimit: BigNumber.from(23000),\n transferTokenGasLimit: BigNumber.from(100000),\n gasPrice: BigNumber.from(0.2 * 10 ** 9),\n },\n}\n\nexport const defaultArbParams: EVMClientParams = {\n chain: ARBChain,\n gasAsset: AssetARB,\n gasAssetDecimals: ARB_GAS_ASSET_DECIMAL,\n defaults,\n providers: ethersJSProviders,\n explorerProviders: arbExplorerProviders,\n dataProviders: [arbProviders],\n network: Network.Testnet,\n feeBounds: {\n lower: LOWER_FEE_BOUND,\n upper: UPPER_FEE_BOUND,\n },\n rootDerivationPaths: ethRootDerivationPaths,\n}\n","import { Client as XchainEvmClient } from '@xchainjs/xchain-evm'\n\nimport { defaultArbParams } from './const'\n\nexport class Client extends XchainEvmClient {\n constructor(config = defaultArbParams) {\n super(config)\n }\n}\n"],"names":["XchainEvmClient"],"mappings":";;;;;AAMO,MAAM,WAAW,GAAG,GAAE;AAEtB,MAAM,eAAe,GAAG,UAAW;AACnC,MAAM,eAAe,GAAG,WAAa;AAErC,MAAM,qBAAqB,GAAG,GAAE;AAEvC;;;AAGG;AACI,MAAM,QAAQ,GAAG,MAAc;AAEtC;;;AAGG;MACU,QAAQ,GAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,GAAE;AAE9F;AACA,MAAM,gCAAgC,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,8BAA8B,CAAC,CAAA;AAC7G,MAAM,gCAAgC,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,uCAAuC,CAAC,CAAA;AAEtH,MAAM,iBAAiB,GAAG;AACxB,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG,gCAAgC;AACnD,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG,gCAAgC;AACnD,IAAA,CAAC,OAAO,CAAC,QAAQ,GAAG,gCAAgC;CACrD,CAAA;AAED;AAEA,MAAM,2BAA2B,GAAG,IAAI,iBAAiB,CACvD,gCAAgC,EAChC,yBAAyB,EACzB,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,EAClC,QAAQ,EACR,QAAQ,EACR,EAAE,CACH,CAAA;AAED,MAAM,2BAA2B,GAAG,IAAI,iBAAiB,CACvD,gCAAgC,EAChC,gCAAgC,EAChC,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,EAClC,QAAQ,EACR,QAAQ,EACR,EAAE,CACH,CAAA;AAED,MAAM,YAAY,GAAG;AACnB,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG,2BAA2B;AAC9C,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG,2BAA2B;AAC9C,IAAA,CAAC,OAAO,CAAC,QAAQ,GAAG,2BAA2B;CAChD,CAAA;AAED;AACA,MAAM,oBAAoB,GAAG,IAAI,gBAAgB,CAC/C,sBAAsB,EACtB,yCAAyC,EACzC,kCAAkC,CACnC,CAAA;AACD,MAAM,oBAAoB,GAAG,IAAI,gBAAgB,CAC/C,4BAA4B,EAC5B,gDAAgD,EAChD,yCAAyC,CAC1C,CAAA;AACD,MAAM,oBAAoB,GAAG;AAC3B,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG,oBAAoB;AACvC,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG,oBAAoB;AACvC,IAAA,CAAC,OAAO,CAAC,QAAQ,GAAG,oBAAoB;CACzC,CAAA;AACD;AAEA,MAAM,sBAAsB,GAAG;AAC7B,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG,CAAiB,eAAA,CAAA;AACpC,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG,CAAiB,eAAA,CAAA;AACpC,IAAA,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAiB,eAAA,CAAA;CACtC,CAAA;AAED,MAAM,QAAQ,GAAG;AACf,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG;AACjB,QAAA,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AACvC,QAAA,wBAAwB,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/C,QAAA,qBAAqB,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AAC7C,QAAA,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,GAAG,IAAA,CAAA,GAAA,CAAA,EAAE,EAAI,CAAC,CAAA,CAAC;AACxC,KAAA;AACD,IAAA,CAAC,OAAO,CAAC,OAAO,GAAG;AACjB,QAAA,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AACvC,QAAA,wBAAwB,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/C,QAAA,qBAAqB,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AAC7C,QAAA,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,GAAG,IAAA,CAAA,GAAA,CAAA,EAAE,EAAI,CAAC,CAAA,CAAC;AACxC,KAAA;AACD,IAAA,CAAC,OAAO,CAAC,QAAQ,GAAG;AAClB,QAAA,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AACvC,QAAA,wBAAwB,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/C,QAAA,qBAAqB,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AAC7C,QAAA,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,GAAG,IAAA,CAAA,GAAA,CAAA,EAAE,EAAI,CAAC,CAAA,CAAC;AACxC,KAAA;CACF,CAAA;AAEY,MAAA,gBAAgB,GAAoB;AAC/C,IAAA,KAAK,EAAE,QAAQ;AACf,IAAA,QAAQ,EAAE,QAAQ;AAClB,IAAA,gBAAgB,EAAE,qBAAqB;IACvC,QAAQ;AACR,IAAA,SAAS,EAAE,iBAAiB;AAC5B,IAAA,iBAAiB,EAAE,oBAAoB;IACvC,aAAa,EAAE,CAAC,YAAY,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC,OAAO;AACxB,IAAA,SAAS,EAAE;AACT,QAAA,KAAK,EAAE,eAAe;AACtB,QAAA,KAAK,EAAE,eAAe;AACvB,KAAA;AACD,IAAA,mBAAmB,EAAE,sBAAsB;;;ACnHvC,MAAO,MAAO,SAAQA,QAAe,CAAA;IACzC,WAAY,CAAA,MAAM,GAAG,gBAAgB,EAAA;QACnC,KAAK,CAAC,MAAM,CAAC,CAAA;KACd;AACF;;;;"}
package/lib/index.js ADDED
@@ -0,0 +1,104 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+
5
+ var xchainEvm = require('@xchainjs/xchain-evm');
6
+ var xchainClient = require('@xchainjs/xchain-client');
7
+ var xchainEvmProviders = require('@xchainjs/xchain-evm-providers');
8
+ var ethers = require('ethers');
9
+
10
+ const ARB_DECIMAL = 18;
11
+ const LOWER_FEE_BOUND = 100000000;
12
+ const UPPER_FEE_BOUND = 1000000000;
13
+ const ARB_GAS_ASSET_DECIMAL = 18;
14
+ /**
15
+ * Chain identifier for ARB.
16
+ *
17
+ */
18
+ const ARBChain = 'ARB';
19
+ /**
20
+ * Base "chain" asset of Arbitrum chain.
21
+ *
22
+ */
23
+ const AssetARB = { chain: ARBChain, symbol: 'ARB', ticker: 'ETH', synth: false };
24
+ // =====Ethers providers=====
25
+ const ARBITRUM_MAINNET_ETHERS_PROVIDER = new ethers.ethers.providers.JsonRpcProvider('https://arb1.arbitrum.io/rpc');
26
+ const ARBITRUM_TESTNET_ETHERS_PROVIDER = new ethers.ethers.providers.JsonRpcProvider('https://goerli-rollup.arbitrum.io/rpc');
27
+ const ethersJSProviders = {
28
+ [xchainClient.Network.Mainnet]: ARBITRUM_MAINNET_ETHERS_PROVIDER,
29
+ [xchainClient.Network.Testnet]: ARBITRUM_TESTNET_ETHERS_PROVIDER,
30
+ [xchainClient.Network.Stagenet]: ARBITRUM_MAINNET_ETHERS_PROVIDER,
31
+ };
32
+ // =====ONLINE providers=====
33
+ const ARB_ONLINE_PROVIDER_MAINNET = new xchainEvmProviders.EtherscanProvider(ARBITRUM_MAINNET_ETHERS_PROVIDER, 'https://api.arbiscan.io', process.env.ARBISCAN_API_KEY || '', ARBChain, AssetARB, 18);
34
+ const ARB_ONLINE_PROVIDER_TESTNET = new xchainEvmProviders.EtherscanProvider(ARBITRUM_TESTNET_ETHERS_PROVIDER, 'https://api-goerli.arbiscan.io', process.env.ARBISCAN_API_KEY || '', ARBChain, AssetARB, 18);
35
+ const arbProviders = {
36
+ [xchainClient.Network.Mainnet]: ARB_ONLINE_PROVIDER_MAINNET,
37
+ [xchainClient.Network.Testnet]: ARB_ONLINE_PROVIDER_TESTNET,
38
+ [xchainClient.Network.Stagenet]: ARB_ONLINE_PROVIDER_MAINNET,
39
+ };
40
+ // =====Explorers=====
41
+ const ARB_MAINNET_EXPLORER = new xchainClient.ExplorerProvider('https://arbiscan.io/', 'https://arbiscan.io/address/%%ADDRESS%%', 'https://arbiscan.io/tx/%%TX_ID%%');
42
+ const ARB_TESTNET_EXPLORER = new xchainClient.ExplorerProvider('https://goerli.arbiscan.io', 'https://goerli.arbiscan.io/address/%%ADDRESS%%', 'https://goerli.arbiscan.io/tx/%%TX_ID%%');
43
+ const arbExplorerProviders = {
44
+ [xchainClient.Network.Mainnet]: ARB_MAINNET_EXPLORER,
45
+ [xchainClient.Network.Testnet]: ARB_TESTNET_EXPLORER,
46
+ [xchainClient.Network.Stagenet]: ARB_MAINNET_EXPLORER,
47
+ };
48
+ // =====Explorers=====
49
+ const ethRootDerivationPaths = {
50
+ [xchainClient.Network.Mainnet]: `m/44'/60'/0'/0/`,
51
+ [xchainClient.Network.Testnet]: `m/44'/60'/0'/0/`,
52
+ [xchainClient.Network.Stagenet]: `m/44'/60'/0'/0/`,
53
+ };
54
+ const defaults = {
55
+ [xchainClient.Network.Mainnet]: {
56
+ approveGasLimit: ethers.BigNumber.from(200000),
57
+ transferGasAssetGasLimit: ethers.BigNumber.from(23000),
58
+ transferTokenGasLimit: ethers.BigNumber.from(100000),
59
+ gasPrice: ethers.BigNumber.from(0.2 * Math.pow(10, 9)),
60
+ },
61
+ [xchainClient.Network.Testnet]: {
62
+ approveGasLimit: ethers.BigNumber.from(200000),
63
+ transferGasAssetGasLimit: ethers.BigNumber.from(23000),
64
+ transferTokenGasLimit: ethers.BigNumber.from(100000),
65
+ gasPrice: ethers.BigNumber.from(0.2 * Math.pow(10, 9)),
66
+ },
67
+ [xchainClient.Network.Stagenet]: {
68
+ approveGasLimit: ethers.BigNumber.from(200000),
69
+ transferGasAssetGasLimit: ethers.BigNumber.from(23000),
70
+ transferTokenGasLimit: ethers.BigNumber.from(100000),
71
+ gasPrice: ethers.BigNumber.from(0.2 * Math.pow(10, 9)),
72
+ },
73
+ };
74
+ const defaultArbParams = {
75
+ chain: ARBChain,
76
+ gasAsset: AssetARB,
77
+ gasAssetDecimals: ARB_GAS_ASSET_DECIMAL,
78
+ defaults,
79
+ providers: ethersJSProviders,
80
+ explorerProviders: arbExplorerProviders,
81
+ dataProviders: [arbProviders],
82
+ network: xchainClient.Network.Testnet,
83
+ feeBounds: {
84
+ lower: LOWER_FEE_BOUND,
85
+ upper: UPPER_FEE_BOUND,
86
+ },
87
+ rootDerivationPaths: ethRootDerivationPaths,
88
+ };
89
+
90
+ class Client extends xchainEvm.Client {
91
+ constructor(config = defaultArbParams) {
92
+ super(config);
93
+ }
94
+ }
95
+
96
+ exports.ARBChain = ARBChain;
97
+ exports.ARB_DECIMAL = ARB_DECIMAL;
98
+ exports.ARB_GAS_ASSET_DECIMAL = ARB_GAS_ASSET_DECIMAL;
99
+ exports.AssetARB = AssetARB;
100
+ exports.Client = Client;
101
+ exports.LOWER_FEE_BOUND = LOWER_FEE_BOUND;
102
+ exports.UPPER_FEE_BOUND = UPPER_FEE_BOUND;
103
+ exports.defaultArbParams = defaultArbParams;
104
+ //# sourceMappingURL=index.js.map
package/lib/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sources":["../src/const.ts","../src/client.ts"],"sourcesContent":["import { ExplorerProvider, Network } from '@xchainjs/xchain-client'\nimport { EVMClientParams } from '@xchainjs/xchain-evm'\nimport { EtherscanProvider } from '@xchainjs/xchain-evm-providers'\nimport { Asset } from '@xchainjs/xchain-util'\nimport { BigNumber, ethers } from 'ethers'\n\nexport const ARB_DECIMAL = 18\n\nexport const LOWER_FEE_BOUND = 100_000_000\nexport const UPPER_FEE_BOUND = 1_000_000_000\n\nexport const ARB_GAS_ASSET_DECIMAL = 18\n\n/**\n * Chain identifier for ARB.\n *\n */\nexport const ARBChain = 'ARB' as const\n\n/**\n * Base \"chain\" asset of Arbitrum chain.\n *\n */\nexport const AssetARB: Asset = { chain: ARBChain, symbol: 'ARB', ticker: 'ETH', synth: false }\n\n// =====Ethers providers=====\nconst ARBITRUM_MAINNET_ETHERS_PROVIDER = new ethers.providers.JsonRpcProvider('https://arb1.arbitrum.io/rpc')\nconst ARBITRUM_TESTNET_ETHERS_PROVIDER = new ethers.providers.JsonRpcProvider('https://goerli-rollup.arbitrum.io/rpc')\n\nconst ethersJSProviders = {\n [Network.Mainnet]: ARBITRUM_MAINNET_ETHERS_PROVIDER,\n [Network.Testnet]: ARBITRUM_TESTNET_ETHERS_PROVIDER,\n [Network.Stagenet]: ARBITRUM_MAINNET_ETHERS_PROVIDER,\n}\n\n// =====ONLINE providers=====\n\nconst ARB_ONLINE_PROVIDER_MAINNET = new EtherscanProvider(\n ARBITRUM_MAINNET_ETHERS_PROVIDER,\n 'https://api.arbiscan.io',\n process.env.ARBISCAN_API_KEY || '',\n ARBChain,\n AssetARB,\n 18,\n)\n\nconst ARB_ONLINE_PROVIDER_TESTNET = new EtherscanProvider(\n ARBITRUM_TESTNET_ETHERS_PROVIDER,\n 'https://api-goerli.arbiscan.io',\n process.env.ARBISCAN_API_KEY || '',\n ARBChain,\n AssetARB,\n 18,\n)\n\nconst arbProviders = {\n [Network.Mainnet]: ARB_ONLINE_PROVIDER_MAINNET,\n [Network.Testnet]: ARB_ONLINE_PROVIDER_TESTNET,\n [Network.Stagenet]: ARB_ONLINE_PROVIDER_MAINNET,\n}\n\n// =====Explorers=====\nconst ARB_MAINNET_EXPLORER = new ExplorerProvider(\n 'https://arbiscan.io/',\n 'https://arbiscan.io/address/%%ADDRESS%%',\n 'https://arbiscan.io/tx/%%TX_ID%%',\n)\nconst ARB_TESTNET_EXPLORER = new ExplorerProvider(\n 'https://goerli.arbiscan.io',\n 'https://goerli.arbiscan.io/address/%%ADDRESS%%',\n 'https://goerli.arbiscan.io/tx/%%TX_ID%%',\n)\nconst arbExplorerProviders = {\n [Network.Mainnet]: ARB_MAINNET_EXPLORER,\n [Network.Testnet]: ARB_TESTNET_EXPLORER,\n [Network.Stagenet]: ARB_MAINNET_EXPLORER,\n}\n// =====Explorers=====\n\nconst ethRootDerivationPaths = {\n [Network.Mainnet]: `m/44'/60'/0'/0/`,\n [Network.Testnet]: `m/44'/60'/0'/0/`,\n [Network.Stagenet]: `m/44'/60'/0'/0/`,\n}\n\nconst defaults = {\n [Network.Mainnet]: {\n approveGasLimit: BigNumber.from(200000),\n transferGasAssetGasLimit: BigNumber.from(23000),\n transferTokenGasLimit: BigNumber.from(100000),\n gasPrice: BigNumber.from(0.2 * 10 ** 9),\n },\n [Network.Testnet]: {\n approveGasLimit: BigNumber.from(200000),\n transferGasAssetGasLimit: BigNumber.from(23000),\n transferTokenGasLimit: BigNumber.from(100000),\n gasPrice: BigNumber.from(0.2 * 10 ** 9),\n },\n [Network.Stagenet]: {\n approveGasLimit: BigNumber.from(200000),\n transferGasAssetGasLimit: BigNumber.from(23000),\n transferTokenGasLimit: BigNumber.from(100000),\n gasPrice: BigNumber.from(0.2 * 10 ** 9),\n },\n}\n\nexport const defaultArbParams: EVMClientParams = {\n chain: ARBChain,\n gasAsset: AssetARB,\n gasAssetDecimals: ARB_GAS_ASSET_DECIMAL,\n defaults,\n providers: ethersJSProviders,\n explorerProviders: arbExplorerProviders,\n dataProviders: [arbProviders],\n network: Network.Testnet,\n feeBounds: {\n lower: LOWER_FEE_BOUND,\n upper: UPPER_FEE_BOUND,\n },\n rootDerivationPaths: ethRootDerivationPaths,\n}\n","import { Client as XchainEvmClient } from '@xchainjs/xchain-evm'\n\nimport { defaultArbParams } from './const'\n\nexport class Client extends XchainEvmClient {\n constructor(config = defaultArbParams) {\n super(config)\n }\n}\n"],"names":["ethers","Network","EtherscanProvider","ExplorerProvider","BigNumber","XchainEvmClient"],"mappings":";;;;;;;;;AAMO,MAAM,WAAW,GAAG,GAAE;AAEtB,MAAM,eAAe,GAAG,UAAW;AACnC,MAAM,eAAe,GAAG,WAAa;AAErC,MAAM,qBAAqB,GAAG,GAAE;AAEvC;;;AAGG;AACI,MAAM,QAAQ,GAAG,MAAc;AAEtC;;;AAGG;MACU,QAAQ,GAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,GAAE;AAE9F;AACA,MAAM,gCAAgC,GAAG,IAAIA,aAAM,CAAC,SAAS,CAAC,eAAe,CAAC,8BAA8B,CAAC,CAAA;AAC7G,MAAM,gCAAgC,GAAG,IAAIA,aAAM,CAAC,SAAS,CAAC,eAAe,CAAC,uCAAuC,CAAC,CAAA;AAEtH,MAAM,iBAAiB,GAAG;AACxB,IAAA,CAACC,oBAAO,CAAC,OAAO,GAAG,gCAAgC;AACnD,IAAA,CAACA,oBAAO,CAAC,OAAO,GAAG,gCAAgC;AACnD,IAAA,CAACA,oBAAO,CAAC,QAAQ,GAAG,gCAAgC;CACrD,CAAA;AAED;AAEA,MAAM,2BAA2B,GAAG,IAAIC,oCAAiB,CACvD,gCAAgC,EAChC,yBAAyB,EACzB,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,EAClC,QAAQ,EACR,QAAQ,EACR,EAAE,CACH,CAAA;AAED,MAAM,2BAA2B,GAAG,IAAIA,oCAAiB,CACvD,gCAAgC,EAChC,gCAAgC,EAChC,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,EAClC,QAAQ,EACR,QAAQ,EACR,EAAE,CACH,CAAA;AAED,MAAM,YAAY,GAAG;AACnB,IAAA,CAACD,oBAAO,CAAC,OAAO,GAAG,2BAA2B;AAC9C,IAAA,CAACA,oBAAO,CAAC,OAAO,GAAG,2BAA2B;AAC9C,IAAA,CAACA,oBAAO,CAAC,QAAQ,GAAG,2BAA2B;CAChD,CAAA;AAED;AACA,MAAM,oBAAoB,GAAG,IAAIE,6BAAgB,CAC/C,sBAAsB,EACtB,yCAAyC,EACzC,kCAAkC,CACnC,CAAA;AACD,MAAM,oBAAoB,GAAG,IAAIA,6BAAgB,CAC/C,4BAA4B,EAC5B,gDAAgD,EAChD,yCAAyC,CAC1C,CAAA;AACD,MAAM,oBAAoB,GAAG;AAC3B,IAAA,CAACF,oBAAO,CAAC,OAAO,GAAG,oBAAoB;AACvC,IAAA,CAACA,oBAAO,CAAC,OAAO,GAAG,oBAAoB;AACvC,IAAA,CAACA,oBAAO,CAAC,QAAQ,GAAG,oBAAoB;CACzC,CAAA;AACD;AAEA,MAAM,sBAAsB,GAAG;AAC7B,IAAA,CAACA,oBAAO,CAAC,OAAO,GAAG,CAAiB,eAAA,CAAA;AACpC,IAAA,CAACA,oBAAO,CAAC,OAAO,GAAG,CAAiB,eAAA,CAAA;AACpC,IAAA,CAACA,oBAAO,CAAC,QAAQ,GAAG,CAAiB,eAAA,CAAA;CACtC,CAAA;AAED,MAAM,QAAQ,GAAG;AACf,IAAA,CAACA,oBAAO,CAAC,OAAO,GAAG;AACjB,QAAA,eAAe,EAAEG,gBAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AACvC,QAAA,wBAAwB,EAAEA,gBAAS,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/C,QAAA,qBAAqB,EAAEA,gBAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AAC7C,QAAA,QAAQ,EAAEA,gBAAS,CAAC,IAAI,CAAC,GAAG,GAAG,IAAA,CAAA,GAAA,CAAA,EAAE,EAAI,CAAC,CAAA,CAAC;AACxC,KAAA;AACD,IAAA,CAACH,oBAAO,CAAC,OAAO,GAAG;AACjB,QAAA,eAAe,EAAEG,gBAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AACvC,QAAA,wBAAwB,EAAEA,gBAAS,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/C,QAAA,qBAAqB,EAAEA,gBAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AAC7C,QAAA,QAAQ,EAAEA,gBAAS,CAAC,IAAI,CAAC,GAAG,GAAG,IAAA,CAAA,GAAA,CAAA,EAAE,EAAI,CAAC,CAAA,CAAC;AACxC,KAAA;AACD,IAAA,CAACH,oBAAO,CAAC,QAAQ,GAAG;AAClB,QAAA,eAAe,EAAEG,gBAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AACvC,QAAA,wBAAwB,EAAEA,gBAAS,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/C,QAAA,qBAAqB,EAAEA,gBAAS,CAAC,IAAI,CAAC,MAAM,CAAC;AAC7C,QAAA,QAAQ,EAAEA,gBAAS,CAAC,IAAI,CAAC,GAAG,GAAG,IAAA,CAAA,GAAA,CAAA,EAAE,EAAI,CAAC,CAAA,CAAC;AACxC,KAAA;CACF,CAAA;AAEY,MAAA,gBAAgB,GAAoB;AAC/C,IAAA,KAAK,EAAE,QAAQ;AACf,IAAA,QAAQ,EAAE,QAAQ;AAClB,IAAA,gBAAgB,EAAE,qBAAqB;IACvC,QAAQ;AACR,IAAA,SAAS,EAAE,iBAAiB;AAC5B,IAAA,iBAAiB,EAAE,oBAAoB;IACvC,aAAa,EAAE,CAAC,YAAY,CAAC;IAC7B,OAAO,EAAEH,oBAAO,CAAC,OAAO;AACxB,IAAA,SAAS,EAAE;AACT,QAAA,KAAK,EAAE,eAAe;AACtB,QAAA,KAAK,EAAE,eAAe;AACvB,KAAA;AACD,IAAA,mBAAmB,EAAE,sBAAsB;;;ACnHvC,MAAO,MAAO,SAAQI,gBAAe,CAAA;IACzC,WAAY,CAAA,MAAM,GAAG,gBAAgB,EAAA;QACnC,KAAK,CAAC,MAAM,CAAC,CAAA;KACd;AACF;;;;;;;;;;;"}
package/package.json ADDED
@@ -0,0 +1,55 @@
1
+ {
2
+ "name": "@xchainjs/xchain-arbitrum",
3
+ "version": "0.1.1",
4
+ "description": "Arbitrum EVM client for XChainJS",
5
+ "keywords": [
6
+ "XChain",
7
+ "Arbitrum Virtual Machine"
8
+ ],
9
+ "author": "XChainJS",
10
+ "homepage": "https://github.com/xchainjs/xchainjs-lib",
11
+ "license": "MIT",
12
+ "main": "lib/index.js",
13
+ "module": "lib/index.esm.js",
14
+ "typings": "lib/index.d.ts",
15
+ "directories": {
16
+ "lib": "lib",
17
+ "test": "__tests__"
18
+ },
19
+ "files": [
20
+ "lib"
21
+ ],
22
+ "repository": {
23
+ "type": "git",
24
+ "url": "git@github.com:xchainjs/xchainjs-lib.git"
25
+ },
26
+ "scripts": {
27
+ "clean": "rimraf lib/**",
28
+ "build": "yarn clean && rollup -c",
29
+ "test": "jest --passWithNoTests",
30
+ "e2e": "jest --config jest.config.e2e.js",
31
+ "lint": "eslint \"{src,__tests__, __mocks__}/**/*.ts\" --fix --max-warnings 0",
32
+ "prepublishOnly": "yarn build"
33
+ },
34
+ "publishConfig": {
35
+ "access": "public"
36
+ },
37
+ "devDependencies": {
38
+ "@xchainjs/xchain-client": "^0.15.3",
39
+ "@xchainjs/xchain-crypto": "^0.3.0",
40
+ "@xchainjs/xchain-evm": "^0.4.1",
41
+ "@xchainjs/xchain-util": "^0.13.1",
42
+ "@xchainjs/xchain-evm-providers": "^0.1.3",
43
+ "axios": "^1.3.6",
44
+ "ethers": "^5.7.2"
45
+ },
46
+ "peerDependencies": {
47
+ "@xchainjs/xchain-client": "^0.15.3",
48
+ "@xchainjs/xchain-crypto": "^0.3.0",
49
+ "@xchainjs/xchain-evm": "^0.4.1",
50
+ "@xchainjs/xchain-util": "^0.13.1",
51
+ "@xchainjs/xchain-evm-providers": "^0.1.3",
52
+ "axios": "^1.3.6",
53
+ "ethers": "^5.7.2"
54
+ }
55
+ }