Skip to content

Fix/readme #14

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix/readme #14

wants to merge 3 commits into from

Conversation

Zaptoss
Copy link
Contributor

@Zaptoss Zaptoss commented Jul 25, 2024

No description provided.

Zaptoss added 3 commits July 25, 2024 11:32
…nge proof in tests. Some tests fail because proof must be generated in the same day that test pass. One test alway fail because of disabled verifier logic.
@Zaptoss Zaptoss requested a review from violog July 25, 2024 09:14
@Zaptoss Zaptoss self-assigned this Jul 25, 2024
@@ -3,7 +3,7 @@
## Introduction

This repository is an SDK for connecting external services with Rarimo passport
verification system that may be used in back-end services. Its main purpose is
verification and voting systems that may be used in back-end services. Its main purpose is
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
verification and voting systems that may be used in back-end services. Its main purpose is
passport and voting proof verification system that may be used in back-end services. Its main purpose is

@@ -20,16 +20,16 @@ import (
)

func main() {
rv := root.NewVerifier(contractCaller, reqTimeout)
passportVerifier := root.NewPoseidonSMTVerifier(rpcURL, contractAddress, reqTimeout)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not general usage. Add headers: Passport, Voting, etc.

root_verifier:
rpc: https://your-rpc
contract: 0x...
verifier:
Copy link
Contributor

Choose a reason for hiding this comment

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

Add examples of using config. It might be either ProvideVerifier() with specified Type or custom initialization without Provider.

@@ -166,6 +169,12 @@ func WithPollRootVerifier(v root.Verifier) VerifyOption {
}
}

func withSkipExpirationCheck(check bool) VerifyOption {
Copy link
Contributor

Choose a reason for hiding this comment

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

comment that it's only for tests, or make it exported and describe a use case

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