tempo.ts 0.1.4 → 0.2.0

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 {
@@ -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,
@@ -211,6 +220,9 @@ export namespace buySync {
     /** Transaction receipt. */
     receipt: TransactionReceipt
   }>
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -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,
@@ -400,6 +415,9 @@ export namespace cancelSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -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,
@@ -589,6 +610,9 @@ export namespace createPairSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -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,
+ *   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,
+ *   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.
  *
@@ -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,
@@ -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,
@@ -1290,6 +1439,9 @@ export namespace placeFlipSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -1357,6 +1509,9 @@ export namespace placeSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -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,
@@ -1534,6 +1692,9 @@ export namespace sellSync {
     /** Transaction receipt. */
     receipt: TransactionReceipt
   }>
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**
@@ -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,
@@ -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/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)

package/src/viem/Actions/fee.ts

@@ -1,6 +1,7 @@
 import {
   type Account,
   type Address,
+  type BaseErrorType,
   type Chain,
   type Client,
   type ExtractAbiItem,
@@ -156,6 +157,9 @@ export namespace setUserToken {
 
   export type ReturnValue = WriteContractReturnType
 
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
   /** @internal */
   export async function inner<
     action extends typeof writeContract | typeof writeContractSync,
@@ -291,6 +295,9 @@ export namespace setUserTokenSync {
       receipt: TransactionReceipt
     }
   >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
 }
 
 /**

package/src/viem/Actions/index.ts

@@ -2,4 +2,5 @@ export * as amm from './amm.js'
 export * as dex from './dex.js'
 export * as fee from './fee.js'
 export * as policy from './policy.js'
+export * as reward from './reward.js'
 export * as token from './token.js'

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

@@ -1,28 +1,11 @@
 import { setTimeout } from 'node:timers/promises'
-import { publicActions } from 'viem'
-import { mnemonicToAccount } from 'viem/accounts'
-import { describe, expect, test } from 'vitest'
-import { tempoTest } from '../../../test/viem/config.js'
-import { createTempoClient } from '../Client.js'
+import { beforeAll, 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 client = createTempoClient({
-  account,
-  chain: tempoTest,
-  pollingInterval: 100,
-}).extend(publicActions)
+const account = accounts[0]
+const account2 = accounts[1]
+const account3 = accounts[2]
 
 describe('create', () => {
   test('default', async () => {
@@ -58,7 +41,7 @@ describe('create', () => {
     expect(blacklistReceipt).toBeDefined()
     expect(blacklistResult).toMatchInlineSnapshot(`
       {
-        "policyId": 2n,
+        "policyId": 3n,
         "policyType": 1,
         "updater": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
       }
@@ -120,7 +103,7 @@ describe('setAdmin', () => {
     expect(setAdminResult).toMatchInlineSnapshot(`
       {
         "admin": "0x8C8d35429F74ec245F8Ef2f4Fd1e551cFF97d650",
-        "policyId": 2n,
+        "policyId": 4n,
         "updater": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
       }
     `)
@@ -163,7 +146,7 @@ describe('modifyWhitelist', () => {
       {
         "account": "0x8C8d35429F74ec245F8Ef2f4Fd1e551cFF97d650",
         "allowed": true,
-        "policyId": 2n,
+        "policyId": 5n,
         "updater": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
       }
     `)
@@ -189,7 +172,7 @@ describe('modifyWhitelist', () => {
       {
         "account": "0x8C8d35429F74ec245F8Ef2f4Fd1e551cFF97d650",
         "allowed": false,
-        "policyId": 2n,
+        "policyId": 5n,
         "updater": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
       }
     `)
@@ -232,7 +215,7 @@ describe('modifyBlacklist', () => {
     expect(addBlacklistResult).toMatchInlineSnapshot(`
       {
         "account": "0x8C8d35429F74ec245F8Ef2f4Fd1e551cFF97d650",
-        "policyId": 2n,
+        "policyId": 6n,
         "restricted": true,
         "updater": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
       }
@@ -258,7 +241,7 @@ describe('modifyBlacklist', () => {
     expect(removeBlacklistResult).toMatchInlineSnapshot(`
       {
         "account": "0x8C8d35429F74ec245F8Ef2f4Fd1e551cFF97d650",
-        "policyId": 2n,
+        "policyId": 6n,
         "restricted": false,
         "updater": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
       }
@@ -397,13 +380,17 @@ describe('watchCreate', () => {
     unwatch()
 
     expect(logs.length).toBe(1)
-    expect(logs[0].args.policyId).toBe(2n)
+    expect(logs[0].args.policyId).toBeDefined()
     expect(logs[0].args.updater).toBe(account.address)
     expect(logs[0].args.type).toBe('whitelist')
   })
 })
 
 describe('watchAdminUpdated', () => {
+  beforeAll(async () => {
+    await fetch(`${rpcUrl}/restart`)
+  })
+
   test('default', async () => {
     // create policy
     const { policyId } = await actions.policy.createSync(client, {
@@ -426,8 +413,7 @@ describe('watchAdminUpdated', () => {
     await setTimeout(500)
     unwatch()
 
-    expect(logs.length).toBe(1)
-    expect(logs[0].args.policyId).toBe(2n)
+    expect(logs[0].args.policyId).toBeDefined()
     expect(logs[0].args.updater).toBe(account.address)
     expect(logs[0].args.admin).toBe(account2.address)
   })
@@ -465,7 +451,7 @@ describe('watchWhitelistUpdated', () => {
     unwatch()
 
     expect(logs.length).toBe(2)
-    expect(logs[0].args.policyId).toBe(2n)
+    expect(logs[0].args.policyId).toBeDefined()
     expect(logs[0].args.updater).toBe(account.address)
     expect(logs[0].args.account).toBe(account2.address)
     expect(logs[0].args.allowed).toBe(true)
@@ -505,7 +491,7 @@ describe('watchBlacklistUpdated', () => {
     unwatch()
 
     expect(logs.length).toBe(2)
-    expect(logs[0].args.policyId).toBe(2n)
+    expect(logs[0].args.policyId).toBeDefined()
     expect(logs[0].args.updater).toBe(account.address)
     expect(logs[0].args.account).toBe(account2.address)
     expect(logs[0].args.restricted).toBe(true)