voxelithic-interfaces 0.4.0 → 0.5.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.
- package/LICENSE +12 -6
- package/README.md +34 -1
- package/dist/addresses.d.ts +2 -0
- package/dist/addresses.js +2 -0
- package/package.json +4 -2
- package/src/addresses.ts +3 -0
package/LICENSE
CHANGED
|
@@ -3,13 +3,19 @@ MIT License
|
|
|
3
3
|
Copyright (c) 2026 Voxelithic
|
|
4
4
|
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files, to deal
|
|
7
|
-
without restriction, including without limitation the rights
|
|
8
|
-
modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
Software, and to permit persons to whom the Software is
|
|
10
|
-
subject to the following conditions:
|
|
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
11
|
|
|
12
12
|
The above copyright notice and this permission notice shall be included in all
|
|
13
13
|
copies or substantial portions of the Software.
|
|
14
14
|
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND
|
|
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
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# voxelithic-interfaces
|
|
2
2
|
|
|
3
|
+
[](https://github.com/Voxelithicag/interfaces/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/voxelithic-interfaces)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
|
|
3
7
|
TypeScript types, contract ABIs and verified addresses for Voxelithic on Robinhood Chain (4663).
|
|
4
8
|
|
|
5
9
|
## Install
|
|
@@ -46,10 +50,26 @@ The full picture of what else carries these tickers is at
|
|
|
46
50
|
| `ROUTER`, `QUOTER` | Uniswap v3 style venues, deployed and verified |
|
|
47
51
|
| `ROUTER_V4`, `QUOTER_V4` | Uniswap v4 singleton branch |
|
|
48
52
|
| `UNISWAP_V4_SINGLETON` | the v4 pool manager |
|
|
53
|
+
| `TREASURY` | fee recipient; everything it receives is swapped into VOXEL and burned |
|
|
49
54
|
| `TOKENS`, `SYMBOLS`, `addressOf` | canonical token set |
|
|
50
55
|
| `VoxRouterABI`, `VoxQuoterABI`, `VoxRouterV4ABI`, `VoxQuoterV4ABI` | ABIs taken from the Foundry build artifacts, not retyped |
|
|
51
56
|
| `Hop`, `Route`, `Quote`, `PoolKey` | request and response shapes |
|
|
52
57
|
|
|
58
|
+
## Or skip the install
|
|
59
|
+
|
|
60
|
+
The same routing is available over HTTP, with no package and no key:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
curl 'https://voxelithic.xyz/api/v1/quote?tokenIn=USDG&tokenOut=SPY&amountIn=10'
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
`/tokens` and `/venues` mirror the exports above, `/quote` compares every direct
|
|
67
|
+
pool that can actually take the size, `/swap` returns an unsigned transaction and
|
|
68
|
+
`/verify` reads what a fill really did from its receipt.
|
|
69
|
+
|
|
70
|
+
The API holds no keys and cannot broadcast. Spec and service level:
|
|
71
|
+
[openapi.json](https://voxelithic.xyz/api/v1/openapi.json).
|
|
72
|
+
|
|
53
73
|
## Regenerating the token set
|
|
54
74
|
|
|
55
75
|
```bash
|
|
@@ -59,6 +79,18 @@ node scripts/gen-tokens.mjs /path/to/app/config.js
|
|
|
59
79
|
Every address is verified against mainnet as it is written. The script exits
|
|
60
80
|
non-zero and leaves the file untouched if anything fails.
|
|
61
81
|
|
|
82
|
+
## Tests
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
npm test # imports the built package and checks its shape
|
|
86
|
+
npm run test:onchain # every address in the package must exist on mainnet
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
The first suite runs against `dist`, not the sources, because that is where a
|
|
90
|
+
published package actually breaks. The second one is why the addresses here can
|
|
91
|
+
be trusted: an address with no contract, a mismatched symbol or wrong decimals
|
|
92
|
+
fails the run. Both are wired into CI on every push.
|
|
93
|
+
|
|
62
94
|
## Contracts
|
|
63
95
|
|
|
64
96
|
| Contract | Address |
|
|
@@ -67,8 +99,9 @@ non-zero and leaves the file untouched if anything fails.
|
|
|
67
99
|
| VoxQuoter | `0x9616627E871c96e38cb21b9551F62Ed93366bE1B` |
|
|
68
100
|
| VoxRouterV4 | `0x290b9b46308f7a3B80A5F62214B426d3bfAfaab5` |
|
|
69
101
|
| VoxQuoterV4 | `0x5858F06894623eF4862103A747074E5AA3436d4F` |
|
|
102
|
+
| VoxTreasury | `0xDfC6004E2a56de0e59007BFC4F3E3890a889af67` |
|
|
70
103
|
|
|
71
|
-
All
|
|
104
|
+
All five are verified on
|
|
72
105
|
[Blockscout](https://robinhoodchain.blockscout.com/address/0x87cD7EbE8c213455e5e5a8554657D5f294a82e64).
|
|
73
106
|
|
|
74
107
|
## License
|
package/dist/addresses.d.ts
CHANGED
|
@@ -4,3 +4,5 @@ export declare const QUOTER: "0x9616627E871c96e38cb21b9551F62Ed93366bE1B";
|
|
|
4
4
|
export declare const ROUTER_V4: "0x290b9b46308f7a3B80A5F62214B426d3bfAfaab5";
|
|
5
5
|
export declare const QUOTER_V4: "0x5858F06894623eF4862103A747074E5AA3436d4F";
|
|
6
6
|
export declare const UNISWAP_V4_SINGLETON: "0xc851aDa1e4Fa2A9dd5483284d6b30e2950Cc4F04";
|
|
7
|
+
/** Получатель комиссии. Всё, что сюда приходит, выкупает VOXEL и сжигает его. */
|
|
8
|
+
export declare const TREASURY: "0xDfC6004E2a56de0e59007BFC4F3E3890a889af67";
|
package/dist/addresses.js
CHANGED
|
@@ -4,3 +4,5 @@ export const QUOTER = '0x9616627E871c96e38cb21b9551F62Ed93366bE1B';
|
|
|
4
4
|
export const ROUTER_V4 = '0x290b9b46308f7a3B80A5F62214B426d3bfAfaab5';
|
|
5
5
|
export const QUOTER_V4 = '0x5858F06894623eF4862103A747074E5AA3436d4F';
|
|
6
6
|
export const UNISWAP_V4_SINGLETON = '0xc851aDa1e4Fa2A9dd5483284d6b30e2950Cc4F04';
|
|
7
|
+
/** Получатель комиссии. Всё, что сюда приходит, выкупает VOXEL и сжигает его. */
|
|
8
|
+
export const TREASURY = '0xDfC6004E2a56de0e59007BFC4F3E3890a889af67';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "voxelithic-interfaces",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "TypeScript types, contract ABIs and verified addresses for Voxelithic on Robinhood Chain (4663)",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"robinhood-chain",
|
|
@@ -38,8 +38,10 @@
|
|
|
38
38
|
"sideEffects": false,
|
|
39
39
|
"scripts": {
|
|
40
40
|
"build": "tsc",
|
|
41
|
+
"test": "node test/smoke.mjs",
|
|
42
|
+
"test:onchain": "node test/onchain.mjs",
|
|
41
43
|
"gen:tokens": "node scripts/gen-tokens.mjs",
|
|
42
|
-
"prepublishOnly": "npm run build"
|
|
44
|
+
"prepublishOnly": "npm run build && npm test"
|
|
43
45
|
},
|
|
44
46
|
"devDependencies": {
|
|
45
47
|
"typescript": "^5.6.0"
|
package/src/addresses.ts
CHANGED
|
@@ -5,3 +5,6 @@ export const QUOTER = '0x9616627E871c96e38cb21b9551F62Ed93366bE1B' as const
|
|
|
5
5
|
export const ROUTER_V4 = '0x290b9b46308f7a3B80A5F62214B426d3bfAfaab5' as const
|
|
6
6
|
export const QUOTER_V4 = '0x5858F06894623eF4862103A747074E5AA3436d4F' as const
|
|
7
7
|
export const UNISWAP_V4_SINGLETON = '0xc851aDa1e4Fa2A9dd5483284d6b30e2950Cc4F04' as const
|
|
8
|
+
|
|
9
|
+
/** Получатель комиссии. Всё, что сюда приходит, выкупает VOXEL и сжигает его. */
|
|
10
|
+
export const TREASURY = '0xDfC6004E2a56de0e59007BFC4F3E3890a889af67' as const
|