topofocus / pipeline

Pipeline Algorand Connector

Home Page:pipeline-example.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pipeline Algorand Connector

A work-in-progress JavaScript class to streamline the process of using MyAlgo Connect, WalletConnect and AlgoSigner to sign and send transactions to the Algorand network.

Usage

Running the included example

cd example
npm install
npm run start

Use as <script>

<button onclick="connect()">TEST</button>

<script src="https://unpkg.com/@pipeline-ui-2/pipeline@1.3.4/dist/index.js"></script>

<script>
    const Pipeline = window.pipeline
    const wallet = Pipeline.init()
    function connect(){
        Pipeline.connect(wallet).then(data => {
            console.log(data)
        })
    }
</script>

Install via npm:

npm install @pipeline-ui-2/pipeline

Import the class into your project:

import Pipeline from "@pipeline-ui-2/pipeline";

Initialize Pipeline:

const myAlgoWallet = Pipeline.init();

Connect to MyAlgo (returns first address in wallet):

Pipeline.connect(myAlgoWallet)
    .then(data => {
        console.log(data);
    });

Connect to AlgoSigner (returns first address in wallet):

Pipeline.pipeConnector = "AlgoSigner";
Pipeline.connect()
    .then(data => {
        console.log(data);
    });

Send a transaction (returns transaction id):

send(address, amt, myNote, sendingAddress, wallet, index = 0)
    .then(data => {
        console.log(data);
    });

Pipeline.send Arguments

  1. address (string)
  2. amt (amount in microalgos, integer)
  3. myNote (note, string)
  4. sendingAddress (string)
  5. wallet (instance of Pipeline.init)
  6. index (0 = Algorand, otherwise asset index number, integer)

About

Pipeline Algorand Connector

pipeline-example.vercel.app

License:MIT License


Languages

Language:JavaScript 86.5%Language:HTML 11.3%Language:CSS 2.2%