Skip to content

Fix dist package for typescript #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 14, 2021
Merged

Fix dist package for typescript #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1533ca5
Use tsconfig.declarationMap, sourceMap
cgewecke Dec 1, 2021
3a19e0e
Update README with working import examples
cgewecke Dec 1, 2021
8b85dc6
Update version to 0.1.5-tsdebug.1
cgewecke Dec 8, 2021
1661e2d
Update version to 0.1.5-tsdebug.2
cgewecke Dec 8, 2021
9d70783
Update version to 0.1.5-tsdebug.3 / copy typechain to dist
cgewecke Dec 9, 2021
5e0c2e7
Update version to 0.1.6
cgewecke Dec 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,21 @@ OR `yarn test:clean` if contracts have been typings need to be updated

We publish our contracts as well as [hardhat][22] and [typechain][23] compilation artifacts to npm.

```
npm install @setprotocol/set-protocol-v2
```

The distribution also comes with fixtures for mocking and testing SetProtocol's interactions with
other protocols including Uniswap, Balancer, Compound (and many more.) To use these you'll need to install the peer dependencies listed in `package.json`.

```
npm install @setprotocol/set-protocol-v2
#### Example Usage

```ts
import { PerpV2Fixture } from "@setprotocol/set-protocol-v2/dist/utils/fixtures/PerpV2Fixture";
import { getPerpV2Fixture } from "@setprotocol/set-protocol-v2/dist/utils/test";

let perpSetup: PerpV2Fixture;
perpSetup = getPerpV2Fixture(...);
```

[22]: https://www.npmjs.com/package/hardhat
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@setprotocol/set-protocol-v2",
"version": "0.1.5",
"version": "0.1.6",
"description": "",
"main": "dist",
"types": "dist/types",
Expand All @@ -17,7 +17,7 @@
"scripts": {
"build": "yarn clean && yarn compile && yarn build:typechain",
"build:npm": "yarn clean && yarn compile:npm && yarn build:typechain",
"build:typechain": "yarn typechain && yarn transpile-dist",
"build:typechain": "yarn typechain && yarn transpile-dist && cp -rf typechain dist",
"chain": "npx hardhat node",
"clean": "rm -rf coverage.json .coverage_cache .coverage_contracts cache coverage typechain artifacts dist",
"compile": "npx hardhat compile",
Expand Down
3 changes: 2 additions & 1 deletion tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"outDir": "dist",
"resolveJsonModule": true,
"declaration": true,
"declarationDir": "./dist/types",
"declarationMap": true,
"sourceMap": true,
"baseUrl": ".",
"moduleResolution": "node",
"paths": {
Expand Down