refactor: rename EVM signatures to disambiguate auth

Author: cesarenaldi

packages/client/src/actions/auth.ts

@@ -8,7 +8,7 @@ import {
   BuilderApiKeyCredsSchema,
   BuilderApiKeysResponseSchema,
 } from '@polymarket/bindings/clob';
-import { type EvmAddress, type Signature, unwrap } from '@polymarket/types';
+import { type EvmAddress, type EvmSignature, unwrap } from '@polymarket/types';
 import { z } from 'zod';
 import type { Client, SecureClient } from '../clients';
 import {
@@ -23,7 +23,7 @@ import { validateWith } from '../response';
 export type ApiKeyAuthRequest = {
   address: EvmAddress;
   nonce: number;
-  signature: Signature;
+  signature: EvmSignature;
   timestamp: number;
 };
 

packages/client/src/actions/orders/prepare.ts

@@ -1,4 +1,4 @@
-import { expectSignature, never } from '@polymarket/types';
+import { expectEvmSignature, never } from '@polymarket/types';
 import type { SecureClient } from '../../clients';
 import type {
   InsufficientLiquidityError,
@@ -61,7 +61,7 @@ export async function prepareMarketOrder(
 
     const unsignedOrder = createUnsignedOrder(draft, client.account);
 
-    const signature = expectSignature(
+    const signature = expectEvmSignature(
       yield {
         kind: 'signOrder',
         payload: createOrderTypedDataPayload(unsignedOrder),
@@ -108,7 +108,7 @@ export async function prepareLimitOrder(
 
     const unsignedOrder = createUnsignedOrder(draft, client.account);
 
-    const signature = expectSignature(
+    const signature = expectEvmSignature(
       yield {
         kind: 'signOrder',
         payload: createOrderTypedDataPayload(unsignedOrder),

packages/client/src/actions/orders/types.ts

@@ -5,8 +5,8 @@ import type {
 } from '@polymarket/bindings/clob';
 import type {
   EvmAddress,
+  EvmSignature,
   HexString,
-  Signature,
   TxHash,
 } from '@polymarket/types';
 import type { TypedDataPayload } from '../../types';
@@ -116,7 +116,7 @@ export type SignedOrder = {
   taker: EvmAddress;
   takerAmount: string;
   tokenId: string;
-  signature: Signature;
+  signature: EvmSignature;
 };
 
 export type OrderWorkflowRequest =
@@ -136,5 +136,5 @@ export type OrderWorkflowRequest =
 export type OrderWorkflow = AsyncGenerator<
   OrderWorkflowRequest,
   SignedOrder,
-  Signature | TxHash
+  EvmSignature | TxHash
 >;

packages/client/src/authentication.ts

@@ -1,4 +1,4 @@
-import type { EvmAddress, Signature } from '@polymarket/types';
+import type { EvmAddress, EvmSignature } from '@polymarket/types';
 import type { SecureClient } from './clients';
 import type { TypedDataPayload } from './types';
 
@@ -12,7 +12,7 @@ export type AuthenticationWorkflowRequest =
 export type AuthenticationWorkflow = AsyncGenerator<
   AuthenticationWorkflowRequest,
   SecureClient,
-  EvmAddress | Signature
+  EvmAddress | EvmSignature
 >;
 
 export type CreateApiKeyAuthTypedDataPayloadRequest = {

packages/client/src/clients.ts

@@ -2,7 +2,7 @@ import type { ApiKeyCreds } from '@polymarket/bindings/clob';
 import type { EvmAddress } from '@polymarket/types';
 import {
   expectEvmAddress,
-  expectSignature,
+  expectEvmSignature,
   invariant,
 } from '@polymarket/types';
 import type { AccountIdentity } from './account';
@@ -147,7 +147,7 @@ export class PublicClient extends AbstractClient<PublicContext> {
         const credentials = await createOrDeriveApiKey(this, {
           address: signer,
           nonce,
-          signature: expectSignature(signature),
+          signature: expectEvmSignature(signature),
           timestamp,
         });
 

packages/client/src/viem/index.ts

@@ -1,6 +1,6 @@
 import {
   expectEvmAddress,
-  expectSignature,
+  expectEvmSignature,
   invariant,
   type TxHash,
 } from '@polymarket/types';
@@ -41,7 +41,7 @@ export function authenticateWith(walletClient: WalletClient) {
             break;
           case 'signAuthMessage':
             result = await workflow.next(
-              expectSignature(
+              expectEvmSignature(
                 await walletClient.signTypedData({
                   account,
                   ...result.value.payload,
@@ -75,7 +75,7 @@ export function executeWith(walletClient: WalletClient) {
         switch (result.value.kind) {
           case 'signOrder':
             result = await workflow.next(
-              expectSignature(
+              expectEvmSignature(
                 await walletClient.signTypedData({
                   account,
                   ...result.value.payload,

packages/types/src/hex.ts

@@ -16,9 +16,9 @@ export type PrivateKey = Tagged<HexString, 'PrivateKey'>;
 export type EvmAddress = Tagged<HexString, 'EvmAddress'>;
 
 /**
- * A hex-encoded cryptographic signature.
+ * A hex-encoded EVM signature.
  */
-export type Signature = Tagged<HexString, 'Signature'>;
+export type EvmSignature = Tagged<HexString, 'EvmSignature'>;
 
 /**
  * A transaction hash returned by an EVM-compatible network.

packages/types/src/refinements.ts

@@ -1,8 +1,8 @@
 import { InvariantError } from './errors';
 import {
   type EvmAddress,
+  type EvmSignature,
   isHexString,
-  type Signature,
   type TxHash,
 } from './hex';
 
@@ -51,17 +51,17 @@ export function expectEvmAddress(
 }
 
 /**
- * Refines a string to a signature or throws when the value is invalid.
+ * Refines a string to an EVM signature or throws when the value is invalid.
  */
-export function expectSignature(
+export function expectEvmSignature(
   value: string,
-  message = 'Expected a signature',
-): Signature {
+  message = 'Expected an EVM signature',
+): EvmSignature {
   if (!isHexString(value) || value.length !== 132) {
     throw new InvariantError(message);
   }
 
-  return value as Signature;
+  return value as EvmSignature;
 }
 
 /**