Overledger New actions added (read from smart contract and sign a transaction) and modification of existing Actions (Prepare and execute transactions) - tied to issue ticket submitted to Pipedream

components/overledger/actions/execute-signed-transaction/execute-signed-transaction.mjs

@@ -11,12 +11,12 @@ export default {
     requestId: {
       type: "string",
       label: "Request ID",
-      description: "The ID of the request for executing a signed transaction.",
+      description: "The Overledger identifier assigned to the related transaction preparation request. This should be set to the requestId parameter found in the response object of the 'Prepare a Smart Contract Transaction' Overledger action.",
     },
     signedTransaction: {
       type: "string",
       label: "Signed Transaction",
-      description: "The signed transaction data.",
+      description: "The raw transaction bytecode after signing. This should be set to the signed parameter found in the response object of the 'Sign a Transaction' Overledger action.",
       optional: true,
     },
   },

components/overledger/actions/prepare-smart-contract-transaction/prepare-smart-contract-transaction.mjs

@@ -22,19 +22,19 @@ export default {
     signingAccountId: {
       type: "string",
       label: "Signing Account ID",
-      description: "The blockchain account that will sign the transaction.",
+      description: "The blockchain account (address) that you will be sending this transaction",
+    },
+    smartContractId: {
+      type: "string",
+      label: "Smart Contract ID",
+      description: "The ID/address of the smart contract to interact with.",
+
     },
     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",
@@ -55,18 +55,20 @@ export default {
     return props;
   },
   async run({ $ }) {
+    const requestBody = {
+      location: {
+        technology: this.locationTechnology,
+        network: this.locationNetwork,
+      },
+      signingAccountId: this.signingAccountId,
+      functionName: this.functionName,
+      smartContractId: this.smartContractId,
+      inputParameters: parseObject(this.inputParameters),
+    };
+
     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),
-      },
+      data: requestBody,
     });
     $.export("$summary", "Smart contract transaction prepared successfully");
     return response;

components/overledger/actions/read-from-a-smart-contract/read-from-smart-contract.mjs

@@ -0,0 +1,76 @@
+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-read-from-smart-contract",
+  name: "Read from Smart Contract",
+  description: "Reads data from a specified smart contract on the Overledger network.",
+  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,
+    },
+    functionName: {
+      type: "string",
+      label: "Function Name",
+      description: "The name of the function to call on the smart contract.",
+    },
+    inputParameters: {
+      type: "string[]",
+      label: "Input Parameters - Stringified Objects",
+      description: "The input parameters for the smart contract function, in JSON string format. Example: `['{\"type\":\"string\",\"value\":\"param1\"}', '{\"type\":\"uint256\",\"value\":\"param2\"}']`",
+      optional: true,
+    },
+    smartContractId: {
+      type: "string",
+      label: "Smart Contract ID",
+      description: "The ID/address of the smart contract to interact with.",
+    },
+    outputParameters: {
+      type: "string[]",
+      label: "Output Parameters",
+      description: "The type of output parameter required e.g., address, string",
+    },
+  },
+  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 requestBody = {
+      location: {
+        technology: this.locationTechnology,
+        network: this.locationNetwork,
+      },
+      functionName: this.functionName,
+      inputParameters: parseObject(this.inputParameters),
+      smartContractId: this.smartContractId,
+      outputParameters: parseObject(this.outputParameters),
+    };
+      // Make the API call to Overledger
+    const response = await this.overledger.readFromSmartContract({
+      $,
+      data: requestBody,
+    });
+    $.export("$summary", `Successfully read from contract: ${this.smartContractId}`);
+    return response;
+  },
+};

components/overledger/actions/sign-a-transaction/sign-a-transaction.mjs

@@ -0,0 +1,72 @@
+import overledger from "../../overledger.app.mjs";
+import { UNIT_OPTIONS } from "../../common/constants.mjs";
+
+export default {
+  key: "overledger-sign-smart-contract-transaction",
+  name: "Sign Smart Contract Transaction",
+  description: "Sign and send a transaction to a smart contract using Overledger",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    overledger,
+    keyId: {
+      type: "string",
+      label: "Signing Account ID",
+      description: "The blockchain account that will sign the transaction.",
+    },
+    requestId: {
+      type: "string",
+      label: "requestId",
+      description: "The ID assigned to a preparation request in Overledger. This should be set to the requestId parameter found in the response object of the 'Prepare Smart Contract Transaction' Overledger action.",
+    },
+    transactionSigningResponderName: {
+      type: "string",
+      label: "Transaction Signing Responder Name",
+      description: "The name of the Transaction Signing Responder you would like to use. The CTA Transaction Signing Responder is the Quant-provided signer for testnet accounts.",
+    },
+    nativeData: {
+      type: "object",
+      label: "Native Data",
+      description: "A JSON object representing the transaction required to be signed.",
+      optional: true,
+      // Reference the output of the previous step
+      default: ({ steps }) => steps.prepare_smart_contract_transaction?.nativeData,
+    },
+  },
+  locationTechnology: {
+    type: "string",
+    label: "Location Technology",
+    description: "The blockchain technology used for this transaction, e.g., ethereum, substrate.",
+    optional: true,
+    // Reference the output of the previous step
+    default: ({ steps }) => steps.prepare_smart_contract_transaction?.locationTechnology,
+  },
+  async run({ $ }) {
+    //default values of gatewayFee and dltfee hard coded into params.
+    const gatewayFee = {
+      amount: "0",
+      unit: "QNT",
+    };
+    // Define DLT Fee and dynamically set the 'unit/symbol' from UNIT_OPTIONS
+    const dltFee = {
+      amount: "0.000019897764079968",
+      unit: UNIT_OPTIONS[this.locationTechnology] || "ETH", // Use default if not found
+    };
+    // Sign the transaction
+    const requestBody = {
+      keyId: this.keyId,
+      gatewayFee: gatewayFee,
+      requestId: this.requestId,
+      dltFee: dltFee,
+      nativeData: this.nativeData,
+      transactionSigningResponderName: this.transactionSigningResponderName,
+    };
+
+    const response = await this.overledger.signTransaction({
+      $,
+      data: requestBody,
+    });
+    $.export("$summary", "Transaction signed successfully");
+    return response;
+  },
+};

components/overledger/common/constants.mjs

@@ -50,3 +50,11 @@ export const NETWORK_OPTIONS = {
     "Sandbox",
   ],
 };
+///unit options to allow for the correct selection based on the location network
+export const UNIT_OPTIONS = {
+  "ethereum": "ETH",               // Ethereum's token symbol is ETH
+  "substrate": "DOT",              // Polkadot's token symbol is DOT
+  "xrp ledger": "XRP",             // XRP Ledger's token symbol is XRP
+  "bitcoin": "BTC",                // Bitcoin's token symbol is BTC
+  "hyperledger fabric": "FAB",     // Placeholder for Hyperledger Fabric's token symbol
+};

components/overledger/overledger.app.mjs

@@ -3,6 +3,24 @@ import { axios } from "@pipedream/platform";
 export default {
   type: "app",
   app: "overledger",
+  props: { //Options to allow for instance selection of Overledger environment - Sanbox or Live Overledger ro determine BaseURL
+    environment: {
+      type: "string",
+      label: "Overledger Instance",
+      description: "Select the Overledger environment.",
+      options: [
+        {
+          label: "Sandbox",
+          value: "sandbox",
+        },
+        {
+          label: "Overledger",
+          value: "overledger",
+        },
+      ],
+      optional: false,
+    },
+  },
   propDefinitions: {
     smartContractId: {
       type: "string",
@@ -11,35 +29,55 @@ export default {
     },
   },
   methods: {
-    _baseUrl() {
-      return "https://api.overledger.io";
-    },
     _headers() {
       return {
         "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
         "Content-Type": "application/json",
         "API-Version": "3.0.0",
       };
     },
+    _getBaseUrl() { //conditional to for environment selection.
+      return this.environment === "sandbox"
+        ? "https://api.sandbox.overledger.io"
+        : "https://api.overledger.io";
+    },
     _makeRequest({
-      $ = this, path, ...otherOpts
+      $ = this, baseUrl, path, ...otherOpts
     }) {
       return axios($, {
         ...otherOpts,
-        url: this._baseUrl() + path,
+        url: baseUrl + path,
         headers: this._headers(),
       });
     },
     prepareSmartContractTransaction(opts = {}) {
       return this._makeRequest({
         method: "POST",
+        baseUrl: this._getBaseUrl(),
         path: "/api/preparations/transactions/smart-contracts/write",
         ...opts,
       });
     },
+    readFromSmartContract(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        baseUrl: this._getBaseUrl(),
+        path: "/api/smart-contracts/read",
+        ...opts,
+      });
+    },
+    signTransaction(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        baseUrl: this._getBaseUrl(),
+        path: "/api/transaction-signing-sandbox",
+        ...opts,
+      });
+    },
     executeSignedTransaction(opts = {}) {
       return this._makeRequest({
         method: "POST",
+        baseUrl: this._getBaseUrl(),
         path: "/api/executions/transactions",
         ...opts,
       });
@@ -49,6 +87,7 @@ export default {
     }) {
       return this._makeRequest({
         method: "POST",
+        baseUrl: this._baseUrl(),
         path: `/api/webhooks/${path}`,
         ...opts,
       });
@@ -58,6 +97,7 @@ export default {
     }) {
       return this._makeRequest({
         method: "DELETE",
+        baseUrl: this._baseUrl(),
         path: `/api/webhooks/${path}/${webhookId}`,
       });
     },

components/overledger/sources/watch-new-account-event-instant/watch-new-account-event-instant.mjs

@@ -27,7 +27,7 @@ export default {
       };
     },
     getSummary(body) {
-      return `New asccount event with transaction Id: ${body.transactionId}`;
+      return `New account event with transaction Id: ${body.transactionId}`;
     },
   },
   sampleEmit,