Read from a smart contract with Overledger API on Card Due Date Reminder from Pipedream API

Pipedream makes it easy to connect APIs for Overledger, Pipedream and 2,400+ other apps remarkably fast.

Trigger workflow on

Card Due Date Reminder from the Pipedream API

Next, do this

Read from a smart contract with the Overledger API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Pipedream trigger and Overledger action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Card Due Date Reminder trigger
1. Connect your Pipedream account
2. Connect your Pipedream account
3. Select a Board
4. Select a Time Before
Configure the Read from a smart contract action
1. Connect your Overledger account
2. Select a Overledger Instance
3. Select a Location Technology
4. Configure Function Name
5. Optional- Configure Input Parameters
6. Configure Smart Contract ID
7. Optional- Configure Output Parameters
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Card Due Date Reminder on Pipedream

Description:Emit new event at a specified time before a card is due.

Version:0.1.1

Key:trello-card-due-date-reminder

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
import trello from "../../trello.app.mjs";
import ms from "ms";
import constants from "../../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "trello-card-due-date-reminder",
  name: "Card Due Date Reminder", /* eslint-disable-line pipedream/source-name */
  description: "Emit new event at a specified time before a card is due.",
  version: "0.1.1",
  type: "source",
  dedupe: "unique",
  props: {
    pipedream: taskScheduler.props.pipedream,
    trello,
    db: "$.service.db",
    http: "$.interface.http",
    board: {
      propDefinition: [
        trello,
        "board",
      ],
    },
    timeBefore: {
      type: "string",
      label: "Time Before",
      description: "How far before the due time the event should trigger. For example, `5 minutes`, `10 minutes`, `1 hour`.",
      default: "5 minutes",
      options: constants.NOTIFICATION_TIMES,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.timeBefore) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: ms(this.timeBefore) / 1000,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteEvent({
          body: {
            id,
          },
        })) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    generateMeta({
      id, name: summary,
    }, now) {
      return {
        id,
        summary,
        ts: now,
      };
    },
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCardIds() {
      return this.db.get("scheduledCardIds");
    },
    _setScheduledCardIds(ids) {
      this.db.set("scheduledCardIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    emitEvent(card, now) {
      const meta = this.generateMeta(card, now);
      this.$emit(card, meta);
    },
  },
  async run(event) {
    const now = event.timestamp * 1000;

    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe();
    }

    let scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, now);
      return;
    }

    // schedule new events
    const scheduledCardIds = this._getScheduledCardIds() || {};
    const cards = await this.trello.getCards({
      boardId: this.board,
    });

    for (const card of cards) {
      const dueDate = card.due
        ? new Date(card.due)
        : null;
      if (!dueDate || dueDate.getTime() < Date.now()) {
        delete scheduledCardIds[card.id];
        continue;
      }

      const later = new Date(dueDate.getTime() - ms(this.timeBefore));

      if (scheduledCardIds[card.id]) {
        // reschedule if card's due date has changed
        if (card.due !== scheduledCardIds[card.id].dueDate) {
          await this.deleteEvent({
            body: {
              id: scheduledCardIds[card.id].eventId,
            },
          });
          scheduledEventIds = scheduledEventIds
            .filter((id) => id !== scheduledCardIds[card.id].eventId);
        } else {
          continue;
        }
      }

      const scheduledEventId = this.emitScheduleEvent(card, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCardIds[card.id] = {
        eventId: scheduledEventId,
        dueDate: card.due,
      };
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCardIds(scheduledCardIds);
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Pipedream	`trello`	`app`	This component uses the Pipedream app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Board	`board`	`string`	Select a value from the drop down menu.
Time Before	`timeBefore`	`string`	Select a value from the drop down menu:`5 minutes10 minutes15 minutes30 minutes1 hour2 hours3 hours6 hours12 hours1 day2 days3 days1 week`

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

Action#

Read from a smart contract on Overledger

Description:Reads data from a specified smart contract on the Overledger network.

Version:0.0.1

Key:overledger-read-from-a-smart-contract

View on GitHub

Overledger Overview#

The Overledger API by Quant Network allows developers to interact with multiple blockchain networks. It facilitates the creation, reading, and execution of smart contracts and transactions across different blockchains. This API simplifies the complex nature of blockchain interoperability, enabling multi-chain applications (MApps) through a single gateway.

Action Code#

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-a-smart-contract",
  name: "Read from a smart contract",
  description: "Reads data from a specified smart contract on the Overledger network.",
  version: "0.0.1",
  type: "action",
  props: {
    overledger,
    environment: {
      propDefinition: [
        overledger,
        "environment",
      ],
    },
    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",
      description: "The input parameters for the smart contract function, provide both type and value in object format. Example: {\"type\":\"uint256\",\"value\":\"5\"} or {\"type\":\"address\",\"value\":\"0x3....ed8\"}",
      optional: true,
      default: [],
    },
    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: "Each output parameter expected, provide just the type in object format. Example - 1) function returns one uint256 value: {\"type\": \"uint256\"} or 2) function returns two address values: {\"type\": \"address\"},{\"type\": \"address\"}",
      optional: true,
      default: [],
    },
  },
  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), //parse these values using the parseObject function at this shouls turn the JSON string into JSON objects to used in the request body.
      smartContractId: this.smartContractId,
      outputParameters: parseObject(this.outputParameters),
    };
      // Make the API call to Overledger
    const response = await this.overledger.readFromSmartContract({
      $,
      environment: this.environment,
      data: requestBody,
    });
    $.export("$summary", `Successfully read from contract: ${this.smartContractId}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Overledger	`overledger`	`app`	This component uses the Overledger app.
Overledger Instance	`environment`	`string`	Select a value from the drop down menu:`{ "label": "Sandbox", "value": "sandbox" }{ "label": "Overledger", "value": "overledger" }`
Location Technology	`locationTechnology`	`string`	Select a value from the drop down menu:`{ "label": "Ethereum", "value": "ethereum" }{ "label": "Substrate", "value": "substrate" }{ "label": "XRP Ledger", "value": "xrp ledger" }{ "label": "Bitcoin", "value": "bitcoin" }{ "label": "Hyperledger Fabric", "value": "hyperledger fabric" }`
Function Name	`functionName`	`string`	The name of the function to call on the smart contract.
Input Parameters	`inputParameters`	`string[]`	The input parameters for the smart contract function, provide both type and value in object format. Example: {"type":"uint256","value":"5"} or {"type":"address","value":"0x3....ed8"}
Smart Contract ID	`smartContractId`	`string`	The ID/address of the smart contract to interact with.
Output Parameters	`outputParameters`	`string[]`	Each output parameter expected, provide just the type in object format. Example - 1) function returns one uint256 value: {"type": "uint256"} or 2) function returns two address values: {"type": "address"},{"type": "address"}

Action Authentication#

Overledger uses OAuth authentication. When you connect your Overledger account, Pipedream will open a popup window where you can sign into Overledger and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Overledger API.

Pipedream requests the following authorization scopes when you connect your account:

overledger/read.scope

About Overledger#

Overledger Platform. The enterprise standard for building on blockchain.

More Ways to Connect Overledger + Pipedream#

Other Popular Integrations#

Prepare Smart Contract Transaction with Overledger API on New Scheduled Tasks from Pipedream API

Pipedream + Overledger

Read from a smart contract with Overledger API on Card Due Date Reminder from Pipedream API

Pipedream makes it easy to connect APIs for Overledger, Pipedream and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular