Refactor Transactions Revenue

CHANGELOG.md

@@ -42,3 +42,4 @@ Ref: https://keepachangelog.com/en/1.0.0/
 - (transactions)[#117](https://github.com/evmos/evmosjs/pull/117) Refactor Transactions `ERC-20` module using base infrastructure and add unit tests
 - (transactions)[#118](https://github.com/evmos/evmosjs/pull/118) Refactor Transactions `Gov` module using base infrastructure and add unit tests
 - (transactions)[#119](https://github.com/evmos/evmosjs/pull/119) Refactor Transactions `IBC` module using base infrastructure and add unit tests
+- (transactions)[#120](https://github.com/evmos/evmosjs/pull/120) Refactor Transactions `Revenue` module using base infrastructure and add unit tests

docs/transactions/revenue/README.md

@@ -0,0 +1,86 @@
+# Revenue
+
+This package creates transaction payloads with messages from the [Revenue Module](https://docs.evmos.org/modules/revenue/).
+
+Find the `TxContext` and `TxPayload` types in the Transaction Docs.
+
+### MsgCancelRevenue
+
+```ts
+export interface MsgCancelRevenueParams {
+  contractAddress: string
+  deployerAddress: string
+}
+
+/**
+ * Creates a transaction for a `MsgCancelRevenue` object.
+ *
+ * @remarks
+ * This method creates a transaction wrapping the Evmos
+ * {@link https://docs.evmos.org/modules/revenue/04_transactions.html#msgcancelrevenue | MsgCancelRevenue}
+ *
+ * @param context - Transaction Context
+ * @param params - MsgCancelRevenue Params
+ * @returns Transaction with the MsgCancelRevenue payload
+ *
+ */
+export const createTxMsgCancelRevenue: (
+  context: TxContext,
+  params: MsgCancelRevenueParams,
+): TxPayload 
+```
+
+### MsgRegisterRevenue
+
+```ts
+export interface MsgRegisterRevenueParams {
+  contractAddress: string
+  deployerAddress: string
+  withdrawerAddress: string
+  nonces: number[]
+}
+
+/**
+ * Creates a transaction for a `MsgRegisterRevenue` object.
+ *
+ * @remarks
+ * This method creates a transaction wrapping the Evmos
+ * {@link https://docs.evmos.org/modules/revenue/04_transactions.html#msgregisterrevenue | MsgRegisterRevenue}
+ *
+ * @param context - Transaction Context
+ * @param params - MsgRegisterRevenue Params
+ * @returns Transaction with the MsgRegisterRevenue payload
+ *
+ */
+export const createTxMsgRegisterRevenue: (
+  context: TxContext,
+  params: MsgRegisterRevenueParams,
+): TxPayload
+```
+
+### MsgUpdateRevenue
+
+```ts
+export interface MsgUpdateRevenueParams {
+  contractAddress: string
+  deployerAddress: string
+  withdrawerAddress: string
+}
+
+/**
+ * Creates a transaction for a `MsgUpdateRevenue` object.
+ *
+ * @remarks
+ * This method creates a transaction wrapping the Evmos
+ * {@link https://docs.evmos.org/modules/revenue/04_transactions.html#msgupdaterevenue | MsgUpdateRevenue}
+ *
+ * @param context - Transaction Context
+ * @param params - MsgUpdateRevenue Params
+ * @returns Transaction with the MsgUpdateRevenue payload
+ *
+ */
+export const createTxMsgUpdateRevenue: (
+  context: TxContext,
+  params: MsgUpdateRevenueParams,
+): TxPayload 
+```

packages/transactions/src/index.ts

@@ -1,14 +1,12 @@
 export * from './messages/authz'
 export * from './messages/bank'
+export * from './messages/common'
 export * from './messages/erc20'
 export * from './messages/gov'
 export * from './messages/ibc'
-export * from './messages/revenue/msgCancelRevenue'
-export * from './messages/revenue/msgUpdateRevenue'
-export * from './messages/revenue/msgRegisterRevenue'
+export * from './messages/revenue'
 export * from './messages/vesting/msgCreateClawbackVestingAccount'
 export * from './messages/vesting/msgClawback'
-export * from './messages/common'
 export * from './messages/staking'
 export * from './messages/txRaw'
 export * from './messages/validator'

packages/transactions/src/messages/base.ts

@@ -92,9 +92,9 @@ const createCosmosPayload = (
  * Creates a signable transaction with SignDirect,
  * LegacyAmino, and EIP-712 components.
  *
- * @param context Transaction Context
- * @param typedData EIP-712 Typed Data
- * @param cosmosMessage Cosmos SDK Message to sign
+ * @param context - Transaction Context
+ * @param typedData - EIP-712 Typed Data
+ * @param cosmosMessage - Cosmos SDK Message to sign
  * @returns Signable Payload
  *
  */

packages/transactions/src/messages/revenue/cancelRevenue.spec.ts

@@ -0,0 +1,48 @@
+import { createMsgCancelRevenue as protoMsgCancelRevenue } from '@evmos/proto'
+import {
+  generateTypes,
+  createMsgCancelRevenue,
+  MSG_CANCEL_REVENUE_TYPES,
+} from '@evmos/eip712'
+import {
+  MsgCancelRevenueParams,
+  createTxMsgCancelRevenue,
+} from './cancelRevenue'
+import { createTransactionPayload } from '../base'
+import TestUtils from '../../tests/utils'
+
+const { context } = TestUtils
+const contractAddress = TestUtils.addrHex1
+const deployerAddress = context.sender.accountAddress
+
+const params: MsgCancelRevenueParams = {
+  contractAddress,
+  deployerAddress,
+}
+
+describe('test tx payload', () => {
+  it('produces tx payloads as expected', () => {
+    const types = generateTypes(MSG_CANCEL_REVENUE_TYPES)
+    const message = createMsgCancelRevenue(
+      params.contractAddress,
+      params.deployerAddress,
+    )
+    const typedData = {
+      types,
+      message,
+    }
+
+    const messageCosmos = protoMsgCancelRevenue(
+      params.contractAddress,
+      params.deployerAddress,
+    )
+
+    const payload = createTxMsgCancelRevenue(context, params)
+    const expectedPayload = createTransactionPayload(
+      context,
+      typedData,
+      messageCosmos,
+    )
+    expect(payload).toStrictEqual(expectedPayload)
+  })
+})

packages/transactions/src/messages/revenue/cancelRevenue.ts

@@ -0,0 +1,53 @@
+import { createMsgCancelRevenue as protoMsgCancelRevenue } from '@evmos/proto'
+
+import {
+  generateTypes,
+  createMsgCancelRevenue,
+  MSG_CANCEL_REVENUE_TYPES,
+} from '@evmos/eip712'
+import { createTransactionPayload, TxContext } from '../base'
+
+export interface MsgCancelRevenueParams {
+  contractAddress: string
+  deployerAddress: string
+}
+
+const createEIP712MsgCancelRevenue = (params: MsgCancelRevenueParams) => {
+  const types = generateTypes(MSG_CANCEL_REVENUE_TYPES)
+
+  const message = createMsgCancelRevenue(
+    params.contractAddress,
+    params.deployerAddress,
+  )
+
+  return {
+    types,
+    message,
+  }
+}
+
+const createCosmosMsgCancelRevenue = (params: MsgCancelRevenueParams) => {
+  return protoMsgCancelRevenue(params.contractAddress, params.deployerAddress)
+}
+
+/**
+ * Creates a transaction for a `MsgCancelRevenue` object.
+ *
+ * @remarks
+ * This method creates a transaction wrapping the Evmos
+ * {@link https://docs.evmos.org/modules/revenue/04_transactions.html#msgcancelrevenue | MsgCancelRevenue}
+ *
+ * @param context - Transaction Context
+ * @param params - MsgCancelRevenue Params
+ * @returns Transaction with the MsgCancelRevenue payload
+ *
+ */
+export const createTxMsgCancelRevenue = (
+  context: TxContext,
+  params: MsgCancelRevenueParams,
+) => {
+  const typedData = createEIP712MsgCancelRevenue(params)
+  const cosmosMsg = createCosmosMsgCancelRevenue(params)
+
+  return createTransactionPayload(context, typedData, cosmosMsg)
+}

packages/transactions/src/messages/revenue/index.ts

@@ -0,0 +1,3 @@
+export * from './cancelRevenue'
+export * from './registerRevenue'
+export * from './updateRevenue'