Skip to content

Commit 24db2ac

Browse files
AlonzoRicardoAlonzoRicardo
authored
Merge pull request #65 from tetherto/develop
Release: v1.0.0-beta.5
2 parents d39f669 + b234c90 commit 24db2ac

14 files changed

Lines changed: 728 additions & 224 deletions

‎.github/workflows/build.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ jobs:
2121

2222
- name: Install dependencies
2323
run: npm clean-install
24-
env:
25-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
2624

2725
- name: Lint code with standard
2826
run: npm run lint

‎.github/workflows/publish.yml‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ jobs:
1919

2020
- name: Install dependencies
2121
run: npm clean-install
22-
env:
23-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
2422

2523
- name: Lint code with standard
2624
run: npm run lint
@@ -42,8 +40,6 @@ jobs:
4240

4341
- name: Install dependencies
4442
run: npm clean-install
45-
env:
46-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
4743

4844
- name: Publish to npm
4945
run: npm publish

‎LICENSE‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
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

‎README.md‎

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,9 @@ new WalletAccountEvmErc4337(seed, path, config)
404404
|--------|-------------|---------|
405405
| `getAddress()` | Returns the smart contract wallet address | `Promise<string>` |
406406
| `sign(message)` | Signs a message using the account's private key | `Promise<string>` |
407+
| `signTypedData(typedData)` | Signs typed data according to EIP-712 | `Promise<string>` |
407408
| `verify(message, signature)` | Verifies a message signature | `Promise<boolean>` |
409+
| `verifyTypedData(typedData, signature)` | Verifies a typed data signature | `Promise<boolean>` |
408410
| `sendTransaction(tx, config)` | Sends a transaction via UserOperation | `Promise<{hash: string, fee: bigint}>` |
409411
| `quoteSendTransaction(tx, config)` | Estimates the fee for a UserOperation | `Promise<{fee: bigint}>` |
410412
| `transfer(options, config)` | Transfers ERC20 tokens via UserOperation | `Promise<{hash: string, fee: bigint}>` |
@@ -438,6 +440,40 @@ const signature = await account.sign('Hello ERC-4337!')
438440
console.log('Signature:', signature)
439441
```
440442

443+
##### `signTypedData(typedData)`
444+
Signs typed data according to EIP-712.
445+
446+
**Parameters:**
447+
- `typedData` (object):
448+
- `domain` (object): The EIP-712 domain separator
449+
- `types` (object): The type definitions
450+
- `message` (object): The structured message to sign
451+
452+
**Returns:** `Promise<string>` - The typed data signature
453+
454+
**Example:**
455+
```javascript
456+
const signature = await account.signTypedData({
457+
domain: {
458+
name: 'MyDApp',
459+
version: '1',
460+
chainId: 1,
461+
verifyingContract: '0x...'
462+
},
463+
types: {
464+
Transfer: [
465+
{ name: 'to', type: 'address' },
466+
{ name: 'amount', type: 'uint256' }
467+
]
468+
},
469+
message: {
470+
to: '0x1234567890abcdef1234567890abcdef12345678',
471+
amount: '1000000'
472+
}
473+
})
474+
console.log('Typed data signature:', signature)
475+
```
476+
441477
##### `verify(message, signature)`
442478
Verifies a message signature using the account's public key.
443479

@@ -453,7 +489,45 @@ const isValid = await account.verify('Hello ERC-4337!', signature)
453489
console.log('Signature valid:', isValid)
454490
```
455491

456-
##### `sendTransaction(tx, config)`
492+
##### `verifyTypedData(typedData, signature)`
493+
Verifies a typed data signature against the account's address.
494+
495+
**Parameters:**
496+
- `typedData` (object):
497+
- `domain` (object): The EIP-712 domain separator
498+
- `types` (object): The type definitions
499+
- `message` (object): The structured message that was signed
500+
- `signature` (string): The signature to verify
501+
502+
**Returns:** `Promise<boolean>` - True if the signature is valid
503+
504+
**Example:**
505+
```javascript
506+
const isValid = await account.verifyTypedData(
507+
{
508+
domain: {
509+
name: 'MyDApp',
510+
version: '1',
511+
chainId: 1,
512+
verifyingContract: '0x...'
513+
},
514+
types: {
515+
Transfer: [
516+
{ name: 'to', type: 'address' },
517+
{ name: 'amount', type: 'uint256' }
518+
]
519+
},
520+
message: {
521+
to: '0x1234567890abcdef1234567890abcdef12345678',
522+
amount: '1000000'
523+
}
524+
},
525+
signature
526+
)
527+
console.log('Typed data signature valid:', isValid)
528+
```
529+
530+
##### `sendTransaction(tx)`
457531
Sends a transaction via UserOperation through the ERC-4337 bundler.
458532

459533
**Parameters:**
@@ -667,6 +741,7 @@ new WalletAccountReadOnlyEvmErc4337(address, config)
667741
| `quoteSendTransaction(tx, config)` | Estimates the fee for a UserOperation | `Promise<{fee: bigint}>` |
668742
| `quoteTransfer(options, config)` | Estimates the fee for an ERC20 transfer | `Promise<{fee: bigint}>` |
669743
| `verify(message, signature)` | Verifies a message signature | `Promise<boolean>` |
744+
| `verifyTypedData(typedData, signature)` | Verifies a typed data signature | `Promise<boolean>` |
670745

671746
##### `predictSafeAddress(owner, config)` (static)
672747
Predicts the Safe smart contract address for a given EOA owner without requiring network calls.
@@ -775,6 +850,44 @@ const isValid = await readOnlyAccount.verify('Hello ERC-4337!', signature)
775850
console.log('Signature valid:', isValid)
776851
```
777852

853+
##### `verifyTypedData(typedData, signature)`
854+
Verifies a typed data signature against the account's address.
855+
856+
**Parameters:**
857+
- `typedData` (object):
858+
- `domain` (object): The EIP-712 domain separator
859+
- `types` (object): The type definitions
860+
- `message` (object): The structured message that was signed
861+
- `signature` (string): The signature to verify
862+
863+
**Returns:** `Promise<boolean>` - True if the signature is valid
864+
865+
**Example:**
866+
```javascript
867+
const isValid = await account.verifyTypedData(
868+
{
869+
domain: {
870+
name: 'MyDApp',
871+
version: '1',
872+
chainId: 1,
873+
verifyingContract: '0x...'
874+
},
875+
types: {
876+
Transfer: [
877+
{ name: 'to', type: 'address' },
878+
{ name: 'amount', type: 'uint256' }
879+
]
880+
},
881+
message: {
882+
to: '0x1234567890abcdef1234567890abcdef12345678',
883+
amount: '1000000'
884+
}
885+
},
886+
signature
887+
)
888+
console.log('Typed data signature valid:', isValid)
889+
```
890+
778891
## 🌐 Supported Networks
779892

780893
This package works with any EVM-compatible blockchain that supports ERC-4337, including:

‎index.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,17 @@
2626
/** @typedef {import('@tetherto/wdk-wallet-evm').EvmTransactionReceipt} EvmTransactionReceipt */
2727
/** @typedef {import('@tetherto/wdk-wallet-evm').ApproveOptions} ApproveOptions */
2828

29+
/** @typedef {import('@tetherto/wdk-wallet-evm').TypedData} TypedData */
30+
/** @typedef {import('@tetherto/wdk-wallet-evm').TypedDataDomain} TypedDataDomain */
31+
/** @typedef {import('@tetherto/wdk-wallet-evm').TypedDataField} TypedDataField */
32+
2933
/** @typedef {import('./src/wallet-manager-evm-erc-4337.js').EvmErc4337WalletConfig} EvmErc4337WalletConfig */
3034

35+
/** @typedef {import('./src/wallet-account-read-only-evm-erc-4337.js').EvmErc4337WalletCommonConfig} EvmErc4337WalletCommonConfig */
36+
/** @typedef {import('./src/wallet-account-read-only-evm-erc-4337.js').EvmErc4337WalletPaymasterTokenConfig} EvmErc4337WalletPaymasterTokenConfig */
37+
/** @typedef {import('./src/wallet-account-read-only-evm-erc-4337.js').EvmErc4337WalletSponsorshipPolicyConfig} EvmErc4337WalletSponsorshipPolicyConfig */
38+
/** @typedef {import('./src/wallet-account-read-only-evm-erc-4337.js').EvmErc4337WalletNativeCoinsConfig} EvmErc4337WalletNativeCoinsConfig */
39+
3140
export { default } from './src/wallet-manager-evm-erc-4337.js'
3241

3342
export { default as WalletAccountReadOnlyEvmErc4337 } from './src/wallet-account-read-only-evm-erc-4337.js'

0 commit comments

Comments
 (0)