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

Add isDeviceSupported method #1359

Merged
merged 6 commits into from
Jul 12, 2024

Conversation

gtsonevv
Copy link
Collaborator

@gtsonevv gtsonevv commented Jul 11, 2024

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • Commit messages follow the conventional commits spec
  • If this is a code change: I have written unit tests.
  • If this changes code in a published package: I have run pnpm changeset to create a changeset JSON document appropriate for this change.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Test Plan

Related issues/PRs

@gtsonevv gtsonevv requested a review from vikinatora July 11, 2024 08:08
Copy link

changeset-bot bot commented Jul 11, 2024

🦋 Changeset detected

Latest commit: 731d95c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@near-js/biometric-ed25519 Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gtsonevv gtsonevv changed the title Add is device supported method Add isDeviceSupported method Jul 11, 2024
Copy link
Collaborator

@andy-haynes andy-haynes left a comment

Choose a reason for hiding this comment

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

Looks good overall, some questions inline

// To check if current device is supported
export const isDeviceSupported = async (): Promise<boolean> => {
try {
await createKey('test-device');
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there any way to check for support without side effects?

I see that the current implementation uses the response from createKey, so it's probably not a straightforward thing. But if you are aware of a less intrusive check it would be helpful to document in a comment or follow-up issue.

If this is the necessary approach however, would it be better to use a different key each time? I.e. is the outcome the same if the test-device key doesn't exist vs was previously created?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

After spending some time researching how to do this we found that the only way to do it was by using the response from createKey. The outcome should be the same after each call.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you for the clarification

packages/biometric-ed25519/src/index.ts Outdated Show resolved Hide resolved
.github/workflows/pull-request.yml Outdated Show resolved Hide resolved
@gtsonevv gtsonevv requested a review from andy-haynes July 12, 2024 11:56
@andy-haynes
Copy link
Collaborator

@race-of-sloths 🦥

@race-of-sloths
Copy link

race-of-sloths commented Jul 12, 2024

@gtsonevv Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
New Sloth joined the Race! Welcome!

Shows profile picture for the author of the PR

Current status: executed
Reviewer Score
@andy-haynes 3

The average score is 3

@gtsonevv check out your results on the Race of Sloths Leaderboard! and in the profile

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

  • Tag @race-of-sloths inside your pull requests
  • Wait for the maintainer to review and score your pull request
  • Check out your position in the Leaderboard
  • Keep weekly and monthly streaks to reach higher positions
  • Boast your contributions with a dynamic picture of your Profile

For maintainers:

  • Score pull requests that participate in the Race of Sloths
  • Engage contributors with fair scoring and fast responses so they keep their streaks
  • Promote the Race to the point where the Race starts promoting you
  • Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands
  • For contributors
    • Include a PR: @race-of-sloths include to enter the Race with your PR
  • For maintainers:
    • Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
    • Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
    • Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

@andy-haynes
Copy link
Collaborator

@race-of-sloths score 3

Copy link
Collaborator

@andy-haynes andy-haynes left a comment

Choose a reason for hiding this comment

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

🚢

@race-of-sloths
Copy link

🌟 Score recorded!

@andy-haynes, thank you for scoring this pull request in the Race of Sloths!

@andy-haynes andy-haynes merged commit 6d675e9 into near:master Jul 12, 2024
1 check failed
@andy-haynes andy-haynes mentioned this pull request Jul 12, 2024
5 tasks
@github-actions github-actions bot mentioned this pull request Jul 12, 2024
@race-of-sloths
Copy link

✅ PR is finalized!

Your contribution is much appreciated with a final score of 3!
You have received 40 (30 base + 10 weekly bonus) Sloth points for this contribution

Another weekly streak completed, well done @gtsonevv! To keep your weekly streak and get another bonus make pull request next week! Looking forward to see you in race-of-sloths

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.

3 participants