This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 14a4d49
Showing
152 changed files
with
25,856 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# EditorConfig helps developers define and maintain consistent | ||
# coding styles between different editors and IDEs | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
|
||
indent_style = space | ||
indent_size = 2 | ||
|
||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true |
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,3 @@ | ||
*.pbxproj -text | ||
# specific for windows script files | ||
*.bat text eol=crlf |
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,27 @@ | ||
name: Setup | ||
description: Setup Node.js and install dependencies | ||
|
||
runs: | ||
using: composite | ||
steps: | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version-file: .nvmrc | ||
|
||
- name: Cache dependencies | ||
id: yarn-cache | ||
uses: actions/cache@v3 | ||
with: | ||
path: | | ||
**/node_modules | ||
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} | ||
restore-keys: | | ||
${{ runner.os }}-yarn- | ||
- name: Install dependencies | ||
if: steps.yarn-cache.outputs.cache-hit != 'true' | ||
run: | | ||
yarn install --cwd example --frozen-lockfile | ||
yarn install --frozen-lockfile | ||
shell: bash |
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,48 @@ | ||
name: CI | ||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- name: Setup | ||
uses: ./.github/actions/setup | ||
|
||
- name: Lint files | ||
run: yarn lint | ||
|
||
- name: Typecheck files | ||
run: yarn typecheck | ||
|
||
test: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- name: Setup | ||
uses: ./.github/actions/setup | ||
|
||
- name: Run unit tests | ||
run: yarn test --maxWorkers=2 --coverage | ||
|
||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- name: Setup | ||
uses: ./.github/actions/setup | ||
|
||
- name: Build package | ||
run: yarn prepack |
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,24 @@ | ||
name: Publish package to GitHub Packages | ||
on: | ||
release: | ||
types: [created] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: read | ||
packages: write | ||
steps: | ||
- uses: actions/checkout@v3 | ||
# Setup .npmrc file to publish to GitHub Packages | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: '16.x' | ||
registry-url: 'https://npm.pkg.github.com' | ||
# Defaults to the user or organization that owns the workflow file | ||
scope: '@coinbase' | ||
- run: npm ci | ||
- run: npm publish | ||
env: | ||
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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,80 @@ | ||
# OSX | ||
# | ||
.DS_Store | ||
|
||
# XDE | ||
.expo/ | ||
|
||
# VSCode | ||
.vscode/ | ||
jsconfig.json | ||
|
||
# Xcode | ||
# | ||
build/ | ||
*.pbxuser | ||
!default.pbxuser | ||
*.mode1v3 | ||
!default.mode1v3 | ||
*.mode2v3 | ||
!default.mode2v3 | ||
*.perspectivev3 | ||
!default.perspectivev3 | ||
xcuserdata | ||
*.xccheckout | ||
*.moved-aside | ||
DerivedData | ||
*.hmap | ||
*.ipa | ||
*.xcuserstate | ||
project.xcworkspace | ||
|
||
# Android/IJ | ||
# | ||
.classpath | ||
.cxx | ||
.gradle | ||
.idea | ||
.project | ||
.settings | ||
local.properties | ||
android.iml | ||
|
||
# Cocoapods | ||
# | ||
example/ios/Pods | ||
|
||
# Ruby | ||
example/vendor/ | ||
|
||
# node.js | ||
# | ||
node_modules/ | ||
example/node_modules | ||
npm-debug.log | ||
yarn-debug.log | ||
yarn-error.log | ||
|
||
# BUCK | ||
buck-out/ | ||
\.buckd/ | ||
android/app/libs | ||
android/libs | ||
android/keystores/debug.keystore | ||
|
||
# Expo | ||
.expo/ | ||
|
||
# Turborepo | ||
.turbo/ | ||
|
||
# generated by bob | ||
lib/ | ||
|
||
# Uncompressed frameworks | ||
ios/WaasSdkGo.xcframework/ios-arm64/WaasSdkGo.framework | ||
ios/WaasSdkGo.xcframework/ios-arm64-simulator/WaasSdkGo.framework | ||
ios/WaasSdkGo.xcframework/ios-x86_64-simulator/WaasSdkGo.framework | ||
|
||
# Android built-frameworks | ||
android/libs/go-internal*.aar |
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,2 @@ | ||
registry=https://registry.npmjs.org | ||
@coinbase:registry=https://registry.npmjs.org |
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 @@ | ||
16.18.1 |
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 @@ | ||
{} |
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,3 @@ | ||
# Override Yarn command so we can automatically setup the repo on running `yarn` | ||
|
||
yarn-path "scripts/bootstrap.js" |
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,13 @@ | ||
Copyright (c) 2018-2023 Coinbase, Inc. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
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,108 @@ | ||
# React Native WaaS SDK | ||
|
||
This is the repository for the mobile React Native SDK for Wallet-as-a-Service APIs. | ||
It exposes a subset of the WaaS APIs to the mobile developer and, in particular, is | ||
required for the completion of MPC operations such as Seed generation and Transaction signing. | ||
|
||
### Prerequisites: | ||
|
||
- [node 18+](https://nodejs.org/en/download/) | ||
- [yarn classic 1.22+](https://classic.yarnpkg.com/en/docs/install) | ||
|
||
For iOS development: | ||
- [Xcode 14.0+](https://developer.apple.com/xcode/) | ||
- iOS15.2+ simulator (iPhone 14 recommended) | ||
- [CocoaPods](https://guides.cocoapods.org/using/getting-started.html) | ||
|
||
For Android development: | ||
- [Android Studio](https://developer.android.com/studio) | ||
- x86_64 Android emulator running Android 30+ (Pixel 5 running S recommended) | ||
- [Android NDK](https://developer.android.com/ndk) | ||
- [Java 8](https://www.java.com/en/download) | ||
- [Java JDK 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) (JDK 19 will not work with React Native) | ||
|
||
## Installation | ||
|
||
With `npm`: | ||
|
||
``` | ||
npm install --save @coinbase/waas-sdk-react-native | ||
``` | ||
|
||
With `yarn`: | ||
|
||
``` | ||
yarn add @coinbase/waas-sdk-react-native | ||
``` | ||
|
||
## Usage | ||
|
||
See [index.tsx](./src/index.tsx) for the list of supported APIs. | ||
|
||
## Example App | ||
|
||
This repository provides an example app that demonstrates how the APIs should be used. | ||
|
||
> NOTE: An example Cloud API Key json file is at `example/src/.coinbase_cloud_api_key.json` | ||
> To run the example app, populate, or replace, this file with the Cloud API Key file provided to you | ||
> by Coinbase. | ||
### iOS | ||
Ensure you have XCode open and run the following from the root directory of the repository: | ||
|
||
```bash | ||
yarn bootstrap # Install packages for the root and /example directories | ||
yarn example start # Start the Metro server | ||
yarn example ios --simulator "iPhone 14" # Build and start the app on iOS simulator | ||
``` | ||
### Android | ||
Ensure you have the following [Android environment variables](https://developer.android.com/studio/command-line/variables) set correctly: | ||
|
||
- `ANDROID_HOME` | ||
- `ANDROID_SDK_ROOT="${ANDROID_HOME}"` | ||
- `ANDROID_NDK_HOME="${ANDROID_HOME}/ndk/<insert ndk version>"` | ||
- `ANDROID_NDK_ROOT="${ANDROID_NDK_HOME}"` | ||
|
||
And then export the following to your `PATH`: | ||
|
||
`export PATH="${ANDROID_HOME}/emulator:${ANDROID_HOME}/cmdline-tools/latest/bin:${ANDROID_HOME}/tools:${ANDROID_HOME}/tools/bin:${ANDROID_HOME}/platform-tools:${PATH}"` | ||
|
||
|
||
Run the following from the root directory of the repository: | ||
|
||
```bash | ||
yarn install # Install packages for the root directory | ||
emulator -avd Pixel_5_API_31 # Use any x86_64 emulator with min SDK version: 30. | ||
yarn example start # Start the Metro server | ||
yarn example android # Build and start the app on Android emulator | ||
``` | ||
|
||
## Recommended Architecture | ||
|
||
Broadly speaking, there are two possible approaches to using the WaaS SDK: | ||
|
||
1. Use the WaaS backends directly for all calls. | ||
2. Use the WaaS backends directly only for MPC operations; proxy all other calls through an intermediate server. | ||
|
||
Of these two approaches, we recommend approach #2, as outlined in the following diagram: | ||
|
||
![Recommended Set-up](./assets/diagram.png) | ||
|
||
The motivation for placing a proxy server in between your application and the WaaS backends are as | ||
follows: | ||
|
||
1. Your proxy server can log API calls and collect metrics. | ||
2. Your proxy server can filter results as it sees fit (e.g. policy enforcement). | ||
3. Your proxy server can perform end user authentication. | ||
4. Your proxy server can store the Coinbase API Key / Secret, rather than it being exposed to the client. | ||
5. Your proxy server can throttle traffic. | ||
|
||
In short, having a proxy server that you control in between your application and the WaaS backends will | ||
afford you significantly more control than using the WaaS backends directly in most cases. | ||
|
||
The methods from the WaaS SDK which are _required_ to be used for participation in MPC are: | ||
1. `initMPCSdk` | ||
2. `bootstrapDevice` | ||
3. `getRegistrationData` | ||
4. `computeMPCOperation` | ||
|
Oops, something went wrong.