MoiBit module which writes provenance to matic network
npm install @moibitjs/matic
MoiBitJS/matic uses MoiBitJS/core module to perform file actions and the provenance of files will be stored in Matic network.
Just run the following npm command and the SDK will be installed.
`` bash`
npm install --save @moibitjs/matic
` js
import Matic from 'maticjs'
import MoiBit from '@moibitjs/matic'
// Initialize matic object
let _matic = new Matic({
parentProvider : 'https://ropsten.infura.io/v3/70645f042c3a409599c60f96f6dd9fbc',
maticProvider : 'https://testnet2.matic.network'
});
// Initialize moibit object with matic object as parameter
let mFiles = new MoiBit(_matic)
await mfiles.init('
API_KEY : '
API_SECRET : '
});
//needs signing of transaction to matic network that stores multihash for provenance, before adding file to moibit
await mfiles.add(file,'sample.txt')
`
js
var mFiles = new MoiBit(maticObject)
`
$3
Initialize your MoiBit Object with matic. Get your MoiBit account here. After signing up you will be getting _API_KEY , API_SECRET , URL_- url you got after signing up
- accessToken is a combination of _API_KEY_ and _API_SECRET_
js
await mFiles.init('',{
API_KEY : '' ,
API_SECRET : ''
});
`
$3
Add file of any type which will be stored in MoiBit and the returned multi-hash will be stored in matic chain where you are expected to sign a transaction.
- file can be window file object or stream
- path is an absolute path in your files directory at which you want the file to be inserted.
- options
-
is a boolean value which specifies to create a folder/not if it is not existing , that was mentioned in above path attribute (_default : true_)
- pinVersion is a boolean value which tells to pin the file while adding.(_default : false_)` js
await mFiles.add(fileObject,'parent1/folder2/file3.txt');
`$3
Returns file with specified return type only if the hash stored
on-chain (ie., in Matic) and off-chain (ie., in MoiBit) are same,
if not returns negative response
js
{
validation : failed,
message : 'No record matching '
}
`-
is an absolute path-
responseType can be anything among - _arraybuffer , document , json , text , stream_
- _blob - browser only_
` js
await mFiles.read('parent1/folder2/file3.txt','blob');
`
to do more actions other than 1. Vuppala Sai Prashanth
2. Arunprakash
1. Ayush Gupta
2. Ganesh Prasad Kumble
If you need more clarifications, feel free to join our Telegram or Slack community channels. You can also write us an email at hello@moibit.io