Email Wallet SDK

https://github.com/zkemail/email-wallet-sdk
Admin
The Email Wallet SDK provides smart contracts to enhance email wallet functionality, enabling custom...
Tokens:1,600
Snippets:7
Trust Score:9
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Compile Contract with Forge

Source: https://github.com/zkemail/email-wallet-sdk/blob/main/README.md

Compiles the smart contract project using the Forge build tool. This command is essential for preparing the contract for deployment and testing.

```bash
$ forge build
```

--------------------------------

### Run Tests with Forge

Source: https://github.com/zkemail/email-wallet-sdk/blob/main/README.md

Executes the test suite for the smart contract project using the Forge testing framework. Ensure test files are correctly named and updated to reflect extension functionalities.

```bash
$ forge test
```

--------------------------------

### Register Unclaimed State - Solidity

Source: https://github.com/zkemail/email-wallet-sdk/blob/main/README.md

The `registerUnclaimedState` function is used to register an unclaimed state for a recipient's email commitment. This function is virtual and has a default implementation that reverts.

```Solidity
function registerUnclaimedState(UnclaimedState memory unclaimedState, bool isInternal) public virtual
```

--------------------------------

### Execute Extension Logic - Solidity

Source: https://github.com/zkemail/email-wallet-sdk/blob/main/README.md

The `execute` function is the core of an extension, processing parameters derived from an email subject to perform specific actions. It requires careful handling of template indices, subject parameters, wallet addresses, and recipient information.

```Solidity
function execute(uint8 templateIndex, bytes[] subjectParams, address wallet, bool hasEmailRecipient, address recipientETHAddr, bytes32 emailNullifier) external virtual
```

--------------------------------

### Publish Extension to Email Wallet Core

Source: https://github.com/zkemail/email-wallet-sdk/blob/main/README.md

Publishes a developed extension to the email wallet core contract. Requires setting the PRIVATE_KEY and EMAIL_WALLET_CORE environment variables, and specifying the RPC URL and chain ID for the target network (e.g., Arbitrum One).

```bash
PRIVATE_KEY=0x... EMAIL_WALLET_CORE=0x7A07f282Ebdc033da00EC46D602eCE742825C6dB forge script script/Deploy.s.sol --rpc-url https://arb1.arbitrum.io/rpc --chain-id 42161 --broadcast
```

--------------------------------

### Claim Unclaimed State - Solidity

Source: https://github.com/zkemail/email-wallet-sdk/blob/main/README.md

The `claimUnclaimedState` function allows a recipient user to claim an unclaimed state associated with their email commitment. It requires the unclaimed state details and the user's wallet address.

```Solidity
function claimUnclaimedState(UnclaimedState memory unclaimedState, address wallet) external virtual
```

--------------------------------

### Define Subject Templates for Extensions

Source: https://github.com/zkemail/email-wallet-sdk/blob/main/README.md

Defines subject templates as string arrays for extensions, specifying formats for subject calls. Supports various placeholders like tokenAmount, amount, string, uint, int, address, and recipient, with corresponding parameter encodings.

```solidity
subject templates are an array of string arrays, i.e., a two-dimensional string array. These are defined by an extension to declare the formats of the subject that will call the extension. Each format can use a fixed string (without spaces) and the following templates.

- "{tokenAmount}": a combination of the decimal string of the token amount and the string of the token name. The corresponding parameter in `subjectParams` is the bytes encoding `(uint256,string)`. The decimal size of the amount depends on the `decimals` value of the ERC20 contract of the token name. For example, “1.5 ETH” ⇒ `abi.encode((1.5 * (10**18), "ETH"))`, “3.4 USDC” ⇒ `abi.encode((3.4 * (10**6), "USDC"))`.
- "{amount}": a decimal string. The corresponding parameter in `subjectParams` is the bytes encoding `uint256`. The decimal size of the amount is fixed to 18. For example, “2.7” ⇒ `abi.encode(2.7 * (10**18))`.
- "{string}": a string. The corresponding parameter in `subjectParams` is the bytes encoding `string`.
- "{uint}": a decimal string of the unsigned integer. The corresponding parameter in `subjectParams` is the bytes encoding `uint256`.
- "{int}": a decimal string of the signed integer. The corresponding parameter in `subjectParams` is the bytes encoding `int256`.
- "{address}": a hex string of the Ethereum address. The corresponding parameter in `subjectParams` is the bytes encoding `address`.
- "{recipient}": either the recipient’s email address or a hex string of the recipient’s Ethereum address. The corresponding parameter in `subjectParams` is the bytes encoding either `uint256` of the byte size of the email address or `address` of the Ethereum address.
```
Tokens:
Raw