Refactor API: ForwardingPath descriptions + App intent actions

packages/connect-core/src/connections/ConnectorJson.ts

@@ -4,6 +4,7 @@
 /* eslint-disable @typescript-eslint/explicit-function-return-type */
 
 import { AppFilters, Network, SubscriptionHandler } from '@aragon/connect-types'
+
 import { ConnectionContext } from '../types'
 import IOrganizationConnector from './IOrganizationConnector'
 import App from '../entities/App'

packages/connect-core/src/connections/IOrganizationConnector.ts

@@ -1,4 +1,5 @@
 import { AppFilters, Network, SubscriptionHandler } from '@aragon/connect-types'
+
 import { ConnectionContext } from '../types'
 import App from '../entities/App'
 import Organization from '../entities/Organization'

packages/connect-core/src/entities/Organization.ts

@@ -4,6 +4,7 @@ import {
   AppFiltersParam,
   SubscriptionHandler,
 } from '@aragon/connect-types'
+
 import { ConnectionContext } from '../types'
 import TransactionIntent from '../transactions/TransactionIntent'
 import { toArrayEntry } from '../utils/misc'

packages/connect-core/src/index.ts

@@ -6,6 +6,7 @@ export type {
   Networkish,
   SubscriptionHandler,
 } from '@aragon/connect-types'
+
 export { default as IOrganizationConnector } from './connections/IOrganizationConnector'
 export {
   default as ConnectorJson,

packages/connect-core/src/transactions/TransactionIntent.ts

@@ -1,7 +1,7 @@
 import { ethers } from 'ethers'
 
 import TransactionPath from './TransactionPath'
-import TransactionRequest from './TransactionRequest'
+import Transaction from '../entities/Transaction'
 import Organization from '../entities/Organization'
 import { TransactionIntentData } from '../types'
 import { calculateTransactionPath } from '../utils/path/calculatePath'
@@ -68,7 +68,7 @@ export default class TransactionIntent {
   async transactions(
     account: string,
     options?: { as: string; path?: string[] }
-  ): Promise<TransactionRequest[]> {
+  ): Promise<Transaction[]> {
     return (await this.paths(account, options)).transactions
   }
 }

packages/connect-core/src/transactions/TransactionPath.ts

@@ -1,12 +1,12 @@
-import TransactionRequest from './TransactionRequest'
 import App from '../entities/App'
+import Transaction from '../entities/Transaction'
 import { TransactionPathData } from '../types'
 
 export default class TransactionPath {
   readonly apps!: App[]
   readonly destination!: App
-  readonly forwardingFeePretransaction?: TransactionRequest
-  readonly transactions!: TransactionRequest[]
+  readonly forwardingFeePretransaction?: Transaction
+  readonly transactions!: Transaction[]
 
   constructor(data: TransactionPathData) {
     this.apps = data.apps

packages/connect-core/src/types.ts

@@ -3,7 +3,7 @@ import { Address, Network } from '@aragon/connect-types'
 
 import IOrganizationConnector from './connections/IOrganizationConnector'
 import App from './entities/App'
-import TransactionRequest from './transactions/TransactionRequest'
+import Transaction from './entities/Transaction'
 
 export type Abi = (ethers.utils.EventFragment | ethers.utils.FunctionFragment)[]
 
@@ -100,8 +100,8 @@ export interface RoleData {
 export interface TransactionPathData {
   apps: App[]
   destination: App
-  forwardingFeePretransaction?: TransactionRequest
-  transactions: TransactionRequest[]
+  forwardingFeePretransaction?: Transaction
+  transactions: Transaction[]
 }
 
 export interface TransactionIntentData {
@@ -110,13 +110,10 @@ export interface TransactionIntentData {
   functionArgs: any[]
 }
 
-export interface TransactionRequestData {
-  children?: TransactionRequest[]
-  description?: string
-  descriptionAnnotated?: Annotation[]
+export interface TransactionData {
   data: string
-  from?: string
-  to: string
+  from: Address
+  to: Address
 }
 
 ////// METADATA //////

packages/connect-core/src/utils/app.ts

@@ -1,7 +1,8 @@
 import { ethers } from 'ethers'
 
-import { AppIntent, TransactionRequestData } from '../types'
+import { AppIntent } from '../types'
 import App from '../entities/App'
+import Transaction from '../entities/Transaction'
 
 export const apmAppId = (appName: string): string =>
   ethers.utils.namehash(`${appName}.aragonpm.eth`)
@@ -49,7 +50,7 @@ export function validateMethod(
  */
 export function findAppMethodFromIntent(
   app: App,
-  transaction: TransactionRequestData
+  transaction: Transaction
 ): AppIntent | undefined {
   const methodId = transaction.data.substring(0, 10)
 

packages/connect-core/src/utils/callScript.ts

@@ -2,7 +2,7 @@ import { ethers } from 'ethers'
 
 export const CALLSCRIPT_ID = '0x00000001'
 
-interface CallScriptAction {
+export interface CallScriptAction {
   to: string
   data: string
 }

packages/connect-core/src/utils/descriptions.ts

@@ -1,7 +1,7 @@
 import { ethers } from 'ethers'
 
 import App from '../entities/App'
-import TransactionRequest from '../transactions/TransactionRequest'
+import Transaction from '../entities/Transaction'
 import {
   decodeTransactionPath,
   TransactionWithChildren,
@@ -15,7 +15,7 @@ export async function describeTransaction(
   transaction: TransactionWithChildren,
   apps: App[],
   provider?: ethers.providers.Provider
-): Promise<TransactionRequest> {
+): Promise<Transaction> {
   if (!transaction.to) {
     throw new Error(`Could not describe transaction: missing 'to'`)
   }
@@ -44,7 +44,7 @@ export async function describeTransaction(
     throw new Error(`Could not describe transaction: ${err}`)
   }
 
-  return new TransactionRequest({
+  return new Transaction({
     ...transaction,
     description,
     descriptionAnnotated,
@@ -59,7 +59,7 @@ export async function describeTransactionPath(
   path: TransactionWithChildren[],
   apps: App[],
   provider?: ethers.providers.Provider
-): Promise<TransactionRequest[]> {
+): Promise<Transaction[]> {
   return Promise.all(
     path.map((step) => describeTransaction(step, apps, provider))
   )
@@ -69,7 +69,7 @@ export async function describeScript(
   script: string,
   apps: App[],
   provider?: ethers.providers.Provider
-): Promise<TransactionRequest[]> {
+): Promise<Transaction[]> {
   const path = decodeTransactionPath(script)
 
   return describeTransactionPath(path, apps, provider)

packages/connect-core/src/utils/network.ts

@@ -1,4 +1,5 @@
 import { Address, Network, Networkish } from '@aragon/connect-types'
+
 import { NETWORKS } from '../params'
 
 export function networkFromChainId(chainId: number): Network | null {

packages/connect-core/src/utils/path/calculatePath.ts

@@ -2,12 +2,12 @@ import { ethers } from 'ethers'
 
 import { AppIntent } from '../../types'
 import App from '../../entities/App'
+import Transaction from '../../entities/Transaction'
 import { addressesEqual, includesAddress, ANY_ENTITY } from '../address'
 import { isFullMethodSignature } from '../app'
 import { encodeCallScript } from '../callScript'
 import { canForward } from '../forwarding'
 import {
-  Transaction,
   createDirectTransactionForApp,
   createForwarderTransactionBuilder,
   buildForwardingFeePretransaction,

packages/connect-core/src/utils/path/decodePath.ts

@@ -1,8 +1,7 @@
-import { isCallScript, decodeCallScript } from '../callScript'
+import { isCallScript, decodeCallScript, CallScriptAction } from '../callScript'
 import { isValidForwardCall, parseForwardCall } from '../forwarding'
-import { Transaction } from '../transactions'
 
-export interface TransactionWithChildren extends Transaction {
+export interface TransactionWithChildren extends CallScriptAction {
   children?: TransactionWithChildren[]
 }
 
@@ -25,7 +24,7 @@ export function decodeTransactionPath(
   return path.reduce((decodeSegments, segment) => {
     const { data } = segment
 
-    let children
+    let children: TransactionWithChildren[] = []
     if (isValidForwardCall(data)) {
       const forwardedEvmScript = parseForwardCall(data)
 

packages/connect-core/src/utils/radspec/index.ts

@@ -4,7 +4,8 @@ import * as radspec from 'radspec'
 import { addressesEqual } from '../address'
 import { findAppMethodFromIntent } from '../app'
 import App from '../../entities/App'
-import { Abi, AppIntent, TransactionRequestData } from '../../types'
+import Transaction from '../../entities/Transaction'
+import { Abi, AppIntent } from '../../types'
 
 interface FoundMethod {
   method?: AppIntent
@@ -15,7 +16,7 @@ interface FoundMethod {
  * Attempt to describe intent via radspec.
  */
 export async function tryEvaluatingRadspec(
-  intent: TransactionRequestData,
+  intent: Transaction,
   apps: App[],
   provider?: ethers.providers.Provider // Decorated intent with description, if one could be made
 ): Promise<string> {