Skip to content

Commit

Permalink
all: Adds author tags
Browse files Browse the repository at this point in the history
  • Loading branch information
pmerkleplant committed Nov 26, 2023
1 parent a4049ad commit 0a3024b
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 80 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ forge install pmerkleplant/crysol
```ml
src
├─ Random - "Provides access to cryptographically secure randomness"
├─ Message - "Functionality for constructing Ethereum Message Hashes"
├─ Message - "Functionality for constructing Ethereum Signed Message Hashes"
├─ curves
│ ├─ Secp256k1 - "Provides common cryptography-related functionality for the secp256k1 elliptic curve"
│ └─ Secp256k1Arithmetic — "Provides common arithmetic-related functionality for the secp256k1 elliptic curve"
Expand Down Expand Up @@ -67,7 +67,7 @@ $ forge fmt [--check]
| **Library** | **Unit Tests** | **Property-Based Tests** | **Specification-Based Tests** |
| ---------------------------- | -------------- | ------------------------ | ----------------------------- |
| `Random` ||||
| `Message` ||| |
| `Message` ||| |
| `curves/Secp256k1` ||||
| `curves/Secp256k1Arithmetic` ||||
| `signatures/ECDSA` ||||
Expand Down
36 changes: 0 additions & 36 deletions spec/Message.spec.sol

This file was deleted.

10 changes: 0 additions & 10 deletions spec/README.md

This file was deleted.

3 changes: 3 additions & 0 deletions src/Message.sol
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ pragma solidity ^0.8.16;
*
* @custom:references
* - [eth_sign]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign
*
* @author crysol (https://github.com/pmerkleplant/crysol)
* @author Inspired by OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts)
*/
library Message {
/// @dev Returns an Ethereum Signed Message Hash from message `message`'s
Expand Down
2 changes: 2 additions & 0 deletions src/Random.sol
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import {Vm} from "forge-std/Vm.sol";
* @notice Provides access to cryptographically secure randomness
*
* @dev Randomness is sourced from cast's `wallet new` command.
*
* @author crysol (https://github.com/pmerkleplant/crysol)
*/
library Random {
// ~~~~~~~ Prelude ~~~~~~~
Expand Down
3 changes: 3 additions & 0 deletions src/curves/Secp256k1.sol
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ struct PublicKey {
*
* @notice Providing common cryptography-related functionality for the secp256k1
* elliptic curve
*
* @author crysol (https://github.com/pmerkleplant/crysol)
* @author Inspired by Chronicle Protocol's Scribe (https://github.com/chronicleprotocol/scribe)
*/
library Secp256k1 {
using Secp256k1 for PrivateKey;
Expand Down
3 changes: 3 additions & 0 deletions src/curves/Secp256k1Arithmetic.sol
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ struct JacobianPoint {
* @custom:references
* - [SEC 2 v2]: https://www.secg.org/sec2-v2.pdf
* - [Yellow Paper]: TODO
*
* @author crysol (https://github.com/pmerkleplant/crysol)
* @author Inspired by Chronicle Protocol's Scribe (https://github.com/chronicleprotocol/scribe)
*/
library Secp256k1Arithmetic {
using Secp256k1Arithmetic for AffinePoint;
Expand Down
2 changes: 2 additions & 0 deletions src/signatures/ECDSA.sol
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ struct Signature {
* - [SEC 1 v2]: https://www.secg.org/sec1-v2.pdf
* - [EIP-2]: https://eips.ethereum.org/EIPS/eip-2
* - [EIP-2098]: https://eips.ethereum.org/EIPS/eip-2098
*
* @author crysol (https://github.com/pmerkleplant/crysol)
*/
library ECDSA {
using ECDSA for address;
Expand Down
3 changes: 3 additions & 0 deletions src/signatures/Schnorr.sol
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ struct Signature {
* secp256k1 elliptic curve and keccak256 hash function.
*
* @custom:docs docs/signatures/Schnorr.md
*
* @author crysol (https://github.com/pmerkleplant/crysol)
* @author Inspired by Chronicle Protocol's Scribe (https://github.com/chronicleprotocol/scribe)
*/
library Schnorr {
using Schnorr for address;
Expand Down
32 changes: 0 additions & 32 deletions test/Message.spec.t.sol

This file was deleted.

0 comments on commit 0a3024b

Please sign in to comment.