@novastera-oss/nitro-metamask 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/NitroMetamask.podspec +32 -0
- package/README.md +262 -0
- package/android/CMakeLists.txt +29 -0
- package/android/build.gradle +144 -0
- package/android/fix-prefab.gradle +51 -0
- package/android/gradle.properties +5 -0
- package/android/src/main/AndroidManifest.xml +2 -0
- package/android/src/main/cpp/cpp-adapter.cpp +6 -0
- package/android/src/main/java/com/margelo/nitro/nitrometamask/HybridMetamaskConnector.kt +48 -0
- package/android/src/main/java/com/margelo/nitro/nitrometamask/NitroMetamaskPackage.kt +18 -0
- package/ios/Bridge.h +8 -0
- package/ios/HybridMetamaskConnector.swift +58 -0
- package/lib/MetamaskConnector.nitro.d.ts +12 -0
- package/lib/MetamaskConnector.nitro.js +1 -0
- package/lib/index.d.ts +3 -0
- package/lib/index.js +2 -0
- package/lib/specs/Example.nitro.d.ts +0 -0
- package/lib/specs/Example.nitro.js +2 -0
- package/nitro.json +24 -0
- package/nitrogen/generated/android/NitroMetamask+autolinking.cmake +81 -0
- package/nitrogen/generated/android/NitroMetamask+autolinking.gradle +27 -0
- package/nitrogen/generated/android/NitroMetamaskOnLoad.cpp +44 -0
- package/nitrogen/generated/android/NitroMetamaskOnLoad.hpp +25 -0
- package/nitrogen/generated/android/c++/JConnectResult.hpp +61 -0
- package/nitrogen/generated/android/c++/JHybridMetamaskConnectorSpec.cpp +84 -0
- package/nitrogen/generated/android/c++/JHybridMetamaskConnectorSpec.hpp +66 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/nitrometamask/ConnectResult.kt +41 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/nitrometamask/HybridMetamaskConnectorSpec.kt +62 -0
- package/nitrogen/generated/android/kotlin/com/margelo/nitro/nitrometamask/NitroMetamaskOnLoad.kt +35 -0
- package/nitrogen/generated/ios/NitroMetamask+autolinking.rb +60 -0
- package/nitrogen/generated/ios/NitroMetamask-Swift-Cxx-Bridge.cpp +57 -0
- package/nitrogen/generated/ios/NitroMetamask-Swift-Cxx-Bridge.hpp +157 -0
- package/nitrogen/generated/ios/NitroMetamask-Swift-Cxx-Umbrella.hpp +48 -0
- package/nitrogen/generated/ios/NitroMetamaskAutolinking.mm +33 -0
- package/nitrogen/generated/ios/NitroMetamaskAutolinking.swift +25 -0
- package/nitrogen/generated/ios/c++/HybridMetamaskConnectorSpecSwift.cpp +11 -0
- package/nitrogen/generated/ios/c++/HybridMetamaskConnectorSpecSwift.hpp +87 -0
- package/nitrogen/generated/ios/swift/ConnectResult.swift +35 -0
- package/nitrogen/generated/ios/swift/Func_void_ConnectResult.swift +47 -0
- package/nitrogen/generated/ios/swift/Func_void_std__exception_ptr.swift +47 -0
- package/nitrogen/generated/ios/swift/Func_void_std__string.swift +47 -0
- package/nitrogen/generated/ios/swift/HybridMetamaskConnectorSpec.swift +57 -0
- package/nitrogen/generated/ios/swift/HybridMetamaskConnectorSpec_cxx.swift +157 -0
- package/nitrogen/generated/shared/c++/ConnectResult.hpp +87 -0
- package/nitrogen/generated/shared/c++/HybridMetamaskConnectorSpec.cpp +22 -0
- package/nitrogen/generated/shared/c++/HybridMetamaskConnectorSpec.hpp +66 -0
- package/package.json +108 -0
- package/react-native.config.js +16 -0
- package/src/MetamaskConnector.nitro.ts +13 -0
- package/src/index.ts +8 -0
- package/src/specs/Example.nitro.ts +1 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
require "json"
|
|
2
|
+
|
|
3
|
+
package = JSON.parse(File.read(File.join(__dir__, "package.json")))
|
|
4
|
+
|
|
5
|
+
Pod::Spec.new do |s|
|
|
6
|
+
s.name = "NitroMetamask"
|
|
7
|
+
s.version = package["version"]
|
|
8
|
+
s.summary = package["description"]
|
|
9
|
+
s.homepage = package["homepage"]
|
|
10
|
+
s.license = package["license"]
|
|
11
|
+
s.authors = package["author"]
|
|
12
|
+
|
|
13
|
+
s.platforms = { :ios => min_ios_version_supported, :visionos => 1.0 }
|
|
14
|
+
s.source = { :git => "https://github.com/DarkSorrow/nitro-metamask.git", :tag => "#{s.version}" }
|
|
15
|
+
|
|
16
|
+
s.source_files = [
|
|
17
|
+
# Implementation (Swift)
|
|
18
|
+
"ios/**/*.{swift}",
|
|
19
|
+
# Autolinking/Registration (Objective-C++)
|
|
20
|
+
"ios/**/*.{m,mm}",
|
|
21
|
+
# Implementation (C++ objects)
|
|
22
|
+
"cpp/**/*.{hpp,cpp}",
|
|
23
|
+
]
|
|
24
|
+
|
|
25
|
+
load 'nitrogen/generated/ios/NitroMetamask+autolinking.rb'
|
|
26
|
+
add_nitrogen_files(s)
|
|
27
|
+
|
|
28
|
+
s.dependency 'React-jsi'
|
|
29
|
+
s.dependency 'React-callinvoker'
|
|
30
|
+
s.dependency 'MetaMaskIOSSDK'
|
|
31
|
+
install_modules_dependencies(s)
|
|
32
|
+
end
|
package/README.md
ADDED
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
# Nitro MetaMask Connector
|
|
2
|
+
|
|
3
|
+
`react-native-metamask-nitro` is a Nitro Module that enables **MetaMask wallet authentication** as an OpenID Connect third-party provider for social login in React Native applications. This module allows users to authenticate with their MetaMask wallet on iOS and Android, similar to how they would authenticate with Facebook, Apple, or Google.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
This module is designed for **secure wallet-based authentication** in mobile applications. It provides:
|
|
8
|
+
|
|
9
|
+
- Native MetaMask SDK integration (iOS + Android) through a single, type-safe HybridObject
|
|
10
|
+
- Wallet connection and message signing capabilities for authentication flows
|
|
11
|
+
- Secure signature generation for OpenID Connect-style authentication
|
|
12
|
+
|
|
13
|
+
**⚠️ Security Note:** This module handles authentication credentials and signatures. All cryptographic operations are performed natively through the official MetaMask SDKs to ensure maximum security.
|
|
14
|
+
|
|
15
|
+
## Features
|
|
16
|
+
|
|
17
|
+
- `MetamaskConnector.nitro.ts`, defining a future-proof Nitro spec
|
|
18
|
+
- Native wrappers around `MetaMaskIOSSDK` and `io.metamask.android:sdk`
|
|
19
|
+
- `connect()` method that resolves with `{ address, chainId }` once the wallet session is established
|
|
20
|
+
- `signMessage()` method for signing authentication messages (required for login flows)
|
|
21
|
+
|
|
22
|
+
## Getting Started
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# install deps
|
|
26
|
+
yarn install
|
|
27
|
+
|
|
28
|
+
# regenerate Nitro bindings after editing *.nitro.ts files
|
|
29
|
+
npx nitrogen
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Native Dependencies
|
|
33
|
+
|
|
34
|
+
### iOS
|
|
35
|
+
|
|
36
|
+
- `NitroMetamask.podspec` declares `s.dependency 'MetaMaskIOSSDK'`
|
|
37
|
+
- Run `pod install` inside your consuming app after installing this module
|
|
38
|
+
|
|
39
|
+
### Android
|
|
40
|
+
|
|
41
|
+
- `android/build.gradle` depends on `io.metamask.android:sdk:1.0.0`
|
|
42
|
+
- No manual manifest changes are required—Nitro handles registration
|
|
43
|
+
|
|
44
|
+
## Nitro Autolinking
|
|
45
|
+
|
|
46
|
+
`nitro.json` contains:
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
"autolinking": {
|
|
50
|
+
"MetamaskConnector": {
|
|
51
|
+
"swift": "HybridMetamaskConnector",
|
|
52
|
+
"kotlin": "HybridMetamaskConnector"
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Run `npx nitrogen` whenever the spec or native implementations change so the generated bindings stay in sync.
|
|
58
|
+
|
|
59
|
+
## TypeScript API
|
|
60
|
+
|
|
61
|
+
### Basic Connection
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
import { metamaskConnector } from 'react-native-metamask-nitro'
|
|
65
|
+
|
|
66
|
+
export async function connectWallet() {
|
|
67
|
+
const { address, chainId } = await metamaskConnector.connect()
|
|
68
|
+
console.log('Connected to MetaMask', address, chainId)
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Authentication Flow (OpenID Connect)
|
|
73
|
+
|
|
74
|
+
For social login authentication, follow this pattern:
|
|
75
|
+
|
|
76
|
+
**⚠️ Note**: The endpoints shown below (`/social/.well-generated` and `/social/authenticate`) are **example endpoints that you must implement on your backend**. See the [Required Backend Implementation](#required-backend-implementation) section below for details.
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
import { metamaskConnector } from 'react-native-metamask-nitro'
|
|
80
|
+
|
|
81
|
+
export async function authenticateWithMetaMask() {
|
|
82
|
+
try {
|
|
83
|
+
// Step 1: Connect to MetaMask wallet
|
|
84
|
+
const { address, chainId } = await metamaskConnector.connect()
|
|
85
|
+
|
|
86
|
+
// Step 2: Fetch nonce from your backend (YOU MUST IMPLEMENT THIS ENDPOINT)
|
|
87
|
+
const nonceResponse = await fetch('/social/.well-generated', {
|
|
88
|
+
method: 'PATCH',
|
|
89
|
+
credentials: 'include',
|
|
90
|
+
})
|
|
91
|
+
const nonce = await nonceResponse.text()
|
|
92
|
+
|
|
93
|
+
// Step 3: Create authentication message
|
|
94
|
+
const message = JSON.stringify({
|
|
95
|
+
address: address,
|
|
96
|
+
chainID: chainId,
|
|
97
|
+
nonce: nonce,
|
|
98
|
+
exp: Date.now() + 42000, // expiration timestamp
|
|
99
|
+
})
|
|
100
|
+
|
|
101
|
+
// Step 4: Sign the message with MetaMask
|
|
102
|
+
const signature = await metamaskConnector.signMessage(message)
|
|
103
|
+
|
|
104
|
+
// Step 5: Submit signature to your backend for authentication (YOU MUST IMPLEMENT THIS ENDPOINT)
|
|
105
|
+
await fetch('/social/authenticate', {
|
|
106
|
+
method: 'POST',
|
|
107
|
+
headers: { 'Content-Type': 'application/json' },
|
|
108
|
+
credentials: 'include',
|
|
109
|
+
body: JSON.stringify({
|
|
110
|
+
message,
|
|
111
|
+
signature,
|
|
112
|
+
address,
|
|
113
|
+
chainId,
|
|
114
|
+
}),
|
|
115
|
+
})
|
|
116
|
+
|
|
117
|
+
return { address, chainId, signature }
|
|
118
|
+
} catch (error) {
|
|
119
|
+
console.error('MetaMask authentication failed:', error)
|
|
120
|
+
throw error
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
`metamaskConnector` is created via `NitroModules.createHybridObject` and implements the `MetamaskConnector` interface defined in `src/MetamaskConnector.nitro.ts`.
|
|
126
|
+
|
|
127
|
+
## Native Implementations
|
|
128
|
+
|
|
129
|
+
- `ios/HybridMetamaskConnector.swift`: wraps `MetaMaskSDK.shared.connect` and message signing using Swift concurrency
|
|
130
|
+
- `android/src/main/java/com/margelo/nitro/nitrometamask/HybridMetamaskConnector.kt`: uses `EthereumClient.connect` and `personal_sign` with coroutines
|
|
131
|
+
|
|
132
|
+
Both platforms normalize responses to shared TypeScript interfaces, ensuring identical behavior across iOS and Android.
|
|
133
|
+
|
|
134
|
+
## Authentication Flow
|
|
135
|
+
|
|
136
|
+
The authentication process follows this secure pattern:
|
|
137
|
+
|
|
138
|
+
1. **Connect**: Establish a connection to the user's MetaMask wallet
|
|
139
|
+
2. **Nonce Request**: Fetch a unique nonce from your authentication backend
|
|
140
|
+
3. **Message Construction**: Create a JSON message containing address, chainId, nonce, and expiration
|
|
141
|
+
4. **Signature**: Request the user to sign the message via MetaMask (native UI)
|
|
142
|
+
5. **Verification**: Submit the signature to your backend for verification and session creation
|
|
143
|
+
|
|
144
|
+
This flow ensures that:
|
|
145
|
+
- The user explicitly approves each authentication attempt
|
|
146
|
+
- Signatures are cryptographically verifiable
|
|
147
|
+
- Nonces prevent replay attacks
|
|
148
|
+
- Expiration timestamps limit signature validity
|
|
149
|
+
|
|
150
|
+
## Required Backend Implementation
|
|
151
|
+
|
|
152
|
+
**⚠️ Important**: The authentication flow shown above requires you to implement two backend endpoints. This module only handles the client-side MetaMask connection and message signing—you must build the server-side verification and session management.
|
|
153
|
+
|
|
154
|
+
### Endpoint 1: Nonce Generation (`POST /social/nonce-generated`)
|
|
155
|
+
|
|
156
|
+
This endpoint should:
|
|
157
|
+
- Generate a unique, cryptographically secure nonce for each authentication attempt
|
|
158
|
+
- Return the nonce as plain text
|
|
159
|
+
- Optionally associate the nonce with a session or temporary storage
|
|
160
|
+
- Set an expiration time for the nonce (recommended: 5-10 minutes)
|
|
161
|
+
|
|
162
|
+
**Example Implementation:**
|
|
163
|
+
```typescript
|
|
164
|
+
// Backend endpoint example
|
|
165
|
+
app.post('/social/nonce-generated', (req, res) => {
|
|
166
|
+
const nonce = generateSecureNonce() // e.g., crypto.randomBytes(32).toString('hex')
|
|
167
|
+
// Store nonce with expiration (e.g., in Redis or database)
|
|
168
|
+
storeNonce(nonce, { expiresIn: '5m' })
|
|
169
|
+
res.send(nonce)
|
|
170
|
+
})
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### Endpoint 2: Signature Verification (`POST /social/authenticate`)
|
|
174
|
+
|
|
175
|
+
This endpoint should:
|
|
176
|
+
- Receive the message, signature, address, and chainId from the client
|
|
177
|
+
- **Verify the signature** cryptographically using the wallet address and message
|
|
178
|
+
- Validate the nonce (check it exists, hasn't been used, and hasn't expired)
|
|
179
|
+
- Validate the expiration timestamp in the message
|
|
180
|
+
- Create a user session or authentication token upon successful verification
|
|
181
|
+
- Mark the nonce as used to prevent replay attacks
|
|
182
|
+
|
|
183
|
+
**Example Implementation:**
|
|
184
|
+
```typescript
|
|
185
|
+
// Backend endpoint example
|
|
186
|
+
app.post('/social/authenticate', async (req, res) => {
|
|
187
|
+
const { message, signature, address, chainId } = req.body
|
|
188
|
+
|
|
189
|
+
// 1. Parse and validate message
|
|
190
|
+
const messageData = JSON.parse(message)
|
|
191
|
+
if (Date.now() > messageData.exp) {
|
|
192
|
+
return res.status(401).json({ error: 'Message expired' })
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
// 2. Verify nonce
|
|
196
|
+
if (!await isValidNonce(messageData.nonce)) {
|
|
197
|
+
return res.status(401).json({ error: 'Invalid or expired nonce' })
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
// 3. Verify signature cryptographically
|
|
201
|
+
const isValid = await verifySignature(message, signature, address)
|
|
202
|
+
if (!isValid) {
|
|
203
|
+
return res.status(401).json({ error: 'Invalid signature' })
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
// 4. Mark nonce as used
|
|
207
|
+
await markNonceAsUsed(messageData.nonce)
|
|
208
|
+
|
|
209
|
+
// 5. Create session/token
|
|
210
|
+
const sessionToken = createSession({ address, chainId })
|
|
211
|
+
|
|
212
|
+
res.json({ token: sessionToken, address, chainId })
|
|
213
|
+
})
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### Signature Verification
|
|
217
|
+
|
|
218
|
+
You'll need to implement cryptographic signature verification. The signature is created using Ethereum's `personal_sign` standard. Use a library like:
|
|
219
|
+
- **Node.js**: `ethers.js` or `web3.js`
|
|
220
|
+
- **Python**: `eth-account` or `web3.py`
|
|
221
|
+
- **Other languages**: Use appropriate Ethereum signature verification libraries
|
|
222
|
+
|
|
223
|
+
**Example with ethers.js:**
|
|
224
|
+
```typescript
|
|
225
|
+
import { ethers } from 'ethers'
|
|
226
|
+
|
|
227
|
+
async function verifySignature(message: string, signature: string, address: string): Promise<boolean> {
|
|
228
|
+
try {
|
|
229
|
+
const recoveredAddress = ethers.utils.verifyMessage(message, signature)
|
|
230
|
+
return recoveredAddress.toLowerCase() === address.toLowerCase()
|
|
231
|
+
} catch {
|
|
232
|
+
return false
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Security Requirements
|
|
238
|
+
|
|
239
|
+
Your backend implementation must:
|
|
240
|
+
- ✅ **Always verify signatures server-side** - Never trust client-provided authentication without cryptographic verification
|
|
241
|
+
- ✅ **Validate nonces** - Ensure each nonce is used only once and within its expiration window
|
|
242
|
+
- ✅ **Check message expiration** - Reject expired authentication messages
|
|
243
|
+
- ✅ **Use HTTPS** - All endpoints must use TLS/SSL
|
|
244
|
+
- ✅ **Rate limiting** - Implement rate limiting to prevent abuse
|
|
245
|
+
- ✅ **Secure session management** - Use secure, httpOnly cookies or signed tokens for sessions
|
|
246
|
+
|
|
247
|
+
## Security Considerations
|
|
248
|
+
|
|
249
|
+
- All cryptographic operations are performed natively through official MetaMask SDKs
|
|
250
|
+
- Private keys never leave the MetaMask wallet
|
|
251
|
+
- Message signing requires explicit user approval via MetaMask's native UI
|
|
252
|
+
- Always validate signatures server-side before creating sessions
|
|
253
|
+
- Use HTTPS for all network requests
|
|
254
|
+
- Implement proper nonce management and expiration handling
|
|
255
|
+
|
|
256
|
+
## About
|
|
257
|
+
|
|
258
|
+
This module is actively used in the mobile app of [Novastera.com](https://novastera.com), ensuring reliability and real-world production environments. Novastera is a CRM/ERP system that supports cryptocurrency transactions and Web3 authentication.
|
|
259
|
+
|
|
260
|
+
## License
|
|
261
|
+
|
|
262
|
+
Apache License - see [LICENSE](LICENSE) file for details.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
project(NitroMetamask)
|
|
2
|
+
cmake_minimum_required(VERSION 3.9.0)
|
|
3
|
+
|
|
4
|
+
set (PACKAGE_NAME NitroMetamask)
|
|
5
|
+
set (CMAKE_VERBOSE_MAKEFILE ON)
|
|
6
|
+
set (CMAKE_CXX_STANDARD 20)
|
|
7
|
+
|
|
8
|
+
# Define C++ library and add all sources
|
|
9
|
+
add_library(${PACKAGE_NAME} SHARED
|
|
10
|
+
src/main/cpp/cpp-adapter.cpp
|
|
11
|
+
)
|
|
12
|
+
|
|
13
|
+
# Add Nitrogen specs :)
|
|
14
|
+
include(${CMAKE_SOURCE_DIR}/../nitrogen/generated/android/NitroMetamask+autolinking.cmake)
|
|
15
|
+
|
|
16
|
+
# Set up local includes
|
|
17
|
+
include_directories(
|
|
18
|
+
"src/main/cpp"
|
|
19
|
+
"../cpp"
|
|
20
|
+
)
|
|
21
|
+
|
|
22
|
+
find_library(LOG_LIB log)
|
|
23
|
+
|
|
24
|
+
# Link all libraries together
|
|
25
|
+
target_link_libraries(
|
|
26
|
+
${PACKAGE_NAME}
|
|
27
|
+
${LOG_LIB}
|
|
28
|
+
android # <-- Android core
|
|
29
|
+
)
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
buildscript {
|
|
2
|
+
repositories {
|
|
3
|
+
google()
|
|
4
|
+
mavenCentral()
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
dependencies {
|
|
8
|
+
classpath "com.android.tools.build:gradle:8.13.0"
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
def reactNativeArchitectures() {
|
|
13
|
+
def value = rootProject.getProperties().get("reactNativeArchitectures")
|
|
14
|
+
return value ? value.split(",") : ["armeabi-v7a", "x86", "x86_64", "arm64-v8a"]
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
def isNewArchitectureEnabled() {
|
|
18
|
+
return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
apply plugin: "com.android.library"
|
|
22
|
+
apply plugin: 'org.jetbrains.kotlin.android'
|
|
23
|
+
apply from: '../nitrogen/generated/android/NitroMetamask+autolinking.gradle'
|
|
24
|
+
apply from: "./fix-prefab.gradle"
|
|
25
|
+
|
|
26
|
+
if (isNewArchitectureEnabled()) {
|
|
27
|
+
apply plugin: "com.facebook.react"
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
def getExtOrDefault(name) {
|
|
31
|
+
return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["NitroMetamask_" + name]
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
def getExtOrIntegerDefault(name) {
|
|
35
|
+
return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["NitroMetamask_" + name]).toInteger()
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
android {
|
|
39
|
+
namespace "com.margelo.nitro.nitrometamask"
|
|
40
|
+
|
|
41
|
+
ndkVersion getExtOrDefault("ndkVersion")
|
|
42
|
+
compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
|
|
43
|
+
|
|
44
|
+
defaultConfig {
|
|
45
|
+
minSdkVersion getExtOrIntegerDefault("minSdkVersion")
|
|
46
|
+
targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
|
|
47
|
+
buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
|
|
48
|
+
|
|
49
|
+
externalNativeBuild {
|
|
50
|
+
cmake {
|
|
51
|
+
cppFlags "-frtti -fexceptions -Wall -Wextra -fstack-protector-all"
|
|
52
|
+
arguments "-DANDROID_STL=c++_shared", "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON"
|
|
53
|
+
abiFilters (*reactNativeArchitectures())
|
|
54
|
+
|
|
55
|
+
buildTypes {
|
|
56
|
+
debug {
|
|
57
|
+
cppFlags "-O1 -g"
|
|
58
|
+
}
|
|
59
|
+
release {
|
|
60
|
+
cppFlags "-O2"
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
externalNativeBuild {
|
|
68
|
+
cmake {
|
|
69
|
+
path "CMakeLists.txt"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
packagingOptions {
|
|
74
|
+
excludes = [
|
|
75
|
+
"META-INF",
|
|
76
|
+
"META-INF/**",
|
|
77
|
+
"**/libc++_shared.so",
|
|
78
|
+
"**/libfbjni.so",
|
|
79
|
+
"**/libjsi.so",
|
|
80
|
+
"**/libfolly_json.so",
|
|
81
|
+
"**/libfolly_runtime.so",
|
|
82
|
+
"**/libglog.so",
|
|
83
|
+
"**/libhermes.so",
|
|
84
|
+
"**/libhermes-executor-debug.so",
|
|
85
|
+
"**/libhermes_executor.so",
|
|
86
|
+
"**/libreactnative.so",
|
|
87
|
+
"**/libreactnativejni.so",
|
|
88
|
+
"**/libturbomodulejsijni.so",
|
|
89
|
+
"**/libreact_nativemodule_core.so",
|
|
90
|
+
"**/libjscexecutor.so"
|
|
91
|
+
]
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
buildFeatures {
|
|
95
|
+
buildConfig true
|
|
96
|
+
prefab true
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
buildTypes {
|
|
100
|
+
release {
|
|
101
|
+
minifyEnabled false
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
lintOptions {
|
|
106
|
+
disable "GradleCompatible"
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
compileOptions {
|
|
110
|
+
sourceCompatibility JavaVersion.VERSION_1_8
|
|
111
|
+
targetCompatibility JavaVersion.VERSION_1_8
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
sourceSets {
|
|
115
|
+
main {
|
|
116
|
+
if (isNewArchitectureEnabled()) {
|
|
117
|
+
java.srcDirs += [
|
|
118
|
+
// React Codegen files
|
|
119
|
+
"${project.buildDir}/generated/source/codegen/java"
|
|
120
|
+
]
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
repositories {
|
|
127
|
+
mavenCentral()
|
|
128
|
+
google()
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
dependencies {
|
|
133
|
+
// For < 0.71, this will be from the local maven repo
|
|
134
|
+
// For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
|
|
135
|
+
//noinspection GradleDynamicVersion
|
|
136
|
+
implementation "com.facebook.react:react-native:+"
|
|
137
|
+
|
|
138
|
+
// Add a dependency on NitroModules
|
|
139
|
+
implementation project(":react-native-nitro-modules")
|
|
140
|
+
|
|
141
|
+
// MetaMask Android SDK
|
|
142
|
+
implementation "io.metamask.android:sdk:1.0.0"
|
|
143
|
+
}
|
|
144
|
+
|