@pipedream/overledger 0.0.1 → 0.1.0

package/actions/execute-signed-transaction/execute-signed-transaction.mjs

@@ -0,0 +1,35 @@
+import overledger from "../../overledger.app.mjs";
+
+export default {
+  key: "overledger-execute-signed-transaction",
+  name: "Execute Signed Transaction",
+  description: "Executes a signed transaction by sending it to a blockchain node via Overledger. [See the documentation](https://developers.quant.network/reference/executesignedrequest)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    overledger,
+    requestId: {
+      type: "string",
+      label: "Request ID",
+      description: "The ID of the request for executing a signed transaction.",
+    },
+    signedTransaction: {
+      type: "string",
+      label: "Signed Transaction",
+      description: "The signed transaction data.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.overledger.executeSignedTransaction({
+      $,
+      data: {
+        requestId: this.requestId,
+        signedTransaction: this.signedTransaction,
+      },
+    });
+
+    $.export("$summary", `Successfully executed signed transaction with Request ID ${this.requestId}`);
+    return response;
+  },
+};

package/actions/prepare-smart-contract-transaction/prepare-smart-contract-transaction.mjs

@@ -0,0 +1,74 @@
+import {
+  NETWORK_OPTIONS, TECHNOLOGY_OPTIONS,
+} from "../../common/constants.mjs";
+import { parseObject } from "../../common/utils.mjs";
+import overledger from "../../overledger.app.mjs";
+
+export default {
+  key: "overledger-prepare-smart-contract-transaction",
+  name: "Prepare Smart Contract Transaction",
+  description: "Prepares a smart contract transaction for signing on the Overledger platform. [See the documentation](https://developers.quant.network/reference/preparesmartcontractwrite)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    overledger,
+    locationTechnology: {
+      type: "string",
+      label: "Location Technology",
+      description: "The technology of the blockchain that the transaction will be submitted to",
+      options: TECHNOLOGY_OPTIONS,
+      reloadProps: true,
+    },
+    signingAccountId: {
+      type: "string",
+      label: "Signing Account ID",
+      description: "The blockchain account that will sign the transaction.",
+    },
+    functionName: {
+      type: "string",
+      label: "Function Name",
+      description: "The name of the function to call on the smart contract.",
+    },
+    smartContractId: {
+      propDefinition: [
+        overledger,
+        "smartContractId",
+      ],
+    },
+    inputParameters: {
+      type: "string[]",
+      label: "Input Parameters",
+      description: "The input parameters for the smart contract function, in JSON format.",
+      optional: true,
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    if (this.locationTechnology) {
+      props.locationNetwork = {
+        type: "string",
+        label: "Location Network",
+        description: "The blockchain network the transaction will be submitted to.",
+        options: NETWORK_OPTIONS[this.locationTechnology],
+      };
+    }
+    return props;
+  },
+  async run({ $ }) {
+    const response = await this.overledger.prepareSmartContractTransaction({
+      $,
+      data: {
+        location: {
+          technology: this.locationTechnology,
+          network: this.locationNetwork,
+        },
+        signingAccountId: this.signingAccountId,
+        functionName: this.functionName,
+        smartContractId: this.smartContractId,
+        inputParameters: this.inputParameters && parseObject(this.inputParameters),
+      },
+    });
+    $.export("$summary", "Smart contract transaction prepared successfully");
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,52 @@
+export const TECHNOLOGY_OPTIONS = [
+  {
+    label: "Ethereum",
+    value: "ethereum",
+  },
+  {
+    label: "Substrate",
+    value: "substrate",
+  },
+  {
+    label: "XRP Ledger",
+    value: "xrp ledger",
+  },
+  {
+    label: "Bitcoin",
+    value: "bitcoin",
+  },
+  {
+    label: "Hyperledger Fabric",
+    value: "hyperledger fabric",
+  },
+];
+
+export const NETWORK_OPTIONS = {
+  "ethereum": [
+    "ethereum sepolia testnet",
+    "ethereum goerli testnet",
+    "ethereum mainnet",
+    "polygon mumbai testnet",
+    "polygon mainnet",
+    "avalanche fuji testnet",
+    "avalanche c-chain mainnet",
+    "xdc apothem testnet",
+    "xdc network mainnet",
+    "Defined on demand",
+  ],
+  "substrate": [
+    "polkadot westend",
+    "polkadot mainnet",
+  ],
+  "xrp ledger": [
+    "testnet",
+    "mainnet",
+  ],
+  "bitcoin": [
+    "testnet",
+    "mainnet",
+  ],
+  "hyperledger fabric": [
+    "Sandbox",
+  ],
+};

package/common/utils.mjs

@@ -0,0 +1,18 @@
+export const parseObject = (obj) => {
+  if (Array.isArray(obj)) {
+    return obj.map((item) => {
+      if (typeof item === "string") {
+        try {
+          return JSON.parse(item);
+        } catch (e) {
+          return item;
+        }
+      }
+      return item;
+    });
+  }
+  if (typeof obj === "string") {
+    return JSON.parse(obj);
+  }
+  return obj;
+};

package/overledger.app.mjs

@@ -1,11 +1,65 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "overledger",
-  propDefinitions: {},
+  propDefinitions: {
+    smartContractId: {
+      type: "string",
+      label: "Smart Contract ID",
+      description: "The ID of the smart contract to interact with.",
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.overledger.io";
+    },
+    _headers() {
+      return {
+        "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
+        "Content-Type": "application/json",
+        "API-Version": "3.0.0",
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...otherOpts
+    }) {
+      return axios($, {
+        ...otherOpts,
+        url: this._baseUrl() + path,
+        headers: this._headers(),
+      });
+    },
+    prepareSmartContractTransaction(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/api/preparations/transactions/smart-contracts/write",
+        ...opts,
+      });
+    },
+    executeSignedTransaction(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/api/executions/transactions",
+        ...opts,
+      });
+    },
+    createHook({
+      path, ...opts
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/api/webhooks/${path}`,
+        ...opts,
+      });
+    },
+    deleteHook({
+      path, webhookId,
+    }) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/api/webhooks/${path}/${webhookId}`,
+      });
     },
   },
-};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/overledger",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Overledger Components",
   "main": "overledger.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.5.1"
   }
 }

package/sources/common/base.mjs

@@ -0,0 +1,66 @@
+import {
+  NETWORK_OPTIONS, TECHNOLOGY_OPTIONS,
+} from "../../common/constants.mjs";
+import overledger from "../../overledger.app.mjs";
+
+export default {
+  props: {
+    overledger,
+    db: "$.service.db",
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    locationTechnology: {
+      type: "string",
+      label: "Location Technology",
+      description: "The technology of the blockchain that the transaction will be submitted to",
+      options: TECHNOLOGY_OPTIONS,
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    if (this.locationTechnology) {
+      props.locationNetwork = {
+        type: "string",
+        label: "Location Network",
+        description: "The blockchain network the transaction will be submitted to.",
+        options: NETWORK_OPTIONS[this.locationTechnology],
+      };
+    }
+    return props;
+  },
+  hooks: {
+    async activate() {
+      const response = await this.overledger.createHook({
+        path: this.getPath(),
+        data: {
+          location: {
+            technology: this.locationTechnology,
+            network: this.locationNetwork,
+          },
+          callbackUrl: this.http.endpoint,
+          ...this.additionalData(),
+        },
+      });
+      this.db.set("webhookId", response.webhookId);
+    },
+    async deactivate() {
+      const webhookId = this.db.get("webhookId");
+      await this.overledger.deleteHook({
+        path: this.getPath(),
+        webhookId,
+      });
+    },
+  },
+  async run(event) {
+    const { body } = event;
+
+    this.$emit(body, {
+      id: body.transactionId || body?.smartContractEventUpdateDetails?.nativeData?.transactionHash,
+      summary: this.getSummary(body),
+      ts: Date.now(),
+    });
+  },
+};

package/sources/new-contract-event-instant/new-contract-event-instant.mjs

@@ -0,0 +1,35 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "overledger-new-contract-event-instant",
+  name: "New Smart Contract Event (Instant)",
+  description: "Emit new event when a smart contract releases a new event.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    smartContractId: {
+      propDefinition: [
+        common.props.overledger,
+        "smartContractId",
+      ],
+    },
+  },
+  methods: {
+    getPath() {
+      return "smart-contract-events";
+    },
+    additionalData() {
+      return {
+        smartContractId: this.smartContractId,
+      };
+    },
+    getSummary(body) {
+      return `New contract event with transaction Hash: ${body?.smartContractEventUpdateDetails?.nativeData?.transactionHash}`;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-contract-event-instant/test-event.mjs

@@ -0,0 +1,24 @@
+export default {
+  "type": "smartContractEvent",
+  "webhookId": "6c964253-4b10-43a5-a812-9b30e92275a3",
+  "location": {
+    "technology": "ethereum",
+    "network": "polygon mumbai testnet"
+  },
+  "smartContractEventUpdateDetails": {
+    "smartContractId": "0x8590d37d55049de2555f0f9541325e7fe6b19b17",
+    "nativeData": {
+      "removed": false,
+      "logIndex": 0,
+      "transactionIndex": 0,
+      "transactionHash": "0xde2bbf9704d726ff395eb78217e9acb226b0ecb0b609021cccd7e67d99763db2",
+      "blockHash": "0x6d1a13d15fd0a90f361d3e368830bbe45c628382c4533d10f1a23ae699c781cc",
+      "blockNumber": "0x28b2471",
+      "address": "0x8590d37d55049de2555f0f9541325e7fe6b19b17",
+      "data": "0x0000000000000000000000001789d90438333751fdcca0d03d8952168b99ef02",
+      "topics": [
+        "0x2d1801d4e6df986759c8582affebc974bcf0cacfd5d2ab120eb776efa53dffa2"
+      ]
+    }
+  }
+}

package/sources/watch-new-account-event-instant/test-event.mjs

@@ -0,0 +1,10 @@
+export default {  
+  "type": "account",  
+  "webhookId": "20f6ce08-04b4-4ce4-94eb-e2304a0737af",  
+  "accountId": "0x282f70d5af34aedaac479b12a08e189bbee83066",  
+  "location": {  
+    "technology": "ethereum",  
+    "network": "polygon mumbai testnet"  
+  },  
+  "transactionId": "0xd65c16e476a5ad5fa89ffe14512bd7984e575a4370ac86ccfb88202da20f9262"  
+}

package/sources/watch-new-account-event-instant/watch-new-account-event-instant.mjs

@@ -0,0 +1,34 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "overledger-watch-new-account-event-instant",
+  name: "New Account Event (Instant)",
+  description: "Emit new event for transactions to/from a specific account.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    accountId: {
+      type: "string",
+      label: "Account Id",
+      description: "The blockchain account that will be monitored for transaction updates.",
+    },
+  },
+  methods: {
+    getPath() {
+      return "accounts";
+    },
+    additionalData() {
+      return {
+        accountId: this.accountId,
+      };
+    },
+    getSummary(body) {
+      return `New asccount event with transaction Id: ${body.transactionId}`;
+    },
+  },
+  sampleEmit,
+};