chore: version packages #2204

github-actions · 2024-10-03T07:15:49Z

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or setup this action to publish automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@rainbow-me/[email protected]

Minor Changes

f02bced: The Authentication API now supports ERC-1271 and ERC-6492 for smart contract signature verification to enable Sign-in with Ethereum for Smart Contract Wallets, including Coinbase Smart Wallet and Argent.

We have also deprecated the siwe and ethers peer dependencies in favor of viem/siwe to make RainbowKit even more seamless.

No changes are necessary for dApps that don't rely on the Authentication API.

Follow the appropriate steps below to migrate.

** NextAuth Authentication **

Remove siwe and ethers

npm uninstall siwe ethers

Upgrade RainbowKit, rainbowkit-siwe-next-auth, and viem

npm i @rainbow-me/rainbowkit@^2.2.0 rainbow-me/rainbowkit-siwe-next-auth@^0.5.0 viem@^2.12.0

Create a Public Client

This allows viem to verify smart contract signatures.

const config = getDefaultConfig({
  /* your config */
});
+ const publicClient = config.getClient().extend(publicActions);

Adjust your authorize implementation in /api/auth/[...nextauth].ts

- import { SiweMessage } from 'siwe';
+ import {
+   type SiweMessage,
+   parseSiweMessage,
+   validateSiweMessage,
+ } from 'viem/siwe';

export function getAuthOptions(req: IncomingMessage): NextAuthOptions {
  const providers = [
    CredentialsProvider({
      async authorize(credentials: any) {

-       const siwe = new SiweMessage(
-         JSON.parse(credentials?.message || '{}'),
-       );
+       const siweMessage = parseSiweMessage(
+         credentials?.message,
+       ) as SiweMessage;

+       if (!validateSiweMessage({
+         address: siweMessage?.address,
+         message: siweMessage,
+       })) {
+         return null;
+       }

        /* ... */

-       await siwe.verify({ signature: credentials?.signature || '' });
+       const valid = await publicClient.verifyMessage({
+         address: siweMessage?.address,
+         message: credentials?.message,
+         signature: credentials?.signature,
+       });

+       if (!valid) {
+         return null;
+       }
      },
      /* ... */
    })
  ]
}

Reference the with-next-siwe-next-auth example for more guidance.

** Custom Authentication **

Remove siwe and ethers

npm uninstall siwe ethers

Upgrade RainbowKit and viem

npm i @rainbow-me/rainbowkit@^2.2.0 viem@^2.12.0

Create a Public Client

This allows viem to verify smart contract signatures.

const config = getDefaultConfig({
  /* your config */
});

+ const publicClient = config.getClient().extend(publicActions);

Adjust your createAuthenticationAdapter implementation

- import { SiweMessage } from 'siwe';
+ import { createSiweMessage } from 'viem/siwe';

createAuthenticationAdapter({
  getNonce: async () => {
    const response = await fetch('/api/nonce');
    return await response.text();
  },

  createMessage: ({ nonce, address, chainId }) => {
-   return new SiweMessage({
+   return createSiweMessage({
      domain: window.location.host,
      address,
      statement: 'Sign in with Ethereum to the app.',
      uri: window.location.origin,
      version: '1',
      chainId,
      nonce,
    });
  },

- getMessageBody: ({ message }) => {
-   return message.prepareMessage();
- },

  /* ... */
})

Adopt generateSiweNonce

- import { generateNonce } from 'siwe';
+ import { generateSiweNonce } from 'viem/siwe';

- req.session.nonce = generateNonce();
+ req.session.nonce = generateSiweNonce();

Adopt parseSiweMessage and verifyMessage if your Verify handler

- import { SiweMessage } from 'siwe';
+ import { parseSiweMessage, type SiweMessage } from 'viem/siwe';

const { message, signature } = req.body;
- const siweMessage = new SiweMessage(message);
- const { success, error, data } = await siweMessage.verify({
-  signature,
- });
+ const siweMessage = parseSiweMessage(message) as SiweMessage;
+ const success = await publicClient.verifyMessage({
+   address: siweMessage.address,
+   message,
+   signature,
+ });

- if (!success) throw error;
+ if (!success) throw new Error('Invalid signature.');

- if (data.nonce !== req.session.nonce)
+ if (siweMessage.nonce !== req.session.nonce)
+   return res.status(422).json({ message: 'Invalid nonce.' });

Reference the with-next-siwe-iron-session example for more guidance.

@rainbow-me/[email protected]

Minor Changes

f02bced: The Authentication API now supports ERC-1271 and ERC-6492 for smart contract signature verification to enable Sign-in with Ethereum for Smart Contract Wallets.

We have also deprecated the siwe and ethers peer dependencies in favor of viem/siwe.

Follow the appropriate steps below to migrate.

Remove siwe and ethers

npm uninstall siwe ethers

Upgrade RainbowKit, rainbowkit-siwe-next-auth, and viem

npm i @rainbow-me/rainbowkit@^2.2.0 rainbow-me/rainbowkit-siwe-next-auth@^0.5.0 viem@^2.12.0

Create a Public Client

This allows viem to verify smart contract signatures.

const config = getDefaultConfig({
  /* your config */
});
+ const publicClient = config.getClient().extend(publicActions);

Adjust your authorize implementation in /api/auth/[...nextauth].ts

- import { SiweMessage } from 'siwe';
+ import {
+   type SiweMessage,
+   parseSiweMessage,
+   validateSiweMessage,
+ } from 'viem/siwe';

export function getAuthOptions(req: IncomingMessage): NextAuthOptions {
  const providers = [
    CredentialsProvider({
      async authorize(credentials: any) {

-       const siwe = new SiweMessage(
-         JSON.parse(credentials?.message || '{}'),
-       );
+       const siweMessage = parseSiweMessage(
+         credentials?.message,
+       ) as SiweMessage;

+       if (!validateSiweMessage({
+         address: siweMessage?.address,
+         message: siweMessage,
+       })) {
+         return null;
+       }

        /* ... */

-       await siwe.verify({ signature: credentials?.signature || '' });
+       const valid = await publicClient.verifyMessage({
+         address: siweMessage?.address,
+         message: credentials?.message,
+         signature: credentials?.signature,
+       });

+       if (!valid) {
+         return null;
+       }
      },
      /* ... */
    })
  ]
}

Reference the with-next-siwe-next-auth example for more guidance.

Patch Changes

Updated dependencies [f02bced]
- @rainbow-me/[email protected]

@rainbow-me/[email protected]

Patch Changes

dc31926: Upgraded wagmi to ^2.12.17

@rainbow-me/[email protected]

Patch Changes

Updated dependencies [f02bced]
- @rainbow-me/[email protected]

chore: version packages #2204

chore: version packages #2204

Conversation

github-actions bot commented Oct 3, 2024 • edited Loading

Releases

@rainbow-me/[email protected]

Minor Changes

@rainbow-me/[email protected]

Minor Changes

Patch Changes

@rainbow-me/[email protected]

Patch Changes

@rainbow-me/[email protected]

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

vercel bot commented Oct 3, 2024 • edited Loading

github-actions bot commented Oct 3, 2024 •

edited

Loading

vercel bot commented Oct 3, 2024 •

edited

Loading