← Overledger

Read from a smart contract with Overledger API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Read from a smart contract with the Overledger API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Read from a smart contract with the Overledger API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Read from a smart contract with Overledger API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Overledger
 
Try it
Read from a smart contract with Overledger API on New Submission from Typeform API
Typeform + Overledger
 
Try it
Read from a smart contract with Overledger API on New Submission (Instant) from Jotform API
Jotform + Overledger
 
Try it
Read from a smart contract with Overledger API on New Scheduled Tasks from Pipedream API
Pipedream + Overledger
 
Try it
Read from a smart contract with Overledger API on New Download Counts from npm API
npm + Overledger
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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.
LabelPropTypeDescription
OverledgeroverledgerappThis component uses the Overledger app.
Overledger InstanceenvironmentstringSelect a value from the drop down menu:{ "label": "Sandbox", "value": "sandbox" }{ "label": "Overledger", "value": "overledger" }
Location TechnologylocationTechnologystringSelect 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 NamefunctionNamestring

The name of the function to call on the smart contract.

Input ParametersinputParametersstring[]

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 IDsmartContractIdstring

The ID/address of the smart contract to interact with.

Output ParametersoutputParametersstring[]

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"}

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 Use Overledger

Triggers

New Account Event (Instant) from the Overledger API

Emit new event for transactions to/from a specific account.

 
Try it
New Smart Contract Event (Instant) from the Overledger API

Emit new event when a smart contract releases a new event.

 
Try it

Actions

Execute Signed Transaction with the Overledger API

Executes a signed transaction by sending it to a blockchain node via Overledger. See the documentation

 
Try it
Prepare Smart Contract Transaction with the Overledger API

Prepares a smart contract transaction for signing on the Overledger platform. See the documentation

 
Try it
Sign a transaction with the Overledger API

Sign a transaction using Overledger - Part 2 of Overledger Pattern. See documentation

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.