@automata-network/2fa-guru-sdk

Introduction

The 2FA Guru SDK is a JavaScript library for developers to seamlessly interact with smart contracts that have extended 2FA functionalities.

---

Specification

Smart Contract

Implementation smart contracts must inherit the TwoFactorBase contract. The TwoFactorBase contract includes the following administrative methods:

• Initializing the variable twoFactorAuthenticator to our authenticator contract address.
• Toggle 2FA protection using the enabled2FAProtection and disable2FAProtection methods.
• The only2FA modifier. Functions with the modifier on a contract can only be called with a signature prepared by the geode upon successful verification (sending a correct 6 digit code)

Source Code:

• TwoFactorBase:
• Example Contract:

SDK

The main module has the following functions built-in:

• signupFor2fa- Generates a secret for authenticator apps such as Google to generate a six digit verification code during 2fa sign up.

• confirmSignupFor2fa - Uses the six digit verification code to store the wallet-secret pair in the geode.

• reset2fa - Generates a secret for authenticator apps such as Google to generate a six digit verification code during 2fa reset.

• confirmReset2fa - Uses the six digit verification code to reset the wallet-secret pair in the geode.

• addRecoveryWallet - Bind a recovery wallet to your primary wallet on chain. A recovery wallet will be used for the reset of 2fa.

• disable2fa - Disable the 2fa for your connected primary wallet. There will be a cooldown period before disabling the 2fa.

• cancel2faCooldown - Cancels the cooldown period before disabling of 2fa.

• check2fa - Returns a signature for contract calls from geode if verification code is valid

• executeTxnCall - Execute a low lvl call to the blockchain. Used with the signature generated from check2fa()

• is2faCreated - Check whether a wallet is signed up for 2FA

• get2faCooldown - Check at what timestamp 2fa will be disabled for the wallet

• getBindingExpiry - Check at what timestamp recovery wallet binding will be disabllowed for the primary wallet

• getRecoveryWallet - Retrieve the recovery wallet of a primary wallet. 0x0 is returned if no recovery wallet is present.

• getWalletNonce - Retrieve the nonce of a wallet address

Source Code

https://github.com/automata-network/2fa-guru-sdk

---

Quick Guide

Prerequisite

Install the SDK by running:

yarn add @automata-network/2fa-guru-sdk

Instantiate the module with a provider, authenticator contract and your own project contract

import { TwoFAGuru } from '@automata-network/2fa-guru-sdk';

const twoFAGuru = new TwoFAGuru(_provider, _authenticatorContract, _tokenContract)

`_provider` - The provider in which the module will use for blockchain calls
`_authenticatorContract` - Our authenticator contract address
`_tokenContract` - Your project contract address that has implemented TwoFactorBase.sol