Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/energychain/node-red-contrib-smartcontracttx
Allows to run transactions on Ethereum based blockchains from within Node RED
https://github.com/energychain/node-red-contrib-smartcontracttx
did ethereum node-red
Last synced: 7 days ago
JSON representation
Allows to run transactions on Ethereum based blockchains from within Node RED
- Host: GitHub
- URL: https://github.com/energychain/node-red-contrib-smartcontracttx
- Owner: energychain
- License: apache-2.0
- Created: 2021-12-28T12:11:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T05:42:59.000Z (almost 2 years ago)
- Last Synced: 2023-12-15T05:45:02.773Z (11 months ago)
- Topics: did, ethereum, node-red
- Language: JavaScript
- Homepage:
- Size: 1.04 MB
- Stars: 4
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-red-contrib-smartcontracttx
**Allows to run transactions on Ethereum based blockchains from within Node RED**
Call methods or run transactions using rpcUrl and ABI of existing contract. Allows OffChain DID/VP signing and verification.
[](https://www.npmjs.com/package/node-red-contrib-smartcontracttx)
[](https://www.npmjs.com/package/node-red-contrib-smartcontracttx)
[](https://co2offset.io/badge.html?host=node-red-contrib-smartcontracttx)[](https://app.codiga.io/public/project/30556/node-red-contrib-smartcontracttx/dashboard)[](https://circleci.com/gh/energychain/node-red-contrib-smartcontracttx/tree/main)[](https://app.fossa.com/projects/git%2Bgithub.com%2Fenergychain%2Fnode-red-contrib-smartcontracttx?ref=badge_shield)
## Installation
Install using Node-RED Package Manager (Palett).
## Input - msg.payload
### OnChain - Transaction/Retrieve
In order to call a method of a SmartContract specify a JSON in `msg.payload` containing the method name as `method` and all required arguments in an array as `args`.
```javascript
{
"method":"transfer",
"args":["0x6B342cE1cb8671DDeeC57B62D78EB9333898d7da",20]
}
```
### OffChain - Present
To present a set of information (Object) signed to another party DID-VPs are used. In this case `msg.payload` must contain `presentTo` with the recipients publicKey (not address - [see here](https://ethereum.stackexchange.com/questions/13778/get-public-key-of-any-ethereum-account/79174) ) and `presentation` with the Data to crypt and sign.
```javascript
{
"presentTo":"0x02eb74c1b28754e079ac138f0d1d73c0b9d82ba2a14ea3146f7f540e841ee43679",
"presentation":{
'Hello':'World',
'TimeStamp': 1641166171599
}
}
```
If `presentTo` is not specified the presentation itself will just be signed and not encrypted.
### Injection of unsecure values
If configuration option `Allow Insecure Inject` is set additional values might be specified in input `msg.payload` and will overwrite configured values:
```javascript
{
...
"privateKey":"0x12356....",
"contract":"0x123456...",
"abi": [...],
"rpcUrl": "https://integration.corrently.io/",
...
}
```
In case no privateKey is specified in either input msg.payload or configuration, a new privateKey gets generated.
## Output - msg.payload
For background compatibility all results are returned on `Output[0]`
`Output[1]` - OnChain Output. Returns results from method calls or transactions.
`Output[2]` - OffChain Output (JWT). Encrypted DID to be forwarded to other recipient.
`Output[3]` - OffChain Output. Presentations received and decoded.
## Cloudwallet support
Implementation allows to use [CloudWallet](https://rapidapi.com/stromdao-stromdao-default/api/cloudwallet) to persist received presentations/credentials or digital IDs via https://www.npmjs.com/package/cloudwallet
## Usage as Module (no Node-RED)
You might use this module without having Node-RED available. However this requires to *emulate* some of the stuff Node-RED typically provides.
### Installation
```
npm i --save node-red-contrib-smartcontracttx
```
### Hello World (DID)
```javascript
const SmartContractTX = require("node-red-contrib-smartcontracttx");
const app = async function() {
const instanceAlice = new SmartContractTX();
let msgAlice = {
payload: {
presentation: {
'Hallo':'Welt'
}
}
}
// We need to do something with DIDComms (Message Alice wants to send) ...
instanceAlice.setSender(async function(msgs) {
// As soon as JWT got generated (Alice wants to send) - we forward to a new Bob
const instanceBob = new SmartContractTX();
let msgBob = msgs[2]; // Alice Output is [2] as we want the JWT
console.log('Message from Alice to Bob',msgBob);
// If Bob received a message he sends via output[3] to internal processes...
instanceBob.setSender(async function(msgs) {
console.log('Bob DID',msgs[3]);
});
await instanceBob.input(msgBob);
console.log('End');
});
// Now we are ready to send Message from Alice
await instanceAlice.input(msgAlice);
}
app();
```
## Tutorials / Usecases
- [Call Method on SmartContract - ERC20 totalSupply](https://github.com/energychain/node-red-contrib-smartcontracttx/blob/main/docs/UC1_Call_Method.md)
- [Issue Transaction](https://github.com/energychain/node-red-contrib-smartcontracttx/blob/main/docs/UC2_Transact_SC.md)
- [Basic Verifiable Presentation](https://github.com/energychain/node-red-contrib-smartcontracttx/blob/main/docs/UC3_VP_Offchain.md)
- [Digital Freddy - Digital Heritage](https://github.com/energychain/node-red-contrib-smartcontracttx/blob/main/docs/UC4_VP_DigitalFreddy.md)
- [Using Presentation Processing Services](https://github.com/energychain/node-red-contrib-smartcontracttx/blob/main/docs/CB_PresentationProcessingService.md)
- [Chinese whispers - Building a JWT/DID Bus](https://github.com/energychain/node-red-contrib-smartcontracttx/blob/main/docs/CB_Chinese_Whispers_Building_A_Bus.md)
## Maintainer / Imprint
STROMDAO GmbH
Gerhard Weiser Ring 29
69256 Mauer
Germany
+49 6226 968 009 0
[email protected]
Handelsregister: HRB 728691 (Amtsgericht Mannheim)
Project Website: https://co2offset.io/
## LICENSE
[Apache-2.0](./LICENSE)