tempo.ts 0.1.5 → 0.2.1

package/src/viem/Actions/dex.ts

@@ -1,6 +1,9 @@
+import * as Hash from 'ox/Hash'
+import * as Hex from 'ox/Hex'
 import {
   type Account,
   type Address,
+  type BaseErrorType,
   type Chain,
   type Client,
   type ExtractAbiItem,
@@ -22,6 +25,9 @@ import {
   writeContractSync,
 } from 'viem/actions'
 import type { Compute, UnionOmit } from '../../internal/types.js'
+import * as Order from '../../ox/Order.js'
+import * as OrdersFilters from '../../ox/OrdersFilters.js'
+import * as Pagination from '../../ox/Pagination.js'
 import * as Abis from '../Abis.js'
 import * as Addresses from '../Addresses.js'
 import type {
@@ -48,7 +54,7 @@ type OrderType = 'buy' | 'sell'
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -93,6 +99,9 @@ export namespace buy {
 
   export type ReturnValue = WriteContractReturnType
 
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
   /** @internal */
   export async function inner<
     action extends typeof writeContract | typeof writeContractSync,
@@ -126,7 +135,7 @@ export namespace buy {
    * import { Actions } from 'tempo.ts/viem'
    *
    * const client = createClient({
-   *   chain: tempo,
+   *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
    *   transport: http(),
    * }).extend(walletActions)
    *
@@ -168,7 +177,7 @@ export namespace buy {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -211,6 +220,9 @@ export namespace buySync {
     /** Transaction receipt. */
     receipt: TransactionReceipt
   }>
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -225,7 +237,7 @@ export namespace buySync {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -261,6 +273,9 @@ export namespace cancel {
 
   export type ReturnValue = WriteContractReturnType
 
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
   /** @internal */
   export async function inner<
     action extends typeof writeContract | typeof writeContractSync,
@@ -294,7 +309,7 @@ export namespace cancel {
    * import { Actions } from 'tempo.ts/viem'
    *
    * const client = createClient({
-   *   chain: tempo,
+   *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
    *   transport: http(),
    * }).extend(walletActions)
    *
@@ -350,7 +365,7 @@ export namespace cancel {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -400,6 +415,9 @@ export namespace cancelSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -414,7 +432,7 @@ export namespace cancelSync {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -450,6 +468,9 @@ export namespace createPair {
 
   export type ReturnValue = WriteContractReturnType
 
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
   /** @internal */
   export async function inner<
     action extends typeof writeContract | typeof writeContractSync,
@@ -483,7 +504,7 @@ export namespace createPair {
    * import { Actions } from 'tempo.ts/viem'
    *
    * const client = createClient({
-   *   chain: tempo,
+   *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
    *   transport: http(),
    * }).extend(walletActions)
    *
@@ -539,7 +560,7 @@ export namespace createPair {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -589,6 +610,9 @@ export namespace createPairSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -601,7 +625,7 @@ export namespace createPairSync {
  * import { Actions } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -676,7 +700,7 @@ export namespace getBalance {
  * import { Actions } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -747,7 +771,7 @@ export namespace getBuyQuote {
  * import { Actions } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -802,6 +826,125 @@ export namespace getOrder {
   }
 }
 
+/**
+ * Gets paginated orders from the orderbook.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ *
+ * const client = createClient({
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
+ *   transport: http(),
+ * })
+ *
+ * const { items, nextCursor } = await Actions.dex.getOrders(client, {
+ *   limit: 100,
+ *   filters: {
+ *     baseToken: '0x20c0...',
+ *     isBid: true,
+ *   }
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns Paginated orders and next cursor.
+ */
+export async function getOrders<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: getOrders.Parameters = {},
+): Promise<getOrders.ReturnValue> {
+  const params = Pagination.toRpcParameters(parameters, {
+    toRpcFilters: OrdersFilters.toRpc,
+  })
+  const response = await client.request<any>({
+    method: 'dex_getOrders',
+    params: [params],
+  })
+  return Pagination.fromRpcResponse(response, {
+    key: 'orders',
+    fromRpc: Order.fromRpc,
+  })
+}
+
+export namespace getOrders {
+  export type Parameters = Pagination.Params<OrdersFilters.OrdersFilters>
+
+  export type ReturnValue = Pagination.Response<'orders', Order.Order>
+}
+
+/**
+ * Gets orderbook information for a trading pair.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ *
+ * const client = createClient({
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
+ *   transport: http(),
+ * })
+ *
+ * const book = await Actions.dex.getOrderbook(client, {
+ *   base: '0x20c...11',
+ *   quote: '0x20c...20',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The orderbook information.
+ */
+export async function getOrderbook<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: getOrderbook.Parameters,
+): Promise<getOrderbook.ReturnValue> {
+  const { base, quote, ...rest } = parameters
+  return readContract(client, {
+    ...rest,
+    ...getOrderbook.call({ base, quote }),
+  })
+}
+
+export namespace getOrderbook {
+  export type Parameters = ReadParameters & Args
+
+  export type Args = {
+    /** Address of the base token. */
+    base: Address
+    /** Address of the quote token. */
+    quote: Address
+  }
+
+  export type ReturnValue = ReadContractReturnType<
+    typeof Abis.stablecoinExchange,
+    'books',
+    never
+  >
+
+  /**
+   * Defines a call to the `books` function.
+   *
+   * @param args - Arguments.
+   * @returns The call.
+   */
+  export function call(args: Args) {
+    const { base, quote } = args
+    const pairKey = getPairKey(base, quote)
+    return defineCall({
+      address: Addresses.stablecoinExchange,
+      abi: Abis.stablecoinExchange,
+      args: [pairKey],
+      functionName: 'books',
+    })
+  }
+}
+
 /**
  * Gets the price level information at a specific tick.
  *
@@ -812,7 +955,7 @@ export namespace getOrder {
  * import { Actions, Tick } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -883,7 +1026,7 @@ export namespace getPriceLevel {
  * import { Actions } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -956,7 +1099,7 @@ export namespace getSellQuote {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1001,6 +1144,9 @@ export namespace place {
 
   export type ReturnValue = WriteContractReturnType
 
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
   /** @internal */
   export async function inner<
     action extends typeof writeContract | typeof writeContractSync,
@@ -1034,7 +1180,7 @@ export namespace place {
    * import { Actions, Tick } from 'tempo.ts/viem'
    *
    * const client = createClient({
-   *   chain: tempo,
+   *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
    *   transport: http(),
    * }).extend(walletActions)
    *
@@ -1094,7 +1240,7 @@ export namespace place {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1142,6 +1288,9 @@ export namespace placeFlip {
 
   export type ReturnValue = WriteContractReturnType
 
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
   /** @internal */
   export async function inner<
     action extends typeof writeContract | typeof writeContractSync,
@@ -1175,7 +1324,7 @@ export namespace placeFlip {
    * import { Actions, Tick } from 'tempo.ts/viem'
    *
    * const client = createClient({
-   *   chain: tempo,
+   *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
    *   transport: http(),
    * }).extend(walletActions)
    *
@@ -1236,7 +1385,7 @@ export namespace placeFlip {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1290,6 +1439,9 @@ export namespace placeFlipSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -1304,7 +1456,7 @@ export namespace placeFlipSync {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1357,6 +1509,9 @@ export namespace placeSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -1371,7 +1526,7 @@ export namespace placeSync {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1416,6 +1571,9 @@ export namespace sell {
 
   export type ReturnValue = WriteContractReturnType
 
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
   /** @internal */
   export async function inner<
     action extends typeof writeContract | typeof writeContractSync,
@@ -1449,7 +1607,7 @@ export namespace sell {
    * import { Actions } from 'tempo.ts/viem'
    *
    * const client = createClient({
-   *   chain: tempo,
+   *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
    *   transport: http(),
    * }).extend(walletActions)
    *
@@ -1491,7 +1649,7 @@ export namespace sell {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1534,6 +1692,9 @@ export namespace sellSync {
     /** Transaction receipt. */
     receipt: TransactionReceipt
   }>
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -1546,7 +1707,7 @@ export namespace sellSync {
  * import { Actions } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1627,7 +1788,7 @@ export declare namespace watchFlipOrderPlaced {
  * import { Actions } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1703,7 +1864,7 @@ export declare namespace watchOrderCancelled {
  * import { Actions } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1787,7 +1948,7 @@ export declare namespace watchOrderFilled {
  * import { Actions } from 'tempo.ts/viem'
  *
  * const client = createClient({
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1870,7 +2031,7 @@ export declare namespace watchOrderPlaced {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -1909,6 +2070,9 @@ export namespace withdraw {
 
   export type ReturnValue = WriteContractReturnType
 
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
   /** @internal */
   export async function inner<
     action extends typeof writeContract | typeof writeContractSync,
@@ -1942,7 +2106,7 @@ export namespace withdraw {
    * import { Actions } from 'tempo.ts/viem'
    *
    * const client = createClient({
-   *   chain: tempo,
+   *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
    *   transport: http(),
    * }).extend(walletActions)
    *
@@ -1982,7 +2146,7 @@ export namespace withdraw {
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: tempo,
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
  *   transport: http(),
  * })
  *
@@ -2023,4 +2187,13 @@ export namespace withdrawSync {
     /** Transaction receipt. */
     receipt: TransactionReceipt
   }>
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+}
+
+function getPairKey(base: Address, quote: Address) {
+  const [tokenA, tokenB] =
+    Hex.toBigInt(base) < Hex.toBigInt(quote) ? [base, quote] : [quote, base]
+  return Hash.keccak256(Hex.concat(tokenA, tokenB))
 }

package/src/viem/Actions/faucet.ts

@@ -0,0 +1,50 @@
+import type { Account, Address, Chain, Client, Hash, Transport } from 'viem'
+import { parseAccount } from 'viem/utils'
+
+/**
+ * Funds an account with an initial amount of set token(s)
+ * on Tempo's testnet.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ *
+ * const client = createClient({
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' }),
+ *   transport: http(),
+ * })
+ *
+ * const hashes = await Actions.faucet.fund(client, {
+ *   account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function fund<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: fund.Parameters,
+): Promise<fund.ReturnValue> {
+  const account = parseAccount(parameters.account)
+  return client.request<{
+    Method: 'tempo_fundAddress'
+    Parameters: [address: Address]
+    ReturnType: readonly Hash[]
+  }>({
+    method: 'tempo_fundAddress',
+    params: [account.address],
+  })
+}
+
+export declare namespace fund {
+  export type Parameters = {
+    /** Account to fund. */
+    account: Account | Address
+  }
+
+  export type ReturnValue = readonly Hash[]
+}

package/src/viem/Actions/fee.test.ts

@@ -1,44 +1,33 @@
 import { setTimeout } from 'node:timers/promises'
-import { Abis, Addresses, createTempoClient } from 'tempo.ts/viem'
-import { parseEther, publicActions } from 'viem'
-import { mnemonicToAccount } from 'viem/accounts'
+import { Abis } from 'tempo.ts/viem'
+import { parseUnits } from 'viem'
 import { writeContractSync } from 'viem/actions'
-import { describe, expect, test } from 'vitest'
-import { tempoTest } from '../../../test/viem/config.js'
+import { afterEach, describe, expect, test } from 'vitest'
+import { accounts, client, rpcUrl } from '../../../test/viem/config.js'
 import * as actions from './index.js'
 
-const account = mnemonicToAccount(
-  'test test test test test test test test test test test junk',
-)
-const account2 = mnemonicToAccount(
-  'test test test test test test test test test test test junk',
-  { accountIndex: 1 },
-)
-const account3 = mnemonicToAccount(
-  'test test test test test test test test test test test junk',
-  { accountIndex: 2 },
-)
+const account = accounts[0]
+const account2 = accounts[1]
+const account3 = accounts[2]
 
-const client = createTempoClient({
-  account,
-  chain: tempoTest,
-  pollingInterval: 100,
-}).extend(publicActions)
+afterEach(async () => {
+  await fetch(`${rpcUrl}/restart`)
+})
 
 describe('getUserToken', () => {
   test('default', async () => {
     // Fund accounts
     await writeContractSync(client, {
       abi: Abis.tip20,
-      address: Addresses.defaultFeeToken,
+      address: '0x20c0000000000000000000000000000000000001',
       functionName: 'transfer',
-      args: [account2.address, parseEther('100')],
+      args: [account2.address, parseUnits('100', 6)],
     })
     await writeContractSync(client, {
       abi: Abis.tip20,
-      address: Addresses.defaultFeeToken,
+      address: '0x20c0000000000000000000000000000000000001',
       functionName: 'transfer',
-      args: [account3.address, parseEther('100')],
+      args: [account3.address, parseUnits('100', 6)],
     })
 
     // Set token (address)
@@ -137,7 +126,7 @@ describe('setUserToken', () => {
   })
 })
 
-describe('watchSetUserToken', () => {
+describe('watchSetUserToken', async () => {
   test('default', async () => {
     const receivedSets: Array<{
       args: actions.fee.watchSetUserToken.Args
@@ -155,9 +144,9 @@ describe('watchSetUserToken', () => {
       // Set token for account2
       await writeContractSync(client, {
         abi: Abis.tip20,
-        address: Addresses.defaultFeeToken,
+        address: '0x20c0000000000000000000000000000000000001',
         functionName: 'transfer',
-        args: [account2.address, parseEther('1')],
+        args: [account2.address, parseUnits('1', 6)],
       })
 
       await actions.fee.setUserTokenSync(client, {
@@ -168,9 +157,9 @@ describe('watchSetUserToken', () => {
       // Set token for account3
       await writeContractSync(client, {
         abi: Abis.tip20,
-        address: Addresses.defaultFeeToken,
+        address: '0x20c0000000000000000000000000000000000001',
         functionName: 'transfer',
-        args: [account3.address, parseEther('1')],
+        args: [account3.address, parseUnits('1', 6)],
       })
 
       await actions.fee.setUserTokenSync(client, {
@@ -219,16 +208,16 @@ describe('watchSetUserToken', () => {
       // Transfer gas to accounts
       await writeContractSync(client, {
         abi: Abis.tip20,
-        address: Addresses.defaultFeeToken,
+        address: '0x20c0000000000000000000000000000000000001',
         functionName: 'transfer',
-        args: [account2.address, parseEther('1')],
+        args: [account2.address, parseUnits('1', 6)],
       })
 
       await writeContractSync(client, {
         abi: Abis.tip20,
-        address: Addresses.defaultFeeToken,
+        address: '0x20c0000000000000000000000000000000000001',
         functionName: 'transfer',
-        args: [account3.address, parseEther('1')],
+        args: [account3.address, parseUnits('1', 6)],
       })
 
       // Set token for account2 (should be captured)