Feature: Add admin governance plugin client

docs/admin.md

@@ -0,0 +1,104 @@
+## Classes
+
+<dl>
+<dt><a href="#AdminClient">AdminClient</a></dt>
+<dd><p>Provides a generic client with high level methods to manage and interact an Admin plugin installed in a DAO</p></dd>
+<dt><a href="#AdminClientEncoding">AdminClientEncoding</a></dt>
+<dd><p>Encoding module for the SDK Admin Client</p></dd>
+<dt><a href="#AdminClientEstimation">AdminClientEstimation</a></dt>
+<dd><p>Estimation module for the SDK Admin Client</p></dd>
+<dt><a href="#AdminClientMethods">AdminClientMethods</a></dt>
+<dd><p>Methods module for the SDK Admin Client</p></dd>
+</dl>
+
+<a name="AdminClient"></a>
+
+## AdminClient
+<p>Provides a generic client with high level methods to manage and interact an Admin plugin installed in a DAO</p>
+
+**Kind**: global class  
+<a name="AdminClient.getPluginInstallItem"></a>
+
+### AdminClient.getPluginInstallItem(addressOrEns) ⇒ <code>\*</code>
+<p>Computes the parameters to be given when creating the DAO,
+so that the plugin is configured</p>
+
+**Kind**: static method of [<code>AdminClient</code>](#AdminClient)  
+**Returns**: <code>\*</code> - <p>{IPluginInstallItem}</p>  
+
+| Param | Type |
+| --- | --- |
+| addressOrEns | <code>string</code> | 
+
+<a name="AdminClientEncoding"></a>
+
+## AdminClientEncoding
+<p>Encoding module for the SDK Admin Client</p>
+
+**Kind**: global class  
+<a name="AdminClientEstimation"></a>
+
+## AdminClientEstimation
+<p>Estimation module for the SDK Admin Client</p>
+
+**Kind**: global class  
+<a name="AdminClientEstimation+executeProposal"></a>
+
+### adminClientEstimation.executeProposal(params) ⇒ <code>\*</code>
+<p>Estimates the gas fee of executing a proposal</p>
+
+**Kind**: instance method of [<code>AdminClientEstimation</code>](#AdminClientEstimation)  
+**Returns**: <code>\*</code> - <p>{Promise<GasFeeEstimation>}</p>  
+
+| Param | Type |
+| --- | --- |
+| params | <code>ExecuteProposalParams</code> | 
+
+<a name="AdminClientMethods"></a>
+
+## AdminClientMethods
+<p>Methods module for the SDK Admin Client</p>
+
+**Kind**: global class  
+
+* [AdminClientMethods](#AdminClientMethods)
+    * [.executeProposal(params)](#AdminClientMethods+executeProposal) ⇒ <code>\*</code>
+    * [.pinMetadata(params)](#AdminClientMethods+pinMetadata) ⇒ <code>\*</code>
+    * [.getProposals()](#AdminClientMethods+getProposals) ⇒ <code>\*</code>
+
+<a name="AdminClientMethods+executeProposal"></a>
+
+### adminClientMethods.executeProposal(params) ⇒ <code>\*</code>
+<p>Executes the given proposal if the user has</p>
+
+**Kind**: instance method of [<code>AdminClientMethods</code>](#AdminClientMethods)  
+**Returns**: <code>\*</code> - <p>{AsyncGenerator<ExecuteProposalStepValue>}</p>  
+
+| Param | Type |
+| --- | --- |
+| params | <code>ExecuteProposalParams</code> | 
+
+<a name="AdminClientMethods+pinMetadata"></a>
+
+### adminClientMethods.pinMetadata(params) ⇒ <code>\*</code>
+<p>Pins a metadata object into IPFS and retruns the generated hash</p>
+
+**Kind**: instance method of [<code>AdminClientMethods</code>](#AdminClientMethods)  
+**Returns**: <code>\*</code> - <p>{Promise<string>}</p>  
+
+| Param | Type |
+| --- | --- |
+| params | <code>ProposalMetadata</code> | 
+
+<a name="AdminClientMethods+getProposals"></a>
+
+### adminClientMethods.getProposals() ⇒ <code>\*</code>
+<p>Returns a list of proposals on the Plugin, filtered by the given criteria</p>
+
+**Kind**: instance method of [<code>AdminClientMethods</code>](#AdminClientMethods)  
+**Returns**: <code>\*</code> - <p>{Promise&lt;AdminProposalListItem[]&gt;}</p>  
+
+| Param | Type |
+| --- | --- |
+|  | <code>IAdminProposalQueryParams</code> | 
+

modules/client/examples/05-client-admin/00-installation.ts

@@ -0,0 +1,58 @@
+/* MARKDOWN
+## Admin governance plugin client
+### Creating a DAO with an admin plugin
+*/
+import {
+  Client,
+  AdminClient,
+  Context,
+  DaoCreationSteps,
+  GasFeeEstimation,
+  ICreateParams,
+} from "@aragon/sdk-client";
+import { contextParams } from "../00-client/00-context";
+
+const context: Context = new Context(contextParams);
+const client: Client = new Client(context);
+
+const adminInstallPluginItem = AdminClient.encoding
+  .getPluginInstallItem("0x1234567890123456789012345678901234567890");
+
+const metadataUri = await client.methods.pinMetadata({
+  name: "My DAO",
+  description: "This is a description",
+  avatar: "",
+  links: [{
+    name: "Web site",
+    url: "https://...",
+  }],
+});
+
+const createParams: ICreateParams = {
+  metadataUri,
+  ensSubdomain: "my-org", // my-org.dao.eth
+  plugins: [adminInstallPluginItem],
+};
+
+// gas estimation
+const estimatedGas: GasFeeEstimation = await client.estimation.create(
+  createParams,
+);
+console.log(estimatedGas.average);
+console.log(estimatedGas.max);
+
+const steps = client.methods.create(createParams);
+for await (const step of steps) {
+  try {
+    switch (step.key) {
+      case DaoCreationSteps.CREATING:
+        console.log(step.txHash);
+        break;
+      case DaoCreationSteps.DONE:
+        console.log(step.address);
+        break;
+    }
+  } catch (err) {
+    console.error(err);
+  }
+}

modules/client/examples/05-client-admin/01-context.ts

@@ -0,0 +1,16 @@
+/* MARKDOWN
+### Create an Admin context
+*/
+import { Context, ContextPlugin } from "@aragon/sdk-client";
+import { Wallet } from "@ethersproject/wallet";
+import { contextParams } from "../00-client/00-context";
+
+const context = new Context(contextParams);
+const contextPlugin: ContextPlugin = ContextPlugin.fromContext(context);
+
+// update
+contextPlugin.set({ network: 1 });
+contextPlugin.set({ signer: new Wallet("other private key") });
+contextPlugin.setFull(contextParams);
+
+console.log(contextPlugin)

modules/client/examples/05-client-admin/02-client.ts

@@ -0,0 +1,12 @@
+/* MARKDOWN
+### Create an Admin client
+*/
+import { AdminClient, Context, ContextPlugin } from "@aragon/sdk-client";
+import { contextParams } from "../00-client/00-context";
+
+const context = new Context(contextParams);
+const contextPlugin: ContextPlugin = ContextPlugin.fromContext(context);
+
+const client = new AdminClient(contextPlugin);
+
+console.log(client);

modules/client/examples/05-client-admin/03-execute-proposal.ts

@@ -0,0 +1,77 @@
+/* MARKDOWN
+### Creating and executing an admin proposal right away
+
+*/
+import {
+  Client,
+  AdminClient,
+  Context,
+  ContextPlugin,
+  ExecuteProposalParams,
+  ExecuteProposalStep,
+  IWithdrawParams,
+  ProposalCreationSteps,
+  ProposalMetadata,
+  VoteValues,
+} from "@aragon/sdk-client";
+import { contextParams } from "../00-client/00-context";
+
+// Create a simple context
+const context: Context = new Context(contextParams);
+// Create a plugin context from the simple context
+const contextPlugin: ContextPlugin = ContextPlugin.fromContext(context);
+// Create an address list client
+const AdminClient = new AdminClient(contextPlugin);
+const client = new Client(context);
+
+const metadata: ProposalMetadata = {
+  title: "Test Proposal",
+  summary: "This is a short description",
+  description: "This is a long description",
+  resources: [
+    {
+      name: "Discord",
+      url: "https://discord.com/...",
+    },
+    {
+      name: "Website",
+      url: "https://website...",
+    },
+  ],
+  media: {
+    logo: "https://...",
+    header: "https://...",
+  },
+};
+
+const ipfsUri = await AdminClient.methods.pinMetadata(metadata);
+
+const withdrawParams: IWithdrawParams = {
+  recipientAddress: "0x1234567890123456789012345678901234567890",
+  amount: BigInt(5),
+};
+const withdrawAction = await client.encoding.withdrawAction(
+  "0x0987654321098765432109876543210987654321",
+  withdrawParams,
+);
+
+const proposalParams: ExecuteProposalParams = {
+  pluginAddress: "0x1234567890123456789012345678901234567890",
+  metadataUri: ipfsUri,
+  actions: [withdrawAction],
+};
+
+const steps = AdminClient.methods.executeProposal(proposalParams);
+for await (const step of steps) {
+  try {
+    switch (step.key) {
+      case ExecuteProposalStep.EXECUTING:
+        console.log(step.txHash);
+        break;
+      case ExecuteProposalStep.DONE:
+        break;
+    }
+  } catch (err) {
+    console.error(err);
+  }
+}

modules/client/examples/05-client-admin/08-get-proposal.ts

@@ -0,0 +1,65 @@
+/* MARKDOWN
+### Loading the a proposal by proposalId (admin plugin)
+*/
+import {
+  AdminProposal,
+  AdminClient,
+  Context,
+  ContextPlugin,
+} from "@aragon/sdk-client";
+import { contextParams } from "../00-client/00-context";
+
+// Create a simple context
+const context: Context = new Context(contextParams);
+// Create a plugin context from the simple context
+const contextPlugin: ContextPlugin = ContextPlugin.fromContext(context);
+// Create an ERC20 client
+const client = new AdminClient(contextPlugin);
+
+const proposalId = "0x12345...";
+
+const proposal: AdminProposal | null = await client.methods.getProposal(
+  proposalId,
+);
+console.log(proposal);
+/*
+{
+  id: "0x12345...",
+  dao: {
+    address: "0x1234567890123456789012345678901234567890",
+    name: "Cool DAO"
+  };
+  creatorAddress: "0x1234567890123456789012345678901234567890",
+  metadata: {
+    title: "Test Proposal",
+    summary: "test proposal summary",
+    description: "this is a long description",
+    resources: [
+      {
+        url: "https://dicord.com/...",
+        name: "Discord"
+      },
+      {
+        url: "https://docs.com/...",
+        name: "Document"
+      }
+    ],
+    media: {
+      header: "https://.../image.jpeg",
+      logo: "https://.../image.jpeg"
+    }
+  };
+  creationDate: <Date>,
+  actions: [
+    {
+      to: "0x12345..."
+      value: 10n
+      data: [12,13,154...]
+    }
+  ],
+  status: "Executed",
+  adminAddress: "0x1234567890123456789012345678901234567890"
+  pluginAddress: "0x1234567890123456789012345678901234567890"
+  proposalId: 0n
+}
+*/