Skip to content
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.

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

Release chores #336

Merged
merged 4 commits into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ pnpm doc:publish

## Publishing

TODO: Update after implementing publishing.
TODO: Update after implementing automated publishing.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Full documentation can be found [here](https://docs.threshold.network/app-develo
>
> `nucypher-ts` is under [active development](https://github.com/nucypher/nucypher-ts/pulls):
>
> - SDK does not support policy revocation.
> - SDK does not support access revocation.
Copy link
Member

@KPrasch KPrasch Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can safely remove this now? It's not a true statement anymore since access can be revoked by way of policy expiration or unsatisfied on-chain condition.

> - We expect breaking changes.

## Installation
Expand All @@ -25,12 +25,12 @@ To learn more, follow the tutorial at Threshold Network's [docs](https://docs.th

See [`nucypher-ts/examples`](https://github.com/nucypher/nucypher-ts/tree/main/examples) to find out how to integrate `nucypher-ts` into your favorite web framework.

We also provide two code samples of TAC applications:
We also provide demos of TACo applications:

- [nucypher/tdec-sandbox](https://github.com/nucypher/tdec-sandbox)
- [nucypher/tdec-nft-example](https://github.com/nucypher/tdec-nft-example)
- [taco-demo](https://github.com/nucypher/nucypher-ts/tree/main/demos/taco-demo)
- [taco-nft-demo](https://github.com/nucypher/nucypher-ts/tree/main/demos/taco-nft-demo)

These examples showcase integration with React-based web application and an end-to-end flow of creating conditioned encryption, and encrypting & decrypting data.
These examples showcase integration with web applications and an end-to-end flow of creating conditioned encryption, and encrypting & decrypting data.

Comment on lines +32 to 33
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# Contributing

Expand Down
3 changes: 0 additions & 3 deletions demos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,3 @@

- [`taco-demo`](./taco-demo) - A demo of the `@nucypher/taco` library.
- [`taco-nft-demo`](./taco-nft-demo) - A demo an NFT-based condition using the `@nucypher/taco` library.
- [`nucypher-ts-demo`](https://github.com/nucypher/nucypher-ts-demo) - A demo of PRE in the `nucypher-ts` library.
- [`tdec-sandbox`](https://github.com/nucypher/tdec-sandbox) - A demo of tDec in the `nucypher-ts` library.
- [`tdec-nft-example`](https://github.com/nucypher/tdec-nft-example) - A demo of tDec in the `nucypher-ts` library.
2 changes: 2 additions & 0 deletions demos/taco-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# taco-demo

See this demo in action at https://taco-demo.netlify.app/

## Installation

```bash
Expand Down
5 changes: 4 additions & 1 deletion demos/taco-demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"typecheck": "tsc --noEmit"
},
"dependencies": {
"@nucypher/taco": "workspace:*",
"@nucypher/taco": "0.1.0-rc.3",
"@usedapp/core": "^1.2.13",
"buffer": "^6.0.3",
"ethers": "^5.7.1",
Expand All @@ -22,6 +22,9 @@
"react-dom": "^18.2.0",
"react-spinners": "^0.13.6"
},
"peerDependencies": {
"@nucypher/taco": "workspace:*"
},
"devDependencies": {
"@pmmmwh/react-refresh-webpack-plugin": "^0.5.7",
"@types/react": "^18.0.20",
Expand Down
4 changes: 3 additions & 1 deletion demos/taco-nft-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# taco-nft-example
# taco-nft-demo

See this demo in action at https://taco-nft-demo.netlify.app/

## Installation

Expand Down
5 changes: 4 additions & 1 deletion demos/taco-nft-demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"typecheck": "tsc --noEmit"
},
"dependencies": {
"@nucypher/taco": "workspace:*",
"@nucypher/taco": "0.1.0-rc.3",
"@usedapp/core": "^1.2.13",
"buffer": "^6.0.3",
"ethers": "^5.7.1",
Expand All @@ -22,6 +22,9 @@
"react-dom": "^18.2.0",
"react-spinners": "^0.13.6"
},
"peerDependencies": {
"@nucypher/taco": "workspace:*"
},
"devDependencies": {
"@pmmmwh/react-refresh-webpack-plugin": "^0.5.7",
"@types/react": "^18.0.20",
Expand Down
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
This directory contains a set of examples showing how to integrate `@nucypher/*`
into your application.

Refer to `./taco` for examples of how to use the `@nucypher/taco` package. Refer
to `./pre` for examples of how to use the `@nucypher/pre` package.
- Refer to `./taco` for examples of how to use the `@nucypher/taco` package.
- Refer to `./pre` for examples of how to use the `@nucypher/pre` package.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"license": "GPL-3.0-only",
"author": "Piotr Roslaniec <[email protected]>",
"scripts": {
"postinstall": "pnpm build || true && echo 'Ignoring build errors on setup until we publish the first version'",
"postinstall": "pnpm build",
"typedoc": "typedoc",
"typedoc:all": "pnpm run --parallel --aggregate-output --reporter append-only typedoc",
"typedoc:publish": "gh-pages -m \"[ci skip] Update typedoc docs\" -d docs",
Expand Down
4 changes: 2 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 8 additions & 5 deletions tsconfig.prod.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"compilerOptions": {
"declaration": true,
"lib": ["ES2018"],
"lib": [
"ES2018"
],
"module": "CommonJS",
"moduleResolution": "node",
"strict": true,
Expand All @@ -13,17 +15,18 @@
},
"files": [],
"references": [
// Order matters
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@piotr-roslaniec Was this auto-generated? - JSON doesn't allow for comments.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not autogenerated. Yes, JSON doesn't allow comments, but tsconfig.json is not a strict JSON and it allows comments.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 - Interesting

{
"path": "./packages/pre/tsconfig.es.json"
"path": "./packages/shared/tsconfig.es.json"
},
{
"path": "./packages/pre/tsconfig.cjs.json"
"path": "./packages/shared/tsconfig.cjs.json"
},
{
"path": "./packages/shared/tsconfig.es.json"
"path": "./packages/pre/tsconfig.es.json"
},
{
"path": "./packages/shared/tsconfig.cjs.json"
"path": "./packages/pre/tsconfig.cjs.json"
},
{
"path": "./packages/taco/tsconfig.es.json"
Expand Down