Prepare Smart Contract Transaction with Overledger API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Prepare Smart Contract Transaction with the Overledger API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Create a workflow to Prepare Smart Contract Transaction with the Overledger API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Prepare Smart Contract Transaction action
1. Connect your Overledger account
2. Select a Location Technology
3. Configure Signing Account ID
4. Configure Function Name
5. Configure Smart Contract ID
6. Optional- Configure Input Parameters
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Prepare Smart Contract Transaction with Overledger API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Overledger

Try it

Prepare Smart Contract Transaction with Overledger API on New Submission from Typeform API

Typeform + Overledger

Try it

Prepare Smart Contract Transaction with Overledger API on New Submission (Instant) from Jotform API

Jotform + Overledger

Try it

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

Pipedream + Overledger

Try it

Prepare Smart Contract Transaction with Overledger API on npm 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.

Prepare Smart Contract Transaction on Overledger

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

Key:overledger-prepare-smart-contract-transaction

View on GitHub

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

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
Overledger	`overledger`	`app`	This component uses the Overledger app.
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" }`
Signing Account ID	`signingAccountId`	`string`	The blockchain account that will sign the transaction.
Function Name	`functionName`	`string`	The name of the function to call on the smart contract.
Smart Contract ID	`smartContractId`	`string`	The ID of the smart contract to interact with.
Input Parameters	`inputParameters`	`string[]`	The input parameters for the smart contract function, in JSON format.

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