Skip to content

Commit d02c781

Browse files
committed
🚚 migrate to @get-smooth orga
1 parent 9825e36 commit d02c781

File tree

5 files changed

+26
-67
lines changed

5 files changed

+26
-67
lines changed

README.md

Lines changed: 14 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@
88
[![Github Actions][gha-release-badge]][gha-release-url] [![Foundry][foundry-badge]][foundry]
99
[![License: MIT][license-badge]][license] ![Is it audited?][audit]
1010

11-
[github-editor-url]: https://github.dev/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/tree/main
11+
[github-editor-url]: https://github.dev/get-smooth/secp256r1-verify/tree/main
1212
[github-editor-badge]: https://img.shields.io/badge/Github-Open%20the%20Editor-purple?logo=github
1313
[gha-quality-url]:
14-
https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/actions/workflows/quality-checks.yml
14+
https://github.com/get-smooth/secp256r1-verify/actions/workflows/quality-checks.yml
1515
[gha-quality-badge]:
16-
https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/actions/workflows/quality-checks.yml/badge.svg?branch=main
17-
[gha-test-url]: https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/actions/workflows/tests.yml
16+
https://github.com/get-smooth/secp256r1-verify/actions/workflows/quality-checks.yml/badge.svg?branch=main
17+
[gha-test-url]: https://github.com/get-smooth/secp256r1-verify/actions/workflows/tests.yml
1818
[gha-test-badge]:
19-
https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/actions/workflows/tests.yml/badge.svg?branch=main
19+
https://github.com/get-smooth/secp256r1-verify/actions/workflows/tests.yml/badge.svg?branch=main
2020
[gha-static-analysis-url]:
21-
https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/actions/workflows/static-analysis.yml
21+
https://github.com/get-smooth/secp256r1-verify/actions/workflows/static-analysis.yml
2222
[gha-static-analysis-badge]:
23-
https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/template-foundry/actions/workflows/static-analysis.yml/badge.svg?branch=main
23+
https://github.com/get-smooth/template-foundry/actions/workflows/static-analysis.yml/badge.svg?branch=main
2424
[gha-release-url]:
25-
https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/actions/workflows/release-package.yml
25+
https://github.com/get-smooth/secp256r1-verify/actions/workflows/release-package.yml
2626
[gha-release-badge]:
27-
https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/actions/workflows/release-package.yml/badge.svg
27+
https://github.com/get-smooth/secp256r1-verify/actions/workflows/release-package.yml/badge.svg
2828
[foundry]: https://book.getfoundry.sh/
2929
[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
3030
[license]: ./LICENSE.md
@@ -46,31 +46,16 @@ Renaud Dubois' [FreshCryptoLib](https://github.com/rdubois-crypto/FreshCryptoLib
4646
To install the `secp256r1-verify` package in a Foundry project, execute the following command:
4747

4848
```sh
49-
forge install https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify
49+
forge install https://github.com/get-smooth/secp256r1-verify
5050
```
5151

5252
This command will install the latest version of the package in your lib directory. To install a specific version of the
5353
library, follow the instructions in the
5454
[official Foundry documentation](https://book.getfoundry.sh/reference/forge/forge-install?highlight=forge%20install#forge-install).
5555

56-
### Hardhat or Truffle
57-
58-
To install the `secp256r1-verify` package in a Hardhat or Truffle project, use `npm` to run the following command:
59-
60-
```sh
61-
npm install @0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify
62-
```
63-
64-
After the installation, import the package into your project and use it.
65-
66-
> ⚠️ Note: This package is not published on the npm registry, and is only available on GitHub Packages. You need to be
67-
> authenticated with GitHub Packages to install it. For more information, please refer to the
68-
> [troubleshooting section](#setup-github-registry). We are willing to deploy it on the npm registry if there is a need.
69-
> Please open an issue if you would like to see this package on the npm registry.
70-
7156
## Usage
7257

73-
This repository provides an unique verification implementation. After you've integrated this library into your project,
58+
This repository provides a unique verification implementation. After you've integrated this library into your project,
7459
you can freely import the `ECDSA256r1` and use it.
7560

7661
> 🚨 The implementations have not been audited. DO NOT USE IT IN PRODUCTION.
@@ -98,9 +83,9 @@ scripts are expected to be run using the `forge script` command.
9883

9984
These gas reports were produced using the `0.8.19` version of the Solidity compiler (with 100k optimizer runs),
10085
specifically for the
101-
[`0.4.1`](https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/releases/tag/v0.4.1) version of the
86+
[`0.4.1`](https://github.com/get-smooth/secp256r1-verify/releases/tag/v0.4.1) version of the
10287
library. The library version corresponds to commit
103-
[4d0716f](https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/commit/4d0716fc6fd14a92488442e1dd0c18bb2c24ff41).
88+
[4d0716f](https://github.com/get-smooth/secp256r1-verify/commit/4d0716fc6fd14a92488442e1dd0c18bb2c24ff41).
10489

10590
> ℹ️ If you import the library into your project, we strongly recommend you to enable the optimizer with 100k in order
10691
> to have the best gas consumption.
@@ -238,7 +223,7 @@ The tests use two different `cheatcodes` you should be aware of:
238223
calculates 256 points on the secp256r1 elliptic curve from a public key. This is required for the variants that need
239224
these points to be deployed on-chain. Therefore, even if it's not explicit, every time you run the test suite, a
240225
Node.js script is executed multiple times. You can learn more about the library we use
241-
[here](https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-computation).
226+
[here](https://github.com/get-smooth/secp256r1-computation).
242227

243228
> 📖 Cheatcodes are special instructions exposed by Foundry to enhance the developer experience. Learn more about them
244229
> [here](https://book.getfoundry.sh/cheatcodes/).
@@ -261,32 +246,6 @@ make quality # run both
261246

262247
> ℹ️ By adding the sufix `-fix` the linter and the formatter will try to fix the issues automatically.
263248
264-
## Troubleshootings
265-
266-
### Setup Github registry
267-
268-
You need to configure npm to use the Github registry. You can do so using the following command in your terminal:
269-
270-
```sh
271-
npm config set @0x90d2b2b7fb7599eebb6e7a32980857d8:registry=https://npm.pkg.github.com
272-
```
273-
274-
This will instruct npm to use the Github registry for packages deployed by `@0x90d2b2b7fb7599eebb6e7a32980857d8`.
275-
276-
Once the Github registry is configured, you have to create a **classic** token on Github. To do so, go to your
277-
[Github settings](https://github.com/settings/tokens). The token must have the read:packages scope. Once you have
278-
created the token, use the following command in your terminal to authenticate to the Github registry:
279-
280-
```sh
281-
npm login --auth-type=legacy --registry=https://npm.pkg.github.com
282-
```
283-
284-
Your Github username is the username, and the password is the token you just created. At this point, your git should be
285-
configured to use the Github Package Registry for our packages.
286-
287-
> ⚠️ For more information, please refer to the
288-
> [GitHub documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package)
289-
290249
## Acknowledgements
291250

292251
Special thanks to [rdubois-crypto](https://github.com/rdubois-crypto) for developing the reference implementation

makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ prettier-fix:
129129
# example: `c0=XXX c1=XXX make compute`
130130
.PHONY: compute-points
131131
compute-points:
132-
@runcmd npx @0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-computation $(c0) $(c1)
132+
@runcmd npx @get-smooth/secp256r1-computation $(c0) $(c1)
133133

134134
##########################################
135135
################ ALIASES ################

package-lock.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify",
2+
"name": "@get-smooth/secp256r1-verify",
33
"description": "A solidity library to verify a secp256r1 signature",
44
"version": "0.5.3",
55
"contributors": [
@@ -16,18 +16,18 @@
1616
],
1717
"repository": {
1818
"type": "git",
19-
"url": "[email protected]:0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify.git"
19+
"url": "[email protected]:get-smooth/secp256r1-verify.git"
2020
},
2121
"bugs": {
22-
"url": "https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify/issues"
22+
"url": "https://github.com/get-smooth/secp256r1-verify/issues"
2323
},
24-
"homepage": "https://github.com/0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-verify#readme",
24+
"homepage": "https://github.com/get-smooth/secp256r1-verify#readme",
2525
"engines": {
2626
"node": ">= 18"
2727
},
2828
"license": "MIT",
2929
"devDependencies": {
30-
"@0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-computation": "^2.2.0",
30+
"@get-smooth/secp256r1-computation": "^2.2.0",
3131
"lefthook": "^1.4.1",
3232
"prettier": "^2.8.7",
3333
"solhint": "^3.4.0"

script/ComputePoints.s.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ contract MyScript is Script {
1818
// and return the table as a bytes
1919
string[] memory inputs = new string[](4);
2020
inputs[0] = "npx";
21-
inputs[1] = "@0x90d2b2b7fb7599eebb6e7a32980857d8/secp256r1-computation";
21+
inputs[1] = "@get-smooth/secp256r1-computation";
2222
inputs[2] = vm.toString(c0);
2323
inputs[3] = vm.toString(c1);
2424
points = vm.ffi(inputs);

0 commit comments

Comments
 (0)