Sign a transaction with Overledger API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Sign a transaction 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#

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

Configure the Sign a transaction action
1. Connect your Overledger account
2. Select a Overledger Instance
3. Select a Location Technology
4. Configure Signing Account ID
5. Configure Request ID
6. Configure Transaction Signing Responder Name
7. Configure Native Data
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#

Sign a transaction with Overledger API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Overledger

Try it

Sign a transaction with Overledger API on New Submission from Typeform API

Typeform + Overledger

Try it

Sign a transaction with Overledger API on New Submission (Instant) from Jotform API

Jotform + Overledger

Try it

Sign a transaction with Overledger API on New Scheduled Tasks from Pipedream API

Pipedream + Overledger

Try it

Sign a transaction 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.

Sign a transaction on Overledger

Description:Sign a transaction using Overledger - Part 2 of [Overledger Pattern](https://developers.quant.network/reference/overledger-pattern). [See documentation](https://developers.quant.network/reference/sandboxsigning)

Version:0.0.1

Key:overledger-sign-a-transaction

View on GitHub

Code#

import overledger from "../../overledger.app.mjs";
import { TECHNOLOGY_OPTIONS, UNIT_OPTIONS } from "../../common/constants.mjs";

export default {
  key: "overledger-sign-a-transaction",
  name: "Sign a transaction",
  description: "Sign a transaction using Overledger - Part 2 of [Overledger Pattern](https://developers.quant.network/reference/overledger-pattern). [See documentation](https://developers.quant.network/reference/sandboxsigning)",
  version: "0.0.1",
  type: "action",
  props: {
    overledger,
    environment: {
      propDefinition: [
        overledger,
        "environment",
      ],
    },
    locationTechnology: {
      type: "string",
      label: "Location Technology",
      description: "The blockchain technology used for this transaction, e.g., ethereum, substrate - required in order to set the dltfee",
      options: TECHNOLOGY_OPTIONS,
      reloadProps: true,
    },
    keyId: {
      type: "string",
      label: "Signing Account ID",
      description: "The ID/address of the blockchain account that will sign the transaction.",
    },
    requestId: {
      type: "string",
      label: "Request ID",
      description: "The Request ID assigned to a preparation request in Overledger. This should be set to the requestId parameter found in the response object of the 'Prepare 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: "An object representing the transaction required to be signed - This should be set to the nativeData object of the 'Prepare Transaction' Overledger action.",
    },
  },
  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({
      $,
      environment: this.environment,
      data: requestBody,
    });
    $.export("$summary", "Transaction signed 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.
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" }`
Signing Account ID	`keyId`	`string`	The ID/address of the blockchain account that will sign the transaction.
Request ID	`requestId`	`string`	The Request ID assigned to a preparation request in Overledger. This should be set to the requestId parameter found in the response object of the 'Prepare Transaction' Overledger action.
Transaction Signing Responder Name	`transactionSigningResponderName`	`string`	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.
Native Data	`nativeData`	`object`	An object representing the transaction required to be signed - This should be set to the nativeData object of the 'Prepare Transaction' Overledger 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