-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from tkhq/olivia/export
Add export files
- Loading branch information
Showing
8 changed files
with
16,558 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,38 @@ | ||
# recovery | ||
# Frames | ||
|
||
This repository contains code for the recovery component of Turnkey. This self-contained HTML page is meant to be used as a standalone document to help first-party Turnkey root users. It's also going to be embedded as an iframe to help with sub-org root recovery. | ||
This repository contains code for the recovery and export components of Turnkey. These components can be embedded as iframes by users to support end-users in recovery and export. | ||
|
||
This page is hosted on Github pages at https://tkhq.github.io/recovery/ | ||
## Email Recovery | ||
This self-contained HTML page is meant to be used as a standalone document to help first-party Turnkey root users. It's also going to be embedded as an iframe to help with sub-org root recovery. | ||
|
||
# Running tests | ||
This page is hosted at https://recovery.tkhqlabs.xyz/ | ||
|
||
This HTML page has tests. They run on CI automatically. If you want to run them locally: | ||
## Key and Wallet Export | ||
This self-contained HTML page is meant to be used as either a standalone document or to be embedded as an iframe. | ||
|
||
This page is hosted at https://export.tkhqlabs.xyz/ | ||
|
||
# Getting Started | ||
|
||
Clone the repo: | ||
```sh | ||
git clone [email protected]:tkhq/frames.git | ||
cd frames/ | ||
``` | ||
|
||
Install dependencies | ||
```sh | ||
npm install | ||
``` | ||
|
||
# Unit Testing | ||
|
||
This HTML page has tests. They run on CI automatically. If you want to run them locally: | ||
```sh | ||
npm test | ||
``` | ||
|
||
# Running a fake recovery | ||
# Running a Fake Recovery | ||
|
||
Download mono, then check out `zeke-recovery-demo`: | ||
```sh | ||
|
@@ -47,3 +67,19 @@ test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 4 filtered out; fini | |
``` | ||
|
||
Now, paste the artifacts and then decrypt! Note the Enclave Auth Key should already be correct. | ||
|
||
# Running Local Wallet Export | ||
Start the server. This command will run a simple static server on port 8080. | ||
```sh | ||
npm start | ||
``` | ||
|
||
Clone the `sdk` repo. | ||
```sh | ||
git clone [email protected]:tkhq/sdk.git | ||
``` | ||
|
||
Follow the README.md for the `key-export` example. Set the `NEXT_PUBLIC_EXPORT_IFRAME_URL="http://localhost:3000/export"` in the example's environment variables configuration. The `wallet-export` example embeds this page as an iframe. | ||
```sh | ||
cd sdk/examples/wallet-export | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
module.exports = { | ||
presets: [ | ||
[ | ||
'@babel/preset-env' | ||
], | ||
], | ||
} |
Oops, something went wrong.