Skip to content

Commit

Permalink
chore: rename packages
Browse files Browse the repository at this point in the history
  • Loading branch information
dalechyn committed May 15, 2024
1 parent 55afa21 commit 7185f09
Show file tree
Hide file tree
Showing 34 changed files with 49 additions and 1,525 deletions.
2 changes: 1 addition & 1 deletion Dockerfile.relay
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ WORKDIR /home/node/app
COPY --chown=node:node ./package.json ./package.json
RUN pnpm global add turbo@$(node -e "console.log(require('./package.json').devDependencies.turbo)")
COPY --chown=node:node . .
RUN pnpm turbo prune --scope=@farcaster/auth-relay --docker
RUN pnpm turbo prune --scope=@fc-auth/relay --docker

###############################################################################
############## Stage 2: Build the code using a full node image ################
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Farcaster Auth Monorepo

> This repository is a fork of https://github.com/farcasterxyz/auth-monorepo and continuation of PR https://github.com/farcasterxyz/auth-monorepo/pull/147.
The software is provided AS IS, meaning that it's not guaranteed to be maintained unless the opposite is stated.

This monorepo contains packages and applications related to [Farcaster Auth](https://www.notion.so/warpcast/Farcaster-Connect-Public-9b3e9fb7a4b74f158369796f3e77c1d3).

## Packages

| Package Name | Description | Use if… |
| ------------------------------------------------ | -------------------------- | ---------------------------------------------------------------------- |
| [@farcaster/auth-kit](./packages/auth-kit) | React components and hooks | You're building a React app and want to authenticate Farcaster users. |
| [@farcaster/auth-client](./packages/auth-client) | Client library | You're building a Typescript or JS app and want to authenticate users. |
| [@farcaster/auth-relay](./apps/relay) | HTTP relay server | You want to relay connection requests. (You probably don't need this). |
| [@fc-auth/react](./packages/react) | React components and hooks | You're building a React app and want to authenticate Farcaster users. |
| [@fc-auth/core](./packages/core) | Client library | You're building a Typescript or JS app and want to authenticate users. |
| [@fc-auth/relay](./apps/relay) | HTTP relay server | You want to relay connection requests. (You probably don't need this). |
59 changes: 0 additions & 59 deletions apps/relay/CHANGELOG.md

This file was deleted.

6 changes: 3 additions & 3 deletions apps/relay/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `@farcaster/relay`
# `@fc-auth/relay`

Farcaster Auth HTTP relay server.

Expand Down Expand Up @@ -26,6 +26,6 @@ pnpm start

The Farcaster Auth relay server connects apps and wallets over a temporary stateful channel. Channel sessions are stored in Redis and expire after 1 hour.

Anyone can run their own relay server and connect to it using the `@farcaster/auth-client` client. Merkle operates and maintains the `relay.farcaster.xyz` server used by Warpcast and available to the public.
Anyone can run their own relay server and connect to it using the `@fc-auth/core` client. Merkle operates and maintains the `relay.farcaster.xyz` server used by Warpcast and available to the public.

You don't need to run a relay server to use Farcaster Auth. If you just want to sign in a user to your app, look at the [`@farcaster/auth-kit`](../../packages/auth-kit/) and [`@farcaster/auth-client`](../../packages/auth-client/) packages.
You don't need to run a relay server to use Farcaster Auth. If you just want to sign in a user to your app, look at the [`@fc-auth/react`](../../packages/react/) and [`@fc-auth/core`](../../packages/core/) packages.
4 changes: 2 additions & 2 deletions apps/relay/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@farcaster/relay",
"name": "@fc-auth/relay",
"description": "Farcaster Auth relay server",
"version": "0.0.9",
"version": "0.0.0",
"license": "MIT",
"repository": {
"type": "git",
Expand Down
2 changes: 1 addition & 1 deletion examples/authkit-expo-demo/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import 'fastestsmallesttextencoderdecoder';

import { StatusBar } from 'expo-status-bar';
import { StyleSheet, Text, View, Button, Linking } from 'react-native';
import { AuthKitProvider, useSignIn } from '@farcaster/auth-kit';
import { AuthKitProvider, useSignIn } from '@fc-auth/react';
import { useEffect, useCallback } from 'react';

const config = {
Expand Down
2 changes: 1 addition & 1 deletion examples/authkit-expo-demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"dependencies": {
"@expo/metro-runtime": "~3.1.3",
"@farcaster/auth-kit": "workspace:*",
"@fc-auth/react": "workspace:*",
"expo": "~50.0.14",
"expo-status-bar": "~1.11.1",
"fastestsmallesttextencoderdecoder": "^1.0.22",
Expand Down
10 changes: 0 additions & 10 deletions examples/frontend-only/CHANGELOG.md

This file was deleted.

2 changes: 1 addition & 1 deletion examples/frontend-only/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"preview": "vite preview"
},
"dependencies": {
"@farcaster/auth-kit": "workspace:*",
"@fc-auth/react": "workspace:*",
"ethers": "6",
"@tanstack/react-query": "^5.28.8",
"react": "^18.2.0",
Expand Down
4 changes: 2 additions & 2 deletions examples/frontend-only/src/App.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { JsonRpcProvider } from "ethers";
import "@farcaster/auth-kit/styles.css";
import { AuthKitProvider, createConfig, SignInButton, useProfile } from "@farcaster/auth-kit";
import "@fc-auth/react/styles.css";
import { AuthKitProvider, createConfig, SignInButton, useProfile } from "@fc-auth/react";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";

const queryClient = new QueryClient();
Expand Down
2 changes: 1 addition & 1 deletion examples/frontend-only/turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"extends": ["//"],
"pipeline": {
"build": {
"dependsOn": ["@farcaster/auth-client#build"],
"dependsOn": ["@fc-auth/core#build"],
"inputs": ["src/**", "vite.config.ts", "tsconfig.json", "tsconfig.node.json"],
"outputs": ["dist/**"]
}
Expand Down
10 changes: 0 additions & 10 deletions examples/with-next-auth/CHANGELOG.md

This file was deleted.

2 changes: 1 addition & 1 deletion examples/with-next-auth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"lint": "next lint"
},
"dependencies": {
"@farcaster/auth-kit": "workspace:*",
"@fc-auth/react": "workspace:*",
"ethers": "^6.12.0",
"@tanstack/react-query": "^5.28.8",
"next": "14.0.4",
Expand Down
2 changes: 1 addition & 1 deletion examples/with-next-auth/pages/api/auth/[...nextauth].ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import NextAuth from "next-auth";
import CredentialsProvider from "next-auth/providers/credentials";
import { createAppClient, viemConnector } from "@farcaster/auth-client";
import { createAppClient, viemConnector } from "@fc-auth/core";
import { NextApiRequest, NextApiResponse } from "next";
import { JsonRpcProvider } from "ethers";

Expand Down
4 changes: 2 additions & 2 deletions examples/with-next-auth/pages/index.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import "@farcaster/auth-kit/styles.css";
import "@fc-auth/react/styles.css";

import Head from "next/head";
import { useSession, signIn, signOut, getCsrfToken } from "next-auth/react";
import { SignInButton, AuthKitProvider, createConfig, SignInReturnType } from "@farcaster/auth-kit";
import { SignInButton, AuthKitProvider, createConfig, SignInReturnType } from "@fc-auth/react";
import { useCallback, useState } from "react";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";

Expand Down
2 changes: 1 addition & 1 deletion examples/with-next-auth/turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"extends": ["//"],
"pipeline": {
"build": {
"dependsOn": ["@farcaster/auth-client#build"],
"dependsOn": ["@fc-auth/core#build"],
"inputs": ["src/**", "vite.config.ts", "tsconfig.json", "tsconfig.node.json", "next.config.js"],
"outputs": ["dist/**"]
}
Expand Down
143 changes: 0 additions & 143 deletions packages/core/CHANGELOG.md

This file was deleted.

Loading

0 comments on commit 7185f09

Please sign in to comment.