Nostalgic Primordial Monster

    @arianee/arianee-rpc-server

    0.22.0 • Public • Published

    Build Status

    What is it?

    arianee-rpc-server is a arianeeRPCServer ready to use with Arianee solution. Authorizations of read and write are already set. You just need to set methods how to read and create events and certificate content.

    How to setup your own rpc server

    For quick examples see examples for firebase and express

    Instanciate with the network

    import { ArianeeRPCCustom } from "@arianee/arianee-rpc-server";
    import {NETWORK} from "@arianee/arianeejs";
    const arianeeRPC=new ArianeeRPCCustom(NETWORK.mainnet);

    Certificates:

    A certificate can be read or create. You need to define this 2 methods.

    const fetchCertificateContent=(certificateId)=>Promise.resolve('hey I am the content');
    const createCertificate=(certificateId, content)=>Promise.resolve('hey I have created the content');
    const createCertificateWithoutBlockchainValidation=(certificateId, content)=>Promise.resolve('hey I have created the content');
    
    arianeeRPC.setCertificateContentMethods(fetchCertificateContent, createCertificate, createCertificateWithoutBlockchainValidation);

    Events

    An event can be read or create. You need to define this 2 methods.

    const fetchEventContent=(eventId)=>Promise.resolve('hey I am the content');
    const createEvent=(eventId, content)=>Promise.resolve('hey I have created the content');
    const createEventWithoutBlockchainValidation=(eventId, content)=>Promise.resolve('hey I have created the content');
    
    arianeeRPC.setEventContentMethods(fetchEvent, createEvent, createEventWithoutBlockchainValidation);

    Message

    An event can be read or create. You need to define this 2 methods.

    const fetchMessageContent=(messageId)=>Promise.resolve('hey I am the content');
    const createMessage=(messageId, content)=>Promise.resolve('hey I have created the content');
    const createMessageWithoutBlockchainValidation=(messageId, content)=>Promise.resolve('hey I have created the content');
    
    arianeeRPC.setMessageContentMethods(fetchMessage,createMessage, createMessageWithoutBlockchainValidation);

    Certificate Update

    An event can be read or create. You need to define this 2 methods.

    const fetchUpdateContent=(certificateId)=>Promise.resolve('hey I am the content');
    const createUpdate=(certificateId, content)=>Promise.resolve('hey I have created the content');
    const createUpdateWithoutBlockchainValidation=(certificateId, content)=>Promise.resolve('hey I have created the content');
    
    arianeeRPC.setUpdateContentMethods(fetchUpdate,createUpdate, createUpdateWithoutBlockchainValidation);

    Final step: build

    Then if you need to build. It returns a function that can be easily used in an express server

    const rpcServer = arianeeRPC.build();
    
    app.post("/rpc", (req, res, next) => rpcServer(req, res, next));
    // Or shorter
    app.post("/rpc",rpcServer);

    TEST

    1/ Launch npm run start:express

    2/ launch npm run test:watch

    DEBUG

    process.env.DEBUG = true

    Contributing

    Your contribution are welcome if they comply to the following requirements:

    1. Commit name should follow this specification https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary
    2. All tests should be ok
    3. Add value to the product

    Keywords

    none

    Install

    npm i @arianee/arianee-rpc-server

    DownloadsWeekly Downloads

    136

    Version

    0.22.0

    License

    ISC

    Unpacked Size

    95.3 kB

    Total Files

    62

    Last publish

    Collaborators

    • stefdelecjs
    • mvaullerin
    • arianeetech