✨ Support mapping of ENS text records to user meta

Author: davisshaver

composer.json

@@ -16,7 +16,7 @@
 	"scripts": {
 		"lint": "@phpcs",
 		"lint:fix": "@phpcbf",
-		"phpcbf": "phpcbf .",
+		"phpcbf": "phpcbf . --runtime-set text_domain wp-rainbow --runtime-set prefixes wp_rainbow",
 		"phpcs": "phpcs . --runtime-set text_domain wp-rainbow --runtime-set prefixes wp_rainbow",
 		"phpunit": "phpunit --config=phpunit.xml",
 		"test": "@phpunit"

inc/class-wp-rainbow-login-functionality.php

@@ -91,10 +91,10 @@ public function get_role_for_address_filtered( string $address, string $filtered
 		/**
 		 * Filter the default role for WP Rainbow users.
 		 *
-		 * @param string        $default Default role for new users.
-		 * @param string        $address Address of user being added.
-		 * @param string        $filtered_infura_id Filtered Infura ID.
-		 * @param string        $filtered_infura_network Filtered Infura network.
+		 * @param string $default Default role for new users.
+		 * @param string $address Address of user being added.
+		 * @param string $filtered_infura_id Filtered Infura ID.
+		 * @param string $filtered_infura_network Filtered Infura network.
 		 * @param WP_User|false $user User object, if available.
 		 */
 		return apply_filters( 'wp_rainbow_role_for_address', 'subscriber', $address, $filtered_infura_id, $filtered_infura_network, $user );
@@ -193,6 +193,7 @@ public function login_callback( WP_REST_Request $request ): WP_REST_Response {
 			$signature    = $request->get_param( 'signature' );
 			$display_name = $request->get_param( 'displayName' );
 			$siwe_payload = $request->get_param( 'siwePayload' );
+			$attributes   = $request->get_param( 'attributes' );
 			if ( empty( $address ) || empty( $signature ) ) {
 				throw new Exception( __( 'Malformed authentication request.', 'wp-rainbow' ) );
 			}
@@ -300,6 +301,30 @@ function ( $err, $balance ) use ( $wp_rainbow_options ) {
 
 				$user->set_role( $role );
 
+				$user_attributes_mapping = $wp_rainbow->get_parsed_user_attributes_mapping();
+				foreach ( $user_attributes_mapping as $mapping ) {
+					if ( isset( $attributes[ $mapping[0] ] ) ) {
+						if ( in_array(
+							$mapping[1],
+							[
+								'user_email',
+								'user_url',
+							],
+							true
+						) ) {
+							wp_update_user(
+								[
+									'ID'        => $user->ID,
+									$mapping[1] => $attributes[ $mapping[0] ],
+								] 
+							);
+						} else {
+							update_user_meta( $user->ID, $mapping[1], $attributes[ $mapping[0] ] );
+
+						}
+					}
+				}
+
 				/**
 				 * Fires when a WP Rainbow user's is updated on login.
 				 *

inc/class-wp-rainbow-settings.php

@@ -175,6 +175,17 @@ public function action_admin_init() {
 				'label_for' => 'wp_rainbow_field_cool_mode',
 			]
 		);
+
+		add_settings_field(
+			'wp_rainbow_field_user_attributes_mapping',
+			__( 'ENS Text Records to User Meta Mapping', 'wp-rainbow' ),
+			[ self::$instance, 'wp_rainbow_field_user_attributes_mapping_callback' ],
+			'wp_rainbow',
+			'wp_rainbow_connection_options',
+			[
+				'label_for' => 'wp_rainbow_field_user_attributes_mapping',
+			],
+		);
 	}
 
 	/**
@@ -444,6 +455,31 @@ public function wp_rainbow_infura_network_callback() {
 		<?php
 	}
 
+	/**
+	 * Print field for ENS text attributes to WP user meta option.
+	 */
+	public function wp_rainbow_field_user_attributes_mapping_callback() {
+		$options       = get_option( 'wp_rainbow_options', [ 'wp_rainbow_field_user_attributes_mapping' => '' ] );
+		$mapping_field = ! empty( $options['wp_rainbow_field_user_attributes_mapping'] ) ? $options['wp_rainbow_field_user_attributes_mapping'] : '';
+		?>
+		<textarea
+			id='wp_rainbow_field_user_attributes_mapping'
+			name='wp_rainbow_options[wp_rainbow_field_user_attributes_mapping]'
+			rows='5'
+			type='textarea'
+		><?php echo esc_textarea( $mapping_field ); ?></textarea>
+		<p>
+			<em>
+				<small>
+					<?php
+					esc_html_e( 'Enter a mapping of ENS text attributes to WordPress user meta, one on each line. Example: url,user_url', 'wp-rainbow' );
+					?>
+				</small>
+			</em>
+		</p>
+		<?php
+	}
+
 	/**
 	 * Print header for connection options.
 	 *

inc/class-wp-rainbow.php

@@ -164,6 +164,7 @@ public function action_init() {
 				'SITE_TITLE'   => get_bloginfo( 'name' ),
 				'COOL_MODE'    => (bool) $this->get_cool_mode_filtered(),
 				'NETWORK'      => esc_textarea( $this->get_infura_network_filtered() ),
+				'ATTRIBUTES'   => $this->get_frontend_attributes(),
 			]
 		);
 		wp_localize_script(
@@ -180,10 +181,66 @@ public function action_init() {
 				'LOGOUT_URL'   => wp_logout_url(),
 				'COOL_MODE'    => (bool) $this->get_cool_mode_filtered(),
 				'NETWORK'      => esc_textarea( $this->get_infura_network_filtered() ),
+				'ATTRIBUTES'   => $this->get_frontend_attributes(),
 			]
 		);
 	}
 
+	/**
+	 * Get a parsed version of filtered user attributes mapping.
+	 */
+	public function get_parsed_user_attributes_mapping() {
+		$csv = explode( "\n", $this->get_user_attributes_mapping_filtered() );
+
+		return array_map(
+			function ( $row ) {
+				return explode( ',', $row );
+			},
+			$csv
+		);
+	}
+
+	/**
+	 * Get and parse use attributes for frontend.
+	 *
+	 * @return array Attributes for frontend
+	 */
+	public function get_frontend_attributes() {
+		return array_reduce(
+			$this->get_parsed_user_attributes_mapping(),
+			function ( $agg, $item ) {
+				if ( ! empty( $item ) && ! empty( $item[0] ) ) {
+					$agg[] = $item[0];
+				}
+
+				return $agg;
+			},
+			[] 
+		);
+	}
+
+	/**
+	 * Provide filter for user attributes mapping.
+	 *
+	 * @return array Filtered user attributes mapping
+	 */
+	public function get_user_attributes_mapping_filtered() {
+		$options = get_option(
+			'wp_rainbow_options',
+			[
+				'wp_rainbow_field_user_attributes_mapping' =>
+					'url,user_url',
+			] 
+		);
+
+		/**
+		 * Filter the user attributes mapping for WP Rainbow users.
+		 *
+		 * @param array $default Default user attributes mapping.
+		 */
+		return apply_filters( 'wp_rainbow_user_attributes_mapping', $options['wp_rainbow_field_user_attributes_mapping'] ?? '' );
+	}
+
 	// LOGIN SCRIPTS.
 
 	/**
@@ -219,6 +276,7 @@ public function action_login_enqueue_scripts() {
 				'SITE_TITLE'   => get_bloginfo( 'name' ),
 				'COOL_MODE'    => (bool) $this->get_cool_mode_filtered(),
 				'NETWORK'      => esc_textarea( $this->get_infura_network_filtered() ),
+				'ATTRIBUTES'   => $this->get_frontend_attributes(),
 			]
 		);
 	}

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wp-rainbow",
-	"version": "0.2.15",
+	"version": "0.2.16",
 	"description": "RainbowKit Login (Web3 Integration for Sign-In With Ethereum)",
 	"author": "Davis Shaver",
 	"license": "GPL-2.0-or-later",

readme.txt

@@ -4,7 +4,7 @@ Tags: WordPress, web3, SIWE, Ethereum, RainbowKit, Sign-In With Ethereum
 Tested up to: 6.0
 Requires at least: 5.9
 Requires PHP: 7.0
-Stable tag: 0.2.15
+Stable tag: 0.2.16
 License: GPLv2 or later
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
@@ -47,6 +47,9 @@ Find reference implementations of all filters in [example plugin here](https://g
 
 == Changelog ==
 
+= 0.2.16 =
+* Add support for mapping ENS text records to user fields
+
 = 0.2.15 =
 * Fix bug with override redirect URL on login block
 

src/connect.jsx

@@ -4,15 +4,23 @@ import {
 	useAccount,
 	useDisconnect,
 	useEnsName,
+	useProvider,
 	useNetwork,
 	useSignMessage,
 } from 'wagmi';
 import stylePropType from 'react-style-proptype';
 import { SiweMessage } from 'siwe';
 import PropTypes from 'prop-types';
 
-const { ADMIN_URL, LOGGED_IN, LOGIN_API, NONCE_API, REDIRECT_URL, SITE_TITLE } =
-	wpRainbowData;
+const {
+	ADMIN_URL,
+	ATTRIBUTES,
+	LOGGED_IN,
+	LOGIN_API,
+	NONCE_API,
+	REDIRECT_URL,
+	SITE_TITLE,
+} = wpRainbowData;
 
 /**
  * WP Rainbow Connect Button.
@@ -57,6 +65,9 @@ export function WPRainbowConnect( {
 		address,
 		chainId: 1,
 	} );
+
+	const provider = useProvider( { chainId: 1 } );
+
 	const { disconnectAsync } = useDisconnect();
 
 	const signIn = React.useCallback( async () => {
@@ -85,6 +96,20 @@ export function WPRainbowConnect( {
 				version: '1',
 			};
 			const message = new SiweMessage( siwePayload );
+			const attributes = {};
+			if ( ensName ) {
+				try {
+					const ensProvider = await provider.getResolver( ensName );
+					await ATTRIBUTES.forEach( async ( attributeKey ) => {
+						const attributeValue = await ensProvider.getText(
+							attributeKey
+						);
+						attributes[ attributeKey ] = attributeValue;
+					} );
+				} catch ( error ) {
+					console.log( error );
+				}
+			}
 			const signature = await signMessageAsync( {
 				message: message.prepareMessage(),
 			} );
@@ -99,6 +124,7 @@ export function WPRainbowConnect( {
 				},
 				body: JSON.stringify( {
 					address,
+					attributes,
 					displayName: ensName ?? address,
 					nonce,
 					signature,
@@ -108,11 +134,6 @@ export function WPRainbowConnect( {
 			if ( verifyRes.ok ) {
 				setState( ( x ) => ( { ...x, address, loading: false } ) );
 				onLogin();
-				console.log( {
-					redirectURL,
-					REDIRECT_URL,
-					ADMIN_URL,
-				} );
 				if ( redirectBoomerang ) {
 					window.location.reload();
 				} else {

wp-rainbow.php

@@ -10,7 +10,7 @@
  * Plugin Name:       RainbowKit Login (Web3 Integration for Sign-In With Ethereum)
  * Plugin URI:        https://wp-rainbow.davisshaver.com/
  * Description:       RainbowKit Login allows WordPress users to log in with Ethereum using the Sign-In With Ethereum standard, powered by RainbowKit.
- * Version:           0.2.15
+ * Version:           0.2.16
  * Author:            Davis Shaver
  * Author URI:        https://davisshaver.com/
  * License:           GPL v2 or later
@@ -27,7 +27,7 @@
  *
  * @var string
  */
-define( 'WP_RAINBOW_ASSETS_VERSION', '0.2.15' );
+define( 'WP_RAINBOW_ASSETS_VERSION', '0.2.16' );
 
 // Include the autoloader.
 add_action(