viem 2.0.0-beta.3 → 2.0.0-beta.5

package/actions/test/loadState.ts

@@ -0,0 +1,47 @@
+import type {
+  TestClient,
+  TestClientMode,
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Account } from '../../types/account.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hex } from '../../types/misc.js'
+import type { RequestErrorType } from '../../utils/buildRequest.js'
+
+export type LoadStateParameters = { state: Hex }
+export type LoadStateReturnType = void
+export type LoadStateErrorType = RequestErrorType | ErrorType
+
+/**
+ * Adds state previously dumped with `dumpState` to the current chain.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/loadState.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link LoadStateParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { loadState } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await loadState(client, { state: '0x...' })
+ */
+export async function loadState<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: TestClient<TestClientMode, Transport, TChain, TAccount, false>,
+  { state }: LoadStateParameters,
+): Promise<LoadStateReturnType> {
+  await client.request({
+    method: `${client.mode}_loadState`,
+    params: [state],
+  })
+}

package/chains/celo/formatters.ts

@@ -36,7 +36,6 @@ export const formatters = {
         return {
           ...formatTransaction(transaction as RpcTransaction),
           feeCurrency: transaction.feeCurrency,
-
           ...(transaction.type !== '0x7b'
             ? {
                 gatewayFee: transaction.gatewayFee

package/chains/celo/types.ts

@@ -151,6 +151,8 @@ export type RpcTransactionCIP64<TPending extends boolean = boolean> = Omit<
 > &
   FeeValuesEIP1559<Quantity> & {
     feeCurrency: Address | null
+    gatewayFee?: undefined
+    gatewayFeeRecipient?: undefined
     type: '0x7b'
   }
 

package/chains/definitions/chiliz.ts

@@ -0,0 +1,23 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const chiliz = /*#__PURE__*/ defineChain({
+  id: 88_888,
+  name: 'Chiliz Chain',
+  network: 'chiliz-chain',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'CHZ',
+    symbol: 'CHZ',
+  },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.ankr.com/chiliz', 'https://chiliz.publicnode.com'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Chiliz Explorer',
+      url: 'https://scan.chiliz.com',
+    },
+  },
+})

package/chains/definitions/lukso.ts

@@ -0,0 +1,28 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const lukso = /*#__PURE__*/ defineChain({
+  id: 42,
+  network: 'lukso',
+  name: 'LUKSO',
+  nativeCurrency: {
+    name: 'LUKSO',
+    symbol: 'LYX',
+    decimals: 18,
+  },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.mainnet.lukso.network'],
+      webSocket: ['wss://ws-rpc.mainnet.lukso.network'],
+    },
+    public: {
+      http: ['https://rpc.mainnet.lukso.network'],
+      webSocket: ['wss://ws-rpc.mainnet.lukso.network'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'LUKSO Mainnet Explorer',
+      url: 'https://explorer.execution.mainnet.lukso.network',
+    },
+  },
+})

package/chains/definitions/spicy.ts

@@ -0,0 +1,31 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const spicy = /*#__PURE__*/ defineChain({
+  id: 88_882,
+  name: 'Chiliz Spicy Testnet',
+  network: 'chiliz-spicy-Testnet',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'CHZ',
+    symbol: 'CHZ',
+  },
+  rpcUrls: {
+    default: {
+      http: [
+        'https://spicy-rpc.chiliz.com',
+        'https://chiliz-spicy.publicnode.com',
+      ],
+      webSocket: [
+        'wss://spicy-rpc-ws.chiliz.com',
+        'wss://chiliz-spicy.publicnode.com',
+      ],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Chiliz Explorer',
+      url: 'http://spicy-explorer.chiliz.com',
+    },
+  },
+  testnet: true,
+})

package/chains/index.ts

@@ -1,8 +1,5 @@
 export type { Chain } from '../types/chain.js'
 
-// required for type inference since in explicit return type
-export type { Assign, Omit, Prettify } from '../types/utils.js'
-
 export { arbitrum } from './definitions/arbitrum.js'
 export { arbitrumGoerli } from './definitions/arbitrumGoerli.js'
 export { arbitrumNova } from './definitions/arbitrumNova.js'
@@ -28,6 +25,7 @@ export { bxnTestnet } from './definitions/bxnTestnet.js'
 export { canto } from './definitions/canto.js'
 export { celo } from './definitions/celo.js'
 export { celoAlfajores } from './definitions/celoAlfajores.js'
+export { chiliz } from './definitions/chiliz.js'
 export { celoCannoli } from './definitions/celoCannoli.js'
 export { classic } from './definitions/classic.js'
 export { confluxESpace } from './definitions/confluxESpace.js'
@@ -75,6 +73,7 @@ export { kromaSepolia } from './definitions/kromaSepolia.js'
 export { linea } from './definitions/linea.js'
 export { lineaTestnet } from './definitions/lineaTestnet.js'
 export { localhost } from './definitions/localhost.js'
+export { lukso } from './definitions/lukso.js'
 export { mainnet } from './definitions/mainnet.js'
 export { manta } from './definitions/manta.js'
 export { mantaTestnet } from './definitions/mantaTestnet.js'
@@ -136,6 +135,7 @@ export { skaleTitan } from './definitions/skale/titan.js'
 export { skaleTitanTestnet } from './definitions/skale/titanTestnet.js'
 export { songbird } from './definitions/songbird.js'
 export { songbirdTestnet } from './definitions/songbirdTestnet.js'
+export { spicy } from './definitions/spicy.js'
 export { shardeumSphinx } from './definitions/shardeumSphinx.js'
 export { syscoin } from './definitions/syscoin.js'
 export { syscoinTestnet } from './definitions/syscoinTestnet.js'
@@ -159,3 +159,21 @@ export { zetachainAthensTestnet } from './definitions/zetachainAthensTestnet.js'
 export { zora } from './definitions/zora.js'
 export { zoraSepolia } from './definitions/zoraSepolia.js'
 export { zoraTestnet } from './definitions/zoraTestnet.js'
+
+// required for type inference since in explicit return type
+//////////////////////////////////////////////////////////////////////////////////////
+export type { Assign, Omit, Prettify } from '../types/utils.js'
+export type {
+  OpStackBlock,
+  OpStackBlockOverrides,
+  OpStackDepositTransaction,
+  OpStackRpcBlock,
+  OpStackRpcBlockOverrides,
+  OpStackRpcDepositTransaction,
+  OpStackRpcTransaction,
+  OpStackRpcTransactionReceipt,
+  OpStackRpcTransactionReceiptOverrides,
+  OpStackTransaction,
+  OpStackTransactionReceipt,
+  OpStackTransactionReceiptOverrides,
+} from './opStack/types.js'

package/chains/opStack/decorators/public.ts

@@ -48,7 +48,7 @@ import {
   estimateTotalGas,
 } from '../actions/estimateTotalGas.js'
 
-export type OpStackPublicActions<
+export type publicActionsL2<
   chain extends Chain | undefined = Chain | undefined,
   account extends Account | undefined = Account | undefined,
 > = {
@@ -62,12 +62,12 @@ export type OpStackPublicActions<
    * @example
    * import { createPublicClient, http, parseAbi } from 'viem'
    * import { optimism } from 'viem/chains'
-   * import { opStackPublicActions } from 'viem/op-stack'
+   * import { publicActionsL2 } from 'viem/op-stack'
    *
    * const client = createPublicClient({
    *   chain: optimism,
    *   transport: http(),
-   * }).extend(opStackPublicActions())
+   * }).extend(publicActionsL2())
    *
    * const l1Fee = await client.estimateContractL1Fee({
    *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
@@ -101,12 +101,12 @@ export type OpStackPublicActions<
    * @example
    * import { createPublicClient, http, parseAbi } from 'viem'
    * import { optimism } from 'viem/chains'
-   * import { opStackPublicActions } from 'viem/op-stack'
+   * import { publicActionsL2 } from 'viem/op-stack'
    *
    * const client = createPublicClient({
    *   chain: optimism,
    *   transport: http(),
-   * }).extend(opStackPublicActions())
+   * }).extend(publicActionsL2())
    *
    * const l1Gas = await client.estimateContractL1Gas({
    *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
@@ -140,12 +140,12 @@ export type OpStackPublicActions<
    * @example
    * import { createPublicClient, http, parseAbi } from 'viem'
    * import { optimism } from 'viem/chains'
-   * import { opStackPublicActions } from 'viem/op-stack'
+   * import { publicActionsL2 } from 'viem/op-stack'
    *
    * const client = createPublicClient({
    *   chain: optimism,
    *   transport: http(),
-   * }).extend(opStackPublicActions())
+   * }).extend(publicActionsL2())
    *
    * const totalFee = await client.estimateContractTotalFee({
    *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
@@ -179,12 +179,12 @@ export type OpStackPublicActions<
    * @example
    * import { createPublicClient, http, parseAbi } from 'viem'
    * import { optimism } from 'viem/chains'
-   * import { opStackPublicActions } from 'viem/op-stack'
+   * import { publicActionsL2 } from 'viem/op-stack'
    *
    * const client = createPublicClient({
    *   chain: optimism,
    *   transport: http(),
-   * }).extend(opStackPublicActions())
+   * }).extend(publicActionsL2())
    *
    * const totalGas = await client.estimateContractTotalGas({
    *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
@@ -218,12 +218,12 @@ export type OpStackPublicActions<
    * @example
    * import { createPublicClient, http, parseEther } from 'viem'
    * import { optimism } from 'viem/chains'
-   * import { opStackPublicActions } from 'viem/op-stack'
+   * import { publicActionsL2 } from 'viem/op-stack'
    *
    * const client = createPublicClient({
    *   chain: optimism,
    *   transport: http(),
-   * }).extend(opStackPublicActions())
+   * }).extend(publicActionsL2())
    *
    * const l1Fee = await client.estimateL1Fee({
    *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
@@ -244,12 +244,12 @@ export type OpStackPublicActions<
    * @example
    * import { createPublicClient, http, parseEther } from 'viem'
    * import { optimism } from 'viem/chains'
-   * import { opStackPublicActions } from 'viem/op-stack'
+   * import { publicActionsL2 } from 'viem/op-stack'
    *
    * const client = createPublicClient({
    *   chain: optimism,
    *   transport: http(),
-   * }).extend(opStackPublicActions())
+   * }).extend(publicActionsL2())
    *
    * const l1Gas = await client.estimateL1Gas({
    *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
@@ -270,12 +270,12 @@ export type OpStackPublicActions<
    * @example
    * import { createPublicClient, http, parseEther } from 'viem'
    * import { optimism } from 'viem/chains'
-   * import { opStackPublicActions } from 'viem/op-stack'
+   * import { publicActionsL2 } from 'viem/op-stack'
    *
    * const client = createPublicClient({
    *   chain: optimism,
    *   transport: http(),
-   * }).extend(opStackPublicActions())
+   * }).extend(publicActionsL2())
    *
    * const totalFee = await client.estimateTotalFee({
    *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
@@ -296,12 +296,12 @@ export type OpStackPublicActions<
    * @example
    * import { createPublicClient, http, parseEther } from 'viem'
    * import { optimism } from 'viem/chains'
-   * import { opStackPublicActions } from 'viem/op-stack'
+   * import { publicActionsL2 } from 'viem/op-stack'
    *
    * const client = createPublicClient({
    *   chain: optimism,
    *   transport: http(),
-   * }).extend(opStackPublicActions())
+   * }).extend(publicActionsL2())
    *
    * const totalGas = await client.estimateTotalGas({
    *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
@@ -314,13 +314,13 @@ export type OpStackPublicActions<
   ) => Promise<EstimateTotalGasReturnType>
 }
 
-export function opStackPublicActions() {
+export function publicActionsL2() {
   return <
     TChain extends Chain | undefined = Chain | undefined,
     TAccount extends Account | undefined = Account | undefined,
   >(
     client: Client<Transport, TChain, TAccount>,
-  ): OpStackPublicActions<TChain, TAccount> => {
+  ): publicActionsL2<TChain, TAccount> => {
     return {
       estimateContractL1Fee: (args) => estimateContractL1Fee(client, args),
       estimateContractL1Gas: (args) => estimateContractL1Gas(client, args),

package/chains/opStack/index.ts

@@ -49,7 +49,7 @@ export {
 
 export { chainConfig } from './chainConfig.js'
 
-export { opStackPublicActions } from './decorators/public.js'
+export { publicActionsL2 } from './decorators/public.js'
 
 export { base } from '../definitions/base.js'
 export { baseGoerli } from '../definitions/baseGoerli.js'

package/clients/decorators/test.ts

@@ -2,6 +2,10 @@ import {
   type DropTransactionParameters,
   dropTransaction,
 } from '../../actions/test/dropTransaction.js'
+import {
+  type DumpStateReturnType,
+  dumpState,
+} from '../../actions/test/dumpState.js'
 import {
   type GetAutomineReturnType,
   getAutomine,
@@ -26,6 +30,11 @@ import {
   type InspectTxpoolReturnType,
   inspectTxpool,
 } from '../../actions/test/inspectTxpool.js'
+import {
+  type LoadStateParameters,
+  type LoadStateReturnType,
+  loadState,
+} from '../../actions/test/loadState.js'
 import { type MineParameters, mine } from '../../actions/test/mine.js'
 import { removeBlockTimestampInterval } from '../../actions/test/removeBlockTimestampInterval.js'
 import { type ResetParameters, reset } from '../../actions/test/reset.js'
@@ -113,6 +122,26 @@ export type TestActions = {
    * })
    */
   dropTransaction: (args: DropTransactionParameters) => Promise<void>
+  /**
+   * Serializes the current state (including contracts code, contract's storage,
+   * accounts properties, etc.) into a savable data blob.
+   *
+   * - Docs: https://viem.sh/docs/actions/test/dumpState.html
+   *
+   * @param client - Client to use
+   *
+   * @example
+   * import { createTestClient, http } from 'viem'
+   * import { foundry } from 'viem/chains'
+   *
+   * const client = createTestClient({
+   *   mode: 'anvil',
+   *   chain: 'foundry',
+   *   transport: http(),
+   * })
+   * await client.dumpState()
+   */
+  dumpState: () => Promise<DumpStateReturnType>
   /**
    * Returns the automatic mining status of the node.
    *
@@ -231,6 +260,25 @@ export type TestActions = {
    * const data = await client.inspectTxpool()
    */
   inspectTxpool: () => Promise<InspectTxpoolReturnType>
+  /**
+   * Adds state previously dumped with `dumpState` to the current chain.
+   *
+   * - Docs: https://viem.sh/docs/actions/test/loadState.html
+   *
+   * @param client - Client to use
+   *
+   * @example
+   * import { createTestClient, http } from 'viem'
+   * import { foundry } from 'viem/chains'
+   *
+   * const client = createTestClient({
+   *   mode: 'anvil',
+   *   chain: 'foundry',
+   *   transport: http(),
+   * })
+   * await client.loadState({ state: '0x...' })
+   */
+  loadState: (args: LoadStateParameters) => Promise<LoadStateReturnType>
   /**
    * Mine a specified number of blocks.
    *
@@ -689,12 +737,14 @@ export function testActions<TMode extends TestClientMode>({
     }))
     return {
       dropTransaction: (args) => dropTransaction(client, args),
+      dumpState: () => dumpState(client),
       getAutomine: () => getAutomine(client),
       getTxpoolContent: () => getTxpoolContent(client),
       getTxpoolStatus: () => getTxpoolStatus(client),
       impersonateAccount: (args) => impersonateAccount(client, args),
       increaseTime: (args) => increaseTime(client, args),
       inspectTxpool: () => inspectTxpool(client),
+      loadState: (args) => loadState(client, args),
       mine: (args) => mine(client, args),
       removeBlockTimestampInterval: () => removeBlockTimestampInterval(client),
       reset: (args) => reset(client, args),

package/constants/bytes.ts

@@ -0,0 +1,2 @@
+export const zeroHash =
+  '0x0000000000000000000000000000000000000000000000000000000000000000' as const

package/constants/strings.ts

@@ -0,0 +1 @@
+export const presignMessagePrefix = '\x19Ethereum Signed Message:\n'

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.0.0-beta.3'
+export const version = '2.0.0-beta.5'

package/index.ts

@@ -578,6 +578,8 @@ export {
   minInt248,
   minInt256,
 } from './constants/number.js'
+export { zeroHash } from './constants/bytes.js'
+export { presignMessagePrefix } from './constants/strings.js'
 export {
   AbiConstructorNotFoundError,
   type AbiConstructorNotFoundErrorType,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.5",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -76,13 +76,27 @@
   },
   "typesVersions": {
     "*": {
-      "accounts": ["./_types/accounts/index.d.ts"],
-      "actions": ["./_types/actions/index.d.ts"],
-      "chains": ["./_types/chains/index.d.ts"],
-      "chains/utils": ["./_types/chains/utils.d.ts"],
-      "ens": ["./_types/ens/index.d.ts"],
-      "utils": ["./_types/utils/index.d.ts"],
-      "window": ["./_types/window/index.d.ts"]
+      "accounts": [
+        "./_types/accounts/index.d.ts"
+      ],
+      "actions": [
+        "./_types/actions/index.d.ts"
+      ],
+      "chains": [
+        "./_types/chains/index.d.ts"
+      ],
+      "chains/utils": [
+        "./_types/chains/utils.d.ts"
+      ],
+      "ens": [
+        "./_types/ens/index.d.ts"
+      ],
+      "utils": [
+        "./_types/utils/index.d.ts"
+      ],
+      "window": [
+        "./_types/window/index.d.ts"
+      ]
     }
   },
   "peerDependencies": {
@@ -106,12 +120,21 @@
   "license": "MIT",
   "homepage": "https://viem.sh",
   "repository": "wagmi-dev/viem",
-  "authors": ["awkweb.eth", "jxom.eth"],
+  "authors": [
+    "awkweb.eth",
+    "jxom.eth"
+  ],
   "funding": [
     {
       "type": "github",
       "url": "https://github.com/sponsors/wagmi-dev"
     }
   ],
-  "keywords": ["eth", "ethereum", "dapps", "wallet", "web3"]
-}
+  "keywords": [
+    "eth",
+    "ethereum",
+    "dapps",
+    "wallet",
+    "web3"
+  ]
+}

package/types/eip1193.ts

@@ -709,6 +709,14 @@ export type TestRpcSchema<TMode extends string> = [
     Parameters: [hash: Hash]
     ReturnType: void
   },
+  /**
+   * @description Serializes the current state (including contracts code, contract's storage, accounts properties, etc.) into a savable data blob.
+   */
+  {
+    Method: `${TMode}_dumpState`
+    Parameters?: undefined
+    ReturnType: Hex
+  },
   /**
    * @description Turn on call traces for transactions that are returned to the user when they execute a transaction (instead of just txhash/receipt).
    */
@@ -735,6 +743,14 @@ export type TestRpcSchema<TMode extends string> = [
     Parameters?: undefined
     ReturnType: boolean
   },
+  /**
+   * @description Adds state previously dumped with `dumpState` to the current chain.
+   */
+  {
+    Method: `${TMode}_loadState`
+    Parameters?: [Hex]
+    ReturnType: void
+  },
   /**
    * @description Advance the block number of the network by a certain number of blocks
    * @link https://hardhat.org/hardhat-network/docs/reference#hardhat_mine

package/types/rpc.ts

@@ -17,7 +17,7 @@ import type {
   TransactionRequestEIP2930,
   TransactionRequestLegacy,
 } from './transaction.js'
-import type { UnionOmit } from './utils.js'
+import type { UnionOmit, UnionPartialBy } from './utils.js'
 
 export type Index = `0x${string}`
 export type Quantity = `0x${string}`
@@ -46,9 +46,14 @@ export type RpcTransactionRequest =
   | TransactionRequestLegacy<Quantity, Index, '0x0'>
   | TransactionRequestEIP2930<Quantity, Index, '0x1'>
   | TransactionRequestEIP1559<Quantity, Index, '0x2'>
-export type RpcTransaction<TPending extends boolean = boolean> = UnionOmit<
-  | TransactionLegacy<Quantity, Index, TPending, '0x0'>
-  | TransactionEIP2930<Quantity, Index, TPending, '0x1'>
-  | TransactionEIP1559<Quantity, Index, TPending, '0x2'>,
+export type RpcTransaction<TPending extends boolean = boolean,> = UnionOmit<
+  UnionPartialBy<
+    | TransactionLegacy<Quantity, Index, TPending, '0x0'>
+    | TransactionEIP2930<Quantity, Index, TPending, '0x1'>
+    | TransactionEIP1559<Quantity, Index, TPending, '0x2'>,
+    // `yParity` is optional on the RPC type as some nodes do not return it
+    // for 1559 & 2930 transactions (they should!).
+    'yParity'
+  >,
   'typeHex'
 >

package/types/transaction.ts

@@ -80,16 +80,21 @@ export type TransactionBase<
   v: TQuantity
   /** Value in wei sent with this transaction */
   value: TQuantity
+  /** The parity of the y-value of the secp256k1 signature. */
+  yParity: TIndex
 }
 export type TransactionLegacy<
   TQuantity = bigint,
   TIndex = number,
   TPending extends boolean = boolean,
   TType = 'legacy',
-> = TransactionBase<TQuantity, TIndex, TPending> &
+> = Omit<TransactionBase<TQuantity, TIndex, TPending>, 'yParity'> &
   FeeValuesLegacy<TQuantity> & {
+    /** EIP-2930 Access List. */
     accessList?: never
+    /** Chain ID that this transaction is valid on. */
     chainId?: TIndex
+    yParity?: never
     type: TType
   }
 export type TransactionEIP2930<
@@ -99,7 +104,9 @@ export type TransactionEIP2930<
   TType = 'eip2930',
 > = TransactionBase<TQuantity, TIndex, TPending> &
   FeeValuesLegacy<TQuantity> & {
+    /** EIP-2930 Access List. */
     accessList: AccessList
+    /** Chain ID that this transaction is valid on. */
     chainId: TIndex
     type: TType
   }
@@ -110,7 +117,9 @@ export type TransactionEIP1559<
   TType = 'eip1559',
 > = TransactionBase<TQuantity, TIndex, TPending> &
   FeeValuesEIP1559<TQuantity> & {
+    /** EIP-2930 Access List. */
     accessList: AccessList
+    /** Chain ID that this transaction is valid on. */
     chainId: TIndex
     type: TType
   }

package/types/utils.ts

@@ -130,6 +130,15 @@ export type Omit<type, keys extends keyof type> = Pick<
   Exclude<keyof type, keys>
 >
 
+/**
+ * @description Creates a type that is a partial of T, but with the required keys K.
+ *
+ * @example
+ * PartialBy<{ a: string, b: number }, 'a'>
+ * => { a?: string, b: number }
+ */
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+
 /**
  * @description Combines members of an intersection into a readable type.
  *
@@ -220,3 +229,14 @@ export type UnionLooseOmit<type, keys extends string> = type extends any
 export type UnionOmit<type, keys extends keyof type> = type extends any
   ? Omit<type, keys>
   : never
+
+/**
+ * @description Creates a type that is a partial of T, but with the required keys K.
+ *
+ * @example
+ * PartialBy<{ a: string, b: number } | { a: string, b: undefined, c: number }, 'a'>
+ * => { a?: string, b: number } | { a?: string, b: undefined, c: number }
+ */
+export type UnionPartialBy<T, K extends keyof T> = T extends any
+  ? PartialBy<T, K>
+  : never