Merge pull request #714 from MoralisWeb3/default-networkType

fix: rename networkType param and set default

.changeset/pretty-mayflies-add.md

@@ -0,0 +1,7 @@
+---
+'@moralisweb3/auth': patch
+'@moralisweb3/evm-utils': patch
+'@moralisweb3/streams': patch
+---
+
+Rename `network` param to `networkType` for `Moralis.Streams` and `Moralis.Auth`, to communicate more clearly the purpose of this param. Also make this value optional and default to `"evm"`

demos/firebase-auth/functions/src/index.ts

@@ -31,7 +31,7 @@ export const requestMessage = functions.https.onCall(async (data: RequestMessage
 
   const response = await Moralis.Auth.requestMessage({
     chain: EvmChain.create(data.chain),
-    network: 'evm',
+    networkType: 'evm',
     timeout: 15,
     domain: 'mydomain.com',
     uri: 'https://mydomain.com/my-uri',
@@ -53,7 +53,7 @@ interface IssueTokenData {
 export const issueToken = functions.https.onCall(async (data: IssueTokenData) => {
   const response = await Moralis.Auth.verify({
     message: data.message,
-    network: 'evm',
+    networkType: 'evm',
     signature: data.signature,
   });
   const uid = response.result.profileId;

demos/moralis-stream/public/script.js

@@ -1,3 +1,4 @@
+/* global document, window, axios*/
 const STREAM_API_URL = 'http://localhost:3000/stream';
 const HOOK_API_URL = 'http://localhost:3000/hooks';
 
@@ -37,11 +38,11 @@ const handleEventsRequest = async (method, endpoint, data, params) => {
 };
 
 const addStream = async (webhookUrl) => {
-  const result = await handleApiRequest('post', 'create', { webhookUrl, network: 'evm' });
+  const result = await handleApiRequest('post', 'create', { webhookUrl });
   renderResult(result);
 };
 const updateStream = async (webhookUrl, id) => {
-  const result = await handleApiRequest('patch', `update/${id}`, { webhookUrl, network: 'evm' });
+  const result = await handleApiRequest('patch', `update/${id}`, { webhookUrl });
   renderResult(result);
 };
 const getStreams = async () => {

demos/moralis-stream/src/stream/streamController.ts

@@ -6,7 +6,7 @@ export async function create(req: Request, res: Response, next: NextFunction) {
     const { webhookUrl } = req.body;
 
     const result = await addStream({
-      network: 'evm',
+      networkType: 'evm',
       webhookUrl,
     });
 
@@ -32,7 +32,7 @@ export async function update(req: Request, res: Response, next: NextFunction) {
     const { id } = req.params;
 
     const message = await updateStream(id, {
-      network: 'evm',
+      networkType: 'evm',
       webhookUrl,
     });
 

demos/moralis-stream/src/stream/streamService.ts

@@ -1,7 +1,7 @@
 import Moralis from 'moralis';
 
 interface StreamOptions {
-  network: 'evm';
+  networkType: 'evm';
   webhookUrl: string;
 }
 
@@ -10,9 +10,9 @@ const TAG = 'transactions';
 const CHAINIDS = ['0x3', '0x4'];
 
 export async function addStream(options: StreamOptions) {
-  const { network, webhookUrl } = options;
+  const { networkType, webhookUrl } = options;
   const result = await Moralis.Streams.add({
-    network,
+    networkType,
     webhookUrl,
     chains: CHAINIDS,
     tag: TAG,
@@ -26,7 +26,7 @@ export async function addStream(options: StreamOptions) {
 export async function getStreams() {
   const result = await Moralis.Streams.getAll({
     limit: 20,
-    network: 'evm',
+    networkType: 'evm',
   });
 
   return result.raw;
@@ -35,17 +35,17 @@ export async function getStreams() {
 export async function deleteStream(id: string) {
   const result = await Moralis.Streams.delete({
     id,
-    network: 'evm',
+    networkType: 'evm',
   });
 
   return result.raw;
 }
 
 export async function updateStream(id: string, options: StreamOptions) {
-  const { network, webhookUrl } = options;
+  const { networkType, webhookUrl } = options;
   const result = await Moralis.Streams.update({
     id,
-    network,
+    networkType,
     webhookUrl,
     chains: CHAINIDS,
     tag: TAG,

demos/nextjs/app/components/modules/Authentication/Authentication.tsx

@@ -41,6 +41,7 @@ const Authentication = () => {
 
   const handleAuth = async (connector?: Connector, disabled?: boolean) => {
     if (disabled) {
+      // eslint-disable-next-line no-alert
       alert('Setup it first in the Authentication.tsx');
       return;
     }
@@ -51,7 +52,7 @@ const Authentication = () => {
 
     const { account, chain } = await connectAsync({ connector });
 
-    const userData = { address: account, chain: chain.id, network: 'evm' };
+    const userData = { address: account, chain: chain.id, networkType: 'evm' };
 
     const { message } = await apiPost('/auth/request-message', userData);
 
@@ -62,7 +63,7 @@ const Authentication = () => {
       // redirects to main page
       push('/');
     } catch (e) {
-      return;
+      // Do nothing
     }
   };
 

demos/parse-server-migration-react-client/src/components/AuthenticateModal.tsx

@@ -52,7 +52,7 @@ export const AuthenticateModal = ({ isOpen, onClose }: AuthenticateModalProps) =
       const { message } = await Moralis.Cloud.run('requestMessage', {
         address: account,
         chain: parseInt(chainId, 16),
-        network: 'evm',
+        networkType: 'evm',
       });
 
       // Authenticate and login via parse

demos/parse-server-migration/src/auth/MoralisEthAdapter.ts

@@ -9,7 +9,7 @@ function validateAuthData(authData: any) {
   return Moralis.Auth.verify({
     message: data,
     signature,
-    network: 'evm',
+    networkType: 'evm',
   })
     .then((result) => {
       const authenticated = result.toJSON();

demos/parse-server-migration/src/auth/authService.ts

@@ -3,7 +3,7 @@ import Moralis from 'moralis';
 export interface RequestMessage {
   address: string;
   chain: string;
-  network: string;
+  networkType: string;
 }
 
 const DOMAIN = 'defi.finance';
@@ -12,11 +12,19 @@ const URI = 'https://defi.finance';
 const EXPIRATION_TIME = '2023-01-01T00:00:00.000Z';
 const TIMEOUT = 15;
 
-export async function requestMessage({ address, chain, network }: { address: string; chain: string; network: 'evm' }) {
+export async function requestMessage({
+  address,
+  chain,
+  networkType,
+}: {
+  address: string;
+  chain: string;
+  networkType: 'evm';
+}) {
   const result = await Moralis.Auth.requestMessage({
     address,
     chain,
-    network,
+    networkType,
     domain: DOMAIN,
     statement: STATEMENT,
     uri: URI,

demos/parse-server-migration/src/cloud/main.ts

@@ -6,12 +6,12 @@ import './generated/solApi';
 import { requestMessage } from '../auth/authService';
 
 Parse.Cloud.define('requestMessage', async ({ params }: any) => {
-  const { address, chain, network } = params;
+  const { address, chain, networkType } = params;
 
   const message = await requestMessage({
     address,
     chain,
-    network,
+    networkType,
   });
 
   return { message };

demos/parse-server/public/script.js

@@ -17,18 +17,18 @@ const handleApiPost = async (endpoint, params) => {
   return result.data;
 };
 
-const requestMessage = (account, network, chain) =>
+const requestMessage = (account, networkType, chain) =>
   handleApiPost('request-message', {
     address: account,
     chain,
-    network,
+    networkType,
   });
 
-const verifyMessage = (message, signature, network) =>
+const verifyMessage = (message, signature, networkType) =>
   handleApiPost('sign-message', {
     message,
     signature,
-    network,
+    networkType,
   });
 
 const connectToMetamask = async () => {

demos/parse-server/src/auth/authController.ts

@@ -3,12 +3,12 @@ import { NextFunction, Request, Response } from 'express';
 
 export async function request(req: Request, res: Response, next: NextFunction) {
   try {
-    const { address, chain, network } = req.body;
+    const { address, chain, networkType } = req.body;
 
     const message = await requestMessage({
       address,
       chain,
-      network,
+      networkType,
     });
 
     res.status(200).json({ message });

demos/parse-server/src/auth/authService.ts

@@ -23,26 +23,34 @@ const TIMEOUT = 15;
 export async function requestMessage({
   address,
   chain,
-  network,
+  networkType,
 }: {
   address: string;
   chain?: string;
-  network: 'evm' | 'solana';
+  networkType: 'evm' | 'solana';
 }) {
-  if (network === 'evm' && chain) {
-    return requestMessageEvm({ address, chain, network });
+  if (networkType === 'evm' && chain) {
+    return requestMessageEvm({ address, chain, networkType });
   }
-  if (network === 'solana') {
-    return requestMessageSol({ address, network });
+  if (networkType === 'solana') {
+    return requestMessageSol({ address, networkType });
   }
   throw new Error('Invalid network');
 }
 
-async function requestMessageEvm({ address, chain, network }: { address: string; chain: string; network: 'evm' }) {
+async function requestMessageEvm({
+  address,
+  chain,
+  networkType,
+}: {
+  address: string;
+  chain: string;
+  networkType: 'evm';
+}) {
   const result = await Moralis.Auth.requestMessage({
     address,
     chain,
-    network,
+    networkType,
     domain: DOMAIN,
     statement: STATEMENT,
     uri: URI,
@@ -56,10 +64,10 @@ async function requestMessageEvm({ address, chain, network }: { address: string;
   return message;
 }
 
-async function requestMessageSol({ address, network }: { address: string; network: 'solana' }) {
+async function requestMessageSol({ address, networkType }: { address: string; networkType: 'solana' }) {
   const result = await Moralis.Auth.requestMessage({
     address,
-    network,
+    networkType,
     solNetwork: 'devnet',
     domain: DOMAIN,
     statement: STATEMENT,

demos/supabase-auth/public/script.js

@@ -1,3 +1,4 @@
+/* global document, window, axios, supabase, ethers */
 const AUTH_API_URL = 'http://localhost:3000/api/auth';
 const SUPABASE_URL = 'replace_me';
 const SUPABASE_PUBLIC_ANON_KEY = 'replace_me';
@@ -24,19 +25,19 @@ let token;
 const requestMessage = (account, chain) =>
   handleApiPost('request-message', {
     address: account,
-    chain: chain,
-    network: 'evm',
+    chain,
+    networkType: 'evm',
   });
 
 const verifyMessage = (message, signature) =>
   handleApiPost('sign-message', {
     message,
     signature,
-    network: 'evm',
+    networkType: 'evm',
   });
 
-const getUser = async (token) => {
-  _supabase.auth.setAuth(token);
+const getUser = async (providedToken) => {
+  _supabase.auth.setAuth(providedToken);
   const { data } = await _supabase.from('users').select('*');
   renderUser(data);
 };

demos/supabase-auth/src/auth/authController.ts

@@ -3,12 +3,12 @@ import { NextFunction, Request, Response } from 'express';
 
 export async function request(req: Request, res: Response, next: NextFunction) {
   try {
-    const { address, chain, network } = req.body;
+    const { address, chain, networkType } = req.body;
 
     const message = await requestMessage({
       address,
       chain,
-      network,
+      networkType,
     });
 
     res.status(200).json({ message });
@@ -19,10 +19,10 @@ export async function request(req: Request, res: Response, next: NextFunction) {
 
 export async function verify(req: Request, res: Response, next: NextFunction) {
   try {
-    const { network, message, signature } = req.body;
+    const { networkType, message, signature } = req.body;
 
     const user = await verifyMessage({
-      network,
+      networkType,
       message,
       signature,
     });