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.

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

Jump to bottom

Add a forc-crypto plugin exposing a CLI for common-use cryptographic operations #4318

Closed
mitchmindtree opened this issue Mar 21, 2023 · 6 comments · Fixed by #5153
Closed

Add a forc-crypto plugin exposing a CLI for common-use cryptographic operations #4318

mitchmindtree opened this issue Mar 21, 2023 · 6 comments · Fixed by #5153
Assignees
@cr-fuel
Labels
enhancement New feature or request forc P: medium

Comments

@mitchmindtree
Copy link
Contributor

Raised by @SilentCicero in slack.

The idea is to expose common-use fuel cryptographic functions like sha256, keccak256, ecrecover via forc plugin(s).

The original proposal was for a forc utils subcommand with a broader scope, though I'm thinking it could be worth having more descriptive plugins for each set of tools.

A forc-crypto plugin might include commands like the following:

  • forc crypto sha256 ...
  • forc crypto keccak256 ...
  • forc crypto ecrecover ...
  • forc crypto bech32-to-hex ...
  • forc crypto hex-to-bech32 ...

Commands like sha256 and keccak256 should support both file and string arguments. The same likely goes for the ecrecover message.

The plugin should likely be shipped by fuelup as a part of the default set of components.

This plugin should go in its own repo, but we can use this issue to track until then.
@mitchmindtree mitchmindtree added enhancement New feature or request forc labels Mar 21, 2023
@JoshuaBatty
Copy link
Member

JoshuaBatty commented Jul 11, 2023 •
edited
Loading

Here are some examples where the SDK has these conversions:

Some examples here:

  1. https://github.com/FuelLabs/fuels-rs/blob/257a77cfdc7e2829df7b9ab88d91e949a6b59aa5/examples/wallets/src/lib.rs#L360
  2. https://github.com/FuelLabs/fuels-rs/blob/12cd13305123de7ceb6c9e4689e76289eeff05ea/examples/types/src/lib.rs#L90-L96
  3. Docs: http://rust.fuel.network/v0.41.1/types/bech32.html

@Voxelot
Copy link
Member

Voxelot commented Aug 8, 2023

Also consider migrating some of the fuel-core-keygen functionality over: https://github.com/FuelLabs/fuel-core/blob/master/bin/keygen/src/keygen.rs

@Voxelot
Copy link
Member

Voxelot commented Sep 28, 2023

any updates?

@cr-fuel
Copy link
Contributor

cr-fuel commented Sep 28, 2023

@Voxelot A PR will be uploaded in a few hours.

cr-fuel added a commit that referenced this issue Sep 28, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
9d5d985 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [ ] bech32-to-hex
* [ ] hex-to-bech32
cr-fuel added a commit that referenced this issue Sep 28, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
92959a3 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
@cr-fuel cr-fuel mentioned this issue Sep 28, 2023
Merged
13 tasks
cr-fuel added a commit that referenced this issue Sep 28, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
b650a4e 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
cr-fuel added a commit that referenced this issue Sep 28, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
8aa0c0c 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
cr-fuel added a commit that referenced this issue Sep 28, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
b86d53c 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
cr-fuel added a commit that referenced this issue Sep 28, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
799fe49 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
cr-fuel added a commit that referenced this issue Sep 28, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
c697961 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
cr-fuel added a commit that referenced this issue Sep 28, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
bcf4d51 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
cr-fuel added a commit that referenced this issue Sep 29, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
994b1c4 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
cr-fuel added a commit that referenced this issue Sep 30, 2023
@cr-fuel
WIP: #4318 forc-crypto plugin exposing a CLI for common-use cryptog…
f719fb0 
…raphic operations

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ecrecover
* [x] bech32-to-hex
* [x] hex-to-bech32
cr-fuel added a commit that referenced this issue Oct 4, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
d249160 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 4, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
bc2baa6 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 4, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
164dc80 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 9, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
3170507 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 13, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
74a3907 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 13, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
406a291 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 17, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
8b29828 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 18, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
b2cbc11 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 24, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
9897bd5 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 26, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
43fff6e 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 28, 2023
@cr-fuel
Add forc-crypto plugin exposing a CLI for common-use cryptographic op…
0ba11b2 
…erations

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key
* [x] new-parse secret
cr-fuel added a commit that referenced this issue Oct 28, 2023
@cr-fuel
#4318 forc-crypto plugin exposing a CLI for common-use cryptographi…
6d345f6 
…c operations (#5153)

## Description

Fixes #4318

Supported algorithms:
* [x] keccak256
* [x] sha256
* [ ] ~ecrecover~ (this will be added later)
* [x] bech32-to-hex
* [x] hex-to-bech32
* [x] new-key / parse-secret (from
https://github.com/FuelLabs/fuel-core/blob/master/bin/keygen/src/keygen.rs)

## Checklist

- [x] I have linked to any relevant issues.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [x] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.
@block0xhash
Copy link

Hi is this plugin available by any chance to try out ?

@JoshuaBatty
Copy link
Member

We just added the binary to fuelup. It should be available on the nightly toolchain from tomorrow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cr-fuel cr-fuel

Labels
enhancement New feature or request forc P: medium
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#4318 forc-crypto plugin exposing a CLI for common-use cryptographic operations FuelLabs/sway
5 participants
@Voxelot @JoshuaBatty @mitchmindtree @block0xhash @cr-fuel