Fix: solve metadata for Roles + TransactionRequest#children (#121)

docs/api-reference/transaction-request.md

@@ -6,9 +6,9 @@ An object describing a transaction that can be signed by a library like [ethers.
 
 | Name | Type | Description |
 | :--- | :--- | :--- |
+| `children` | `TransactionRequest[]` | List of the next transactions in the path. |
 | `descriptionAnnotated` | `Annotation[]` | List of the Radspec description bindings with the properties `{ type: string, value: any }`. |
 | `description` | `string` | Radspec description for the transaction. |
 | `data` | `String` | Transaction data. |
 | `from` | `String` | Address to use as default sender. |
 | `to` | `String` | Target address or ENS name. |
-

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

@@ -8,13 +8,8 @@ import {
   Abi,
   AppIntent,
 } from '../types'
-import { resolveMetadata } from '../utils/metadata'
+import { resolveManifest, resolveArtifact } from '../utils/metadata'
 import { ConnectorInterface } from '../connections/ConnectorInterface'
-import {
-  getApmInternalAppInfo,
-  getAragonOsInternalAppInfo,
-} from '../utils/overrides/index'
-import { hasAppInfo } from '../utils/overrides/interfaces'
 
 // TODO:
 // [ ] (ipfs) contentUrl 	String 	The HTTP URL of the app content. Uses the IPFS HTTP provider. E.g. http://gateway.ipfs.io/ipfs/QmdLEDDfi…/ (ContentUri passing through the resolver)
@@ -78,24 +73,8 @@ export default class App extends CoreEntity {
     data: AppData,
     connector: ConnectorInterface
   ): Promise<App> {
-    let artifact: AragonArtifact
-    if (hasAppInfo(data.appId, 'apm')) {
-      artifact = getApmInternalAppInfo(data.appId)
-    } else if (hasAppInfo(data.appId, 'aragon')) {
-      artifact = getAragonOsInternalAppInfo(data.appId)
-    } else {
-      artifact = await resolveMetadata(
-        'artifact.json',
-        data.contentUri || undefined,
-        data.artifact
-      )
-    }
-
-    const manifest: AragonManifest = await resolveMetadata(
-      'manifest.json',
-      data.contentUri || undefined,
-      data.manifest
-    )
+    const artifact = await resolveArtifact(data)
+    const manifest = await resolveManifest(data)
 
     const metadata: Metadata = [artifact, manifest]
 

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

@@ -108,6 +108,11 @@ export default class Organization {
     return this.#address || '' // The || '' should never happen but TypeScript requires it.
   }
 
+  get provider(): ethers.providers.Provider {
+    this.checkConnected()
+    return this.#provider
+  }
+
   ///////// APPS ///////////
 
   async app(filters?: AppFiltersParam): Promise<App> {

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

@@ -5,7 +5,7 @@ import {
   Metadata,
   AragonArtifactRole,
 } from '../types'
-import { resolveMetadata } from '../utils/metadata'
+import { resolveMetadata, resolveManifest } from '../utils/metadata'
 import { ConnectorInterface } from '../connections/ConnectorInterface'
 
 export interface RepoData {
@@ -46,17 +46,12 @@ export default class Repo extends CoreEntity {
     data: RepoData,
     connector: ConnectorInterface
   ): Promise<Repo> {
-    const artifact: AragonArtifact = await resolveMetadata(
+    const artifact = await resolveMetadata(
       'artifact.json',
       data.contentUri || undefined,
       data.artifact
     )
-
-    const manifest: AragonManifest = await resolveMetadata(
-      'manifest.json',
-      data.contentUri || undefined,
-      data.manifest
-    )
+    const manifest = await resolveManifest(data)
 
     const metadata: Metadata = [artifact, manifest]
 

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

@@ -1,11 +1,12 @@
 import CoreEntity from './CoreEntity'
 import Permission, { PermissionData } from './Permission'
 import { AragonArtifact, Metadata } from '../types'
-import { resolveMetadata } from '../utils/metadata'
+import { resolveArtifact } from '../utils/metadata'
 import { ConnectorInterface } from '../connections/ConnectorInterface'
 
 export interface RoleData {
   appAddress: string
+  appId: string
   artifact?: string | null
   contentUri?: string | null
   hash: string
@@ -15,6 +16,7 @@ export interface RoleData {
 
 export default class Role extends CoreEntity {
   readonly appAddress!: string
+  readonly appId!: string
   readonly description?: string
   readonly hash!: string
   readonly params?: string[]
@@ -31,7 +33,7 @@ export default class Role extends CoreEntity {
 
     const { roles } = metadata[0] as AragonArtifact
 
-    const role = roles.find(role => role.bytes === data.hash)
+    const role = roles?.find(role => role.bytes === data.hash)
 
     this.appAddress = data.appAddress
     this.description = role?.name
@@ -48,11 +50,7 @@ export default class Role extends CoreEntity {
     data: RoleData,
     connector: ConnectorInterface
   ): Promise<Role> {
-    const artifact: AragonArtifact = await resolveMetadata(
-      'artifact.json',
-      data.contentUri || undefined,
-      data.artifact
-    )
+    const artifact = await resolveArtifact(data)
 
     const metadata: Metadata = [artifact]
 

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

@@ -12,16 +12,16 @@ export interface Annotation {
   value: any
 }
 
-// TODO: Handle children
-
 export default class TransactionRequest {
+  readonly children?: TransactionRequest[]
   readonly description?: string
   readonly descriptionAnnotated?: Annotation[]
   readonly data!: string
   readonly from?: string
   readonly to!: string
 
   constructor(data: TransactionRequestData) {
+    this.children = data.children
     this.description = data.description
     this.descriptionAnnotated = data.descriptionAnnotated
     this.data = data.data

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

@@ -40,9 +40,9 @@ export async function describeTransaction(
         provider
       )
     }
-
-    // eslint-disable-next-line no-empty
-  } catch (_) {}
+  } catch (err) {
+    throw new Error(`Could not describe transaction: ${err}`)
+  }
 
   return new TransactionRequest({
     ...transaction,

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

@@ -1,6 +1,15 @@
 import { ethers } from 'ethers'
 
+import { AppData } from '../entities/App'
+import { RepoData } from '../entities/Repo'
+import { RoleData } from '../entities/Role'
+import {
+  getApmInternalAppInfo,
+  getAragonOsInternalAppInfo,
+  hasAppInfo,
+} from './overrides/index'
 import { DEFAULT_IPFS_GATEWAY } from '../params'
+import { AragonArtifact, AragonManifest } from '../types'
 
 export function parseMetadata(name: string, metadata: string): any {
   let parsedMetaData
@@ -39,3 +48,29 @@ export async function resolveMetadata(
   if (contentUri) return fetchMetadata(fileName, contentUri)
   return {}
 }
+
+export async function resolveManifest(
+  data: AppData | RepoData
+): Promise<AragonManifest> {
+  return resolveMetadata(
+    'manifest.json',
+    data.contentUri || undefined,
+    data.manifest
+  )
+}
+
+export async function resolveArtifact(
+  data: AppData | RoleData
+): Promise<AragonArtifact> {
+  if (hasAppInfo(data.appId, 'apm')) {
+    return getApmInternalAppInfo(data.appId)
+  }
+  if (hasAppInfo(data.appId, 'aragon')) {
+    return getAragonOsInternalAppInfo(data.appId)
+  }
+  return resolveMetadata(
+    'artifact.json',
+    data.contentUri || undefined,
+    data.artifact
+  )
+}

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

@@ -8,3 +8,5 @@ export function getAragonOsInternalAppInfo(appId: string): AragonArtifact {
 export function getApmInternalAppInfo(appId: string): AragonArtifact {
   return getAppInfo(appId, 'apm')
 }
+
+export { hasAppInfo, getAppInfo } from './interfaces'

packages/connect-thegraph/src/parsers/roles.ts

@@ -1,12 +1,7 @@
 import { Role, RoleData, PermissionData } from '@aragon/connect-core'
 import { QueryResult } from '../types'
 
-async function _parseRole(
-  role: any,
-  connector: any,
-  contentUri: string | null,
-  artifact?: string | null
-): Promise<Role> {
+async function _parseRole(role: any, app: any, connector: any): Promise<Role> {
   const grantees =
     role?.grantees &&
     role?.grantees.map(
@@ -33,8 +28,9 @@ async function _parseRole(
     manager: role.manager,
     hash: role.roleHash,
     grantees,
-    artifact,
-    contentUri,
+    appId: app.appId,
+    artifact: app.version?.artifact,
+    contentUri: app?.contentUri,
   }
 
   return Role.create(roleData, connector)
@@ -51,7 +47,7 @@ export async function parseRole(
     throw new Error('Unable to parse role.')
   }
 
-  return _parseRole(role, connector, app?.contentUri, app.version?.artifact)
+  return _parseRole(role, app, connector)
 }
 
 export async function parseRoles(
@@ -67,7 +63,7 @@ export async function parseRoles(
 
   return Promise.all(
     roles.map(async (role: any) => {
-      return _parseRole(role, connector, app?.contentUri, app.version?.artifact)
+      return _parseRole(role, app, connector)
     })
   )
 }