@avmkit/pipeline
v1.0.3
Published
Class to send transactions to Algorand network with Algo Connect
Downloads
132
Maintainers
Readme
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
<button onclick="connect()">TEST</button>
<script src="https://unpkg.com/@pipeline-ui-2/[email protected]/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 "@avmkit/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
- address (string)
- amt (amount in microalgos, integer)
- myNote (note, string)
- sendingAddress (string)
- wallet (instance of Pipeline.init)
- index (0 = Algorand, otherwise asset index number, integer)