refactor: clarify api key auth naming

Author: cesarenaldi

packages/client/src/actions/auth.ts

@@ -16,12 +16,7 @@ import {
 } from '../errors';
 import { validateWith } from '../response';
 
-export type CreateL2AuthRequest = {
-  chainId: number;
-  nonce?: number;
-};
-
-export type L2AuthRequest = {
+export type ApiKeyAuthRequest = {
   address: EvmAddress;
   nonce: number;
   signature: Signature;
@@ -50,7 +45,7 @@ export type CreateApiKeyError =
  */
 export async function createApiKey(
   client: Client,
-  request: L2AuthRequest,
+  request: ApiKeyAuthRequest,
 ): Promise<ApiKeyCreds> {
   return unwrap(
     client.clob
@@ -83,7 +78,7 @@ export type DeriveApiKeyError =
  */
 export async function deriveApiKey(
   client: Client,
-  request: L2AuthRequest,
+  request: ApiKeyAuthRequest,
 ): Promise<ApiKeyCreds> {
   return unwrap(
     client.clob
@@ -116,7 +111,7 @@ export type CreateOrDeriveApiKeyError =
  */
 export async function createOrDeriveApiKey(
   client: Client,
-  request: L2AuthRequest,
+  request: ApiKeyAuthRequest,
 ): Promise<ApiKeyCreds> {
   try {
     return await createApiKey(client, request);
@@ -169,7 +164,7 @@ export async function fetchApiKeys(
   return response.apiKeys;
 }
 
-function toL1Headers(auth: L2AuthRequest): HeadersInit {
+function toL1Headers(auth: ApiKeyAuthRequest): HeadersInit {
   return {
     POLY_ADDRESS: auth.address,
     POLY_NONCE: `${auth.nonce}`,

packages/client/src/authentication.ts

@@ -15,16 +15,16 @@ export type AuthenticationWorkflow = AsyncGenerator<
   EvmAddress | Signature
 >;
 
-export type CreateL2AuthTypedDataPayloadRequest = {
+export type CreateApiKeyAuthTypedDataPayloadRequest = {
   address: EvmAddress;
   chainId: number;
   nonce?: number;
   timestamp: number;
 };
 
 /** @internal */
-export function createL2AuthTypedDataPayload(
-  request: CreateL2AuthTypedDataPayloadRequest,
+export function createApiKeyAuthTypedDataPayload(
+  request: CreateApiKeyAuthTypedDataPayloadRequest,
 ): TypedDataPayload {
   return {
     domain: {

packages/client/src/clients.ts

@@ -8,7 +8,7 @@ import { fetchPublicProfile } from './actions/profiles';
 import { fetchWalletType } from './actions/wallets';
 import {
   type AuthenticationWorkflow,
-  createL2AuthTypedDataPayload,
+  createApiKeyAuthTypedDataPayload,
 } from './authentication';
 import { type EnvironmentConfig, production } from './environments';
 import { RequestRejectedError } from './errors';
@@ -117,7 +117,7 @@ class PublicClient extends AbstractClient<Context> {
 
         const signature = yield {
           kind: 'signAuthMessage',
-          payload: createL2AuthTypedDataPayload({
+          payload: createApiKeyAuthTypedDataPayload({
             address,
             chainId: this.environment.chainId,
             nonce,