Skip to content

Commit b25a2de

Browse files
just-tobyjust-toby
authored
feat(breaking): esm/cjs builds for uniswapx-sdk (#218)
## PR Scope breaking change to build structure for `uniswapx-sdk` ## Description updates the build setup for `uniswapx-sdk` to manually and explicitly create separate cjs and esm builds (plus a types-only version) ## How Has This Been Tested? built the sdk locally, then installed the local build result in another project (`universe/apps/web`) and verified that it properly resolved the esm version instead of the cjs version ## Are there any breaking changes? there shouldn't be, but technically if an end user is importing incorrectly (by directly referencing the `uniswapx-sdk.esm.js` file) then they'll need to update ## (Optional) Follow Ups PRs to follow will do this for many other SDKs
1 parent 6963bfa commit b25a2de

14 files changed

+68
-28
lines changed

‎sdks/uniswapx-sdk/.eslintrc.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"parser": "@typescript-eslint/parser",
33
"parserOptions": {
4-
"project": "./tsconfig.json"
4+
"project": "./tsconfig.base.json"
55
},
66
"env": {
77
"es6": true
@@ -60,4 +60,4 @@
6060
"always-multiline"
6161
]
6262
}
63-
}
63+
}

‎sdks/uniswapx-sdk/integration/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@
2424
"chai": "^4.3.6",
2525
"hardhat": "^2.22.15",
2626
"husky": "^8.0.3",
27-
"ts-node": "^10.9.1",
28-
"tsdx": "^0.14.1"
27+
"ts-node": "^10.9.1"
2928
},
3029
"dependencies": {
3130
"@ethersproject/bytes": "^5.7.0",

‎sdks/uniswapx-sdk/integration/test/PriorityOrder.spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import Permit2Abi from "../../abis/Permit2.json";
1010
import MockERC20Abi from "../../abis/MockERC20.json";
1111

1212
import { Permit2, PriorityOrderReactor, MockERC20 } from "../../src/contracts";
13-
import { PriorityOrderBuilder, PriorityCosignerData } from "../../dist/src";
13+
import { PriorityOrderBuilder, PriorityCosignerData } from "../../src";
1414

1515
describe("PriorityOrder", () => {
1616
const FEE_RECIPIENT = "0x1111111111111111111111111111111111111111";

‎sdks/uniswapx-sdk/integration/test/PriorityOrderValidator.spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import {
1919
OrderValidation,
2020
PriorityCosignerData,
2121
CosignedPriorityOrder,
22-
} from "../../dist/src";
22+
} from "../../src";
2323
import { StaticJsonRpcProvider } from "@ethersproject/providers";
2424
import { REACTOR_ADDRESS_MAPPING, UNISWAPX_ORDER_QUOTER_MAPPING } from "../../src/constants";
2525
import { parseEther } from "ethers/lib/utils";

‎sdks/uniswapx-sdk/integration/test/RelayOrderValidator.spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import {
1717
RelayOrderBuilder,
1818
RelayOrderValidator,
1919
RelayOrder,
20-
} from "../../dist/src";
20+
} from "../../src";
2121
import { deployAndReturnPermit2 } from "./utils/permit2";
2222
import { deployMulticall3 } from "./utils/multicall";
2323

‎sdks/uniswapx-sdk/integration/test/V3DutchOrder.spec.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import Permit2Abi from "../../abis/Permit2.json"
44
import V3DutchOrderReactorAbi from "../../abis/V3DutchOrderReactor.json"
55
import MockERC20Abi from "../../abis/MockERC20.json"
66
import { Permit2, V3DutchOrderReactor } from "../../src/contracts"
7-
import { MockERC20 } from "../../dist/src/contracts";
7+
import { MockERC20 } from "../../src/contracts";
88
import { BlockchainTime } from "./utils/time";
99
import { V3DutchOrderBuilder } from "../../src/builder/V3DutchOrderBuilder"
1010
import { expect } from "chai";
@@ -830,4 +830,4 @@ const getCosignerData = async (
830830
outputOverrides: [BigNumber.from(0)],
831831
};
832832
return Object.assign(defaultData, overrides);
833-
};
833+
};

‎sdks/uniswapx-sdk/jest.config.js

+6-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,9 @@
22
module.exports = {
33
preset: 'ts-jest',
44
testEnvironment: 'node',
5-
};
5+
globals: {
6+
'ts-jest': {
7+
tsconfig: 'tsconfig.base.json'
8+
}
9+
}
10+
};

‎sdks/uniswapx-sdk/package.json

+18-7
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,27 @@
77
"ethereum"
88
],
99
"license": "MIT",
10-
"main": "dist/src/index.js",
11-
"typings": "dist/src/index.d.ts",
12-
"module": "dist/uniswapx-sdk.esm.js",
10+
"main": "./dist/cjs/src/index.js",
11+
"typings": "./dist/types/src/index.d.ts",
12+
"module": "./dist/esm/src/index.js",
1313
"files": [
1414
"dist"
1515
],
1616
"engines": {
1717
"node": ">=10"
1818
},
1919
"scripts": {
20-
"build": "yarn run typechain && tsc -p tsconfig.json",
20+
"build": "yarn run typechain && yarn build:cjs && yarn build:esm && yarn build:types",
21+
"build:cjs": "tsc -p tsconfig.cjs.json",
22+
"build:esm": "tsc -p tsconfig.esm.json",
23+
"build:types": "tsc -p tsconfig.types.json",
2124
"lint": "eslint src --ext .ts",
2225
"lint:fix": "eslint src --ext .ts --fix",
2326
"prettier": "prettier \"src/**/*.ts\" --list-different",
2427
"release": "semantic-release",
25-
"test": "run-s build test:unit test:integration",
28+
"test": "run-s test:unit test:integration",
2629
"test:unit": "jest --testPathPattern src --detectOpenHandles --forceExit --testPathIgnorePatterns dist",
27-
"test:integration": "yarn build && cd integration && yarn && yarn test",
30+
"test:integration": "cd integration && yarn && yarn test",
2831
"typechain": "typechain --target=ethers-v5 --out-dir src/contracts --glob ./abis/**/*.json"
2932
},
3033
"dependencies": {
@@ -96,5 +99,13 @@
9699
}
97100
]
98101
]
99-
}
102+
},
103+
"exports": {
104+
".": {
105+
"types": "./dist/types/src/index.d.ts",
106+
"import": "./dist/esm/src/index.js",
107+
"require": "./dist/cjs/src/index.js"
108+
}
109+
},
110+
"sideEffects": false
100111
}

‎sdks/uniswapx-sdk/tsconfig.json ‎sdks/uniswapx-sdk/tsconfig.base.json

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
{
2-
"include": [
3-
"src"
4-
],
2+
"include": ["src", "abis"],
53
"compilerOptions": {
6-
"outDir": "dist",
4+
"rootDir": ".",
5+
"baseUrl": ".",
76
"target": "es6",
8-
"module": "commonjs",
97
"importHelpers": true,
108
"declaration": true,
119
"sourceMap": true,
@@ -23,6 +21,7 @@
2321
"moduleResolution": "node",
2422
"resolveJsonModule": true,
2523
"esModuleInterop": true,
26-
"skipLibCheck": true
27-
},
28-
}
24+
"skipLibCheck": true,
25+
"isolatedModules": true
26+
}
27+
}

‎sdks/uniswapx-sdk/tsconfig.cjs.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"extends": "./tsconfig.base.json",
3+
"compilerOptions": {
4+
"module": "commonjs",
5+
"outDir": "dist/cjs"
6+
}
7+
}

‎sdks/uniswapx-sdk/tsconfig.esm.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"extends": "./tsconfig.base.json",
3+
"compilerOptions": {
4+
"module": "esnext",
5+
"outDir": "dist/esm"
6+
}
7+
}

‎sdks/uniswapx-sdk/tsconfig.types.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"extends": "./tsconfig.base.json",
3+
"compilerOptions": {
4+
"declaration": true,
5+
"emitDeclarationOnly": true,
6+
"outDir": "dist/types"
7+
}
8+
}

‎turbo.json

+7-2
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,16 @@
1313
"sdks/*/src/**.ts",
1414
"sdks/*/src/**.tsx"
1515
],
16-
"outputs": []
16+
"outputs": [
17+
"sdks/*/dist/**"
18+
]
1719
},
1820
"test": {
1921
"dependsOn": [
2022
"build"
23+
],
24+
"inputs": [
25+
"sdks/*/dist/**"
2126
]
2227
},
2328
"release": {
@@ -27,4 +32,4 @@
2732
"dependsOn": []
2833
}
2934
}
30-
}
35+
}

‎yarn.lock

-1
Original file line numberDiff line numberDiff line change
@@ -17616,7 +17616,6 @@ __metadata:
1761617616
hardhat: ^2.22.15
1761717617
husky: ^8.0.3
1761817618
ts-node: ^10.9.1
17619-
tsdx: ^0.14.1
1762017619
typechain: ^8.1.0
1762117620
languageName: unknown
1762217621
linkType: soft

0 commit comments

Comments
 (0)