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

Removing proof mechanism environment variable #85

Closed
wants to merge 1 commit into from

Conversation

mmwilder26
Copy link
Contributor

@mmwilder26 mmwilder26 commented Nov 7, 2023

Yes, am aware that proof mechanism is valid and we have removed KHIPU.

Based on recent changes and talks, makes sense to remove the proof mechanism environment variable on the readme for samples since KHIPU is not an option and we are leaning towards most users on simple hash. Greater number of people using our samples "should" be on simple hash in theory. Removing decreases confusion and ran wipp sample w/out the environment variable and as expected it works.

Oh and removed the word "KHIPU" from the main repo readme also.

 Mention [stepsize] in a comment if you'd like to report some technical debt. See examples here.

Signed-off-by: Madia Wilder <mwilder@Madias-MBP.attlocal.net>
@mmwilder26 mmwilder26 requested a review from eccles November 7, 2023 20:28
@@ -34,21 +34,17 @@ export TEST_ARCHIVIST="https://app.rkvst.io"
export TEST_AUTHTOKEN_FILENAME=credentials/.auth_token
export TEST_NAMESPACE="unique label"
export TEST_VERBOSE=-v
export TEST_PROOF_MECHANISM="--proof-mechanism=SIMPLE_HASH"
Copy link
Contributor

Choose a reason for hiding this comment

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

The problem with removing altogether is that in about 2 months we'll have the Khipu replacement and will have to put it all back again. Especially given that testing the new stuff is important I think we should leave this

Windows using Powershell - at the command prompt set values for environment variables:

```bash
$Env:TEST_ARCHIVIST="https://app.rkvst.io"
$Env:TEST_AUTHTOKEN_FILENAME = '<path of token location>'
$Env:TEST_NAMESPACE = Get-Date -UFormat %s
$Env:TEST_VERBOSE = '-v'
$Env:TEST_PROOF_MECHANISM="--proof-mechanism=SIMPLE_HASH"
Copy link
Contributor

Choose a reason for hiding this comment

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

The problem with removing altogether is that in about 2 months we'll have the Khipu replacement and will have to put it all back again. Especially given that testing the new stuff is important I think we should leave this

@@ -73,7 +69,7 @@ Events are created every execution of an example - currently no check is done if
All examples use a common set of arguments:

```bash
export AUTH="-u $TEST_ARCHIVIST -t $TEST_AUTHTOKEN_FILENAME $TEST_VERBOSE $TEST_PROOF_MECHANISM"
Copy link
Contributor

Choose a reason for hiding this comment

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

The problem with removing altogether is that in about 2 months we'll have the Khipu replacement and will have to put it all back again. Especially given that testing the new stuff is important I think we should leave this

```

If TEST_VERBOSE is "-v" debugging output will appear when running the examples. Otherwise leave blank or undefined.

TEST_PROOF_MECHANISM should be "KHIPU" or "SIMPLE_HASH". If unspecified the default is "SIMPLE_HASH"
Copy link
Contributor

Choose a reason for hiding this comment

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

TEST_PROOF_MECHANISM should be "SIMPLE_HASH"

@mmwilder26 mmwilder26 closed this Nov 7, 2023
@eccles eccles mentioned this pull request Jul 2, 2024
@JAG-UK JAG-UK deleted the mmwilder26/readme_noproofmech branch July 10, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants