Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ See [`user-controlled-wallets-social/README.md`](./user-controlled-wallets-socia

Run `npm run server` and `npm run dev` in separate terminals.

### [`modular-wallets-mobile-expo-starter`](./modular-wallets-mobile-expo-starter)

A single-screen Expo testnet wallet for iOS and Android: create or reconnect a native passkey, unlock with Face ID / Touch ID / Android biometrics, receive test USDC, and review and approve a transfer. Includes the official Circle native bridge, app identity setup, and runnable checks; signed physical-device acceptance remains pending.

## License

Apache 2.0 — see [LICENSE](./LICENSE).
Expand Down
2 changes: 2 additions & 0 deletions modular-wallets-mobile-expo-starter/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
EXPO_PUBLIC_CIRCLE_CLIENT_KEY=YOUR_RESTRICTED_TESTNET_CLIENT_KEY
EXPO_PUBLIC_WEBAUTHN_RP_ID=wallet.example.com
15 changes: 15 additions & 0 deletions modular-wallets-mobile-expo-starter/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
node_modules/
.env*
!.env.example
.expo/
build/
.gradle/
Pods/
*.keystore
*.mobileprovision
.DS_Store
dist/
ios/
android/
!modules/**/ios/
!modules/**/android/
247 changes: 247 additions & 0 deletions modular-wallets-mobile-expo-starter/App.tsx

Large diffs are not rendered by default.

26 changes: 26 additions & 0 deletions modular-wallets-mobile-expo-starter/CONTENTS.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.env.example
.gitignore
App.tsx
LICENSE
README.md
app.config.ts
check.py
domain/.well-known/apple-app-site-association
domain/.well-known/assetlinks.json
eas.json
index.ts
modules/circle-modular-wallets/android/build.gradle
modules/circle-modular-wallets/android/src/main/AndroidManifest.xml
modules/circle-modular-wallets/android/src/main/java/com/example/circlemodularwallets/CircleModularWalletsNativeModule.kt
modules/circle-modular-wallets/expo-module.config.json
modules/circle-modular-wallets/index.ts
modules/circle-modular-wallets/ios/CircleModularWalletsNative.podspec
modules/circle-modular-wallets/ios/CircleModularWalletsNativeModule.swift
modules/circle-modular-wallets/package.json
package-lock.json
package.json
src/native-passkey.ts
src/wallet-input.ts
src/wallet.ts
tests/wallet.test.ts
tsconfig.json
201 changes: 201 additions & 0 deletions modular-wallets-mobile-expo-starter/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

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.
69 changes: 69 additions & 0 deletions modular-wallets-mobile-expo-starter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Expo Passkey Wallet

A small, single-screen wallet for iOS and Android built from our native Expo implementation. Create or reconnect a passkey, unlock the app with Face ID / Touch ID / Android biometrics, receive test USDC, and review and approve a transfer.

**Avalanche Fuji only. Test funds only.** The first successful transfer deploys the smart account. This app uses public Circle SDK capabilities and contains no proprietary treasury, multisig, or agent-wallet integration.

## Run it

```sh
npm install
cp .env.example .env.local
# Fill in your own restricted Circle testnet client key and passkey domain.
npm run ios # a signed native iOS development build
npm run android # Android SDK package credentials required below
npm start
```

This requires a native development build; Expo Go does not include the Circle bridge and cannot test Face ID. Use Node 22.18+ for the test command. The Expo / React Native versions and package lock are included.

## Configure your app identity

1. In `app.config.ts`, replace the example iOS bundle ID and Android package with your own. The domain comes from `EXPO_PUBLIC_WEBAUTHN_RP_ID`.
2. Create a **testnet Client Key** in Circle Console, restricted to your passkey domain and native app identities. Configure the iOS bundle ID, Android package, and Android signing certificate fingerprint there. Use the public client key, never a server API key.
3. Serve the supplied `domain/.well-known` templates on your HTTPS passkey domain at the exact `.well-known` paths, without authentication. Replace the Apple Team ID, bundle ID, Android package, and signing fingerprints. Register your release certificate as well as your development certificate when shipping.
4. Android's SDK download requires your own GitHub Packages read credential in the build environment:
```sh
export MWSDK_MAVEN_USERNAME=your_github_username
export MWSDK_MAVEN_PASSWORD=your_package_read_token
```
Alternatively, put `mwsdk.maven.username` and `mwsdk.maven.password` in private `~/.gradle/gradle.properties`. Keep these out of `EXPO_PUBLIC_*`, app config, and Git. For EAS, store them as build secrets and use the included development profile.
5. Enable Circle Gas Station sponsorship for Fuji test transfers and obtain test USDC from [Circle's faucet](https://faucet.circle.com/). Fund the address shown in the app before sending.

Circle native SDK versions: iOS **1.5.0**, Android **1.5.3**. Native changes require a rebuild. Passkeys need normal iOS signing/entitlements; do not disable code signing or manually re-sign the built app.

## How security works

- **App unlock:** Expo Local Authentication uses the device's biometric prompt, with OS passcode fallback. The app covers its content on app switching and locks on backgrounding; native approval dialogs are exempt from relocking themselves.
- **Transfer approval:** the official Circle native SDK asks the passkey provider to sign the operation. A Face ID success from app unlock is never treated as a wallet signature. The OS chooses the passkey prompt and any permitted verification fallback.
- **Storage:** SecureStore holds only credential ID, public key, domain, wallet address, and any pending operation hash. The private passkey stays with the device's passkey provider. Device-only metadata is not a wallet recovery mechanism; keep access to your passkey provider.
- **Reconnect:** cold starts require the saved wallet's passkey. A mismatched domain or credential is rejected. “I already have a passkey” also reconnects after installing the app on a new device with access to that passkey.
- **Submission:** recipient and exact six-decimal USDC amounts are validated. Each send has an explicit review. The exact signed operation's hash is saved **before broadcast**; a storage failure prevents submission. A definite validation rejection clears the pending hash. A network timeout or ambiguous response retains it and blocks another send. Confirmed onchain failure clears it; confirmed success checks deployed bytecode.

An ambiguous submission can remain pending even if it never reached the bundler. The screen shows the saved hash for investigation; this minimal demo deliberately has no force-reset or automatic resend that could duplicate a transfer.

## Small source map

- `App.tsx`: one wallet screen, biometric unlock, local persistence, review and pending state.
- `src/wallet.ts`: native-aware HTTP transport, Fuji smart account, balance and transfers.
- `src/native-passkey.ts`: official native owner adapter; no browser passkey API.
- `src/wallet-input.ts`: exact amounts, raw/SPKI/iOS COSE P-256 public keys, and native DER/compact signatures. No browser SubtleCrypto shim.
- `modules/circle-modular-wallets`: local Expo module wrapping Circle's public Swift/Kotlin APIs. `rpcHeaders()` supplies actual native app identifiers and Android signing fingerprint; no fake browser identity.

## Checks

```sh
npm run check # TypeScript, input/crypto regression checks, source boundary scan
npm run export:verify # iOS and Android Metro/Hermes bundles
```

Before using real funds, complete signed **physical-device** checks on both platforms: create, cancel, cold-restart reconnect, wrong-passkey refusal, biometric failure, background lock, receipt timeout/retry, sponsorship denial, and a successful funded transfer. Bundle/type checks do not prove the native device flow. This starter stays testnet-only.

## Public references

- [Circle public smart-account example](https://github.com/circlefin/modularwallets-web-sdk/tree/master/examples/circle-smart-account)
- [Circle iOS SDK](https://github.com/circlefin/modularwallets-ios-sdk) · [Circle Android SDK](https://github.com/circlefin/modularwallets-android-sdk)
- [Expo Local Authentication](https://docs.expo.dev/versions/latest/sdk/local-authentication/) · [SecureStore](https://docs.expo.dev/versions/latest/sdk/securestore/)
- [Expo local native modules](https://docs.expo.dev/modules/get-started/)

Apache 2.0; see [LICENSE](./LICENSE). Third-party SDKs retain their licenses.
15 changes: 15 additions & 0 deletions modular-wallets-mobile-expo-starter/app.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import type { ExpoConfig } from 'expo/config';

const rpId = process.env.EXPO_PUBLIC_WEBAUTHN_RP_ID || 'wallet.example.com';
const config: ExpoConfig = {
name: 'Passkey Wallet', slug: 'modular-wallets-mobile-expo-starter', version: '0.2.0',
orientation: 'portrait', userInterfaceStyle: 'light',
ios: { bundleIdentifier: 'com.example.walletdemo', associatedDomains: [`webcredentials:${rpId}`] },
android: { package: 'com.example.walletdemo' },
plugins: [
['expo-local-authentication', { faceIDPermission: 'Unlock your wallet with Face ID.' }],
'expo-secure-store',
['expo-build-properties', { ios: { deploymentTarget: '16.4' }, android: { minSdkVersion: 26 } }],
],
};
export default config;
Loading