Code Monkey home page Code Monkey logo

goraecle's Introduction

Goraecle

Copyright © 2019 UAB "Sonemas" https://sonemas.com

About this project

Library for rapid development of oracles for the aeternity blockchain in Go.

The purpose of this project is to write aeternity oracles in Go in the same manner as other go server by implementing a Handler interface.

Example:

package main

import (
    "fmt"
    "log"
    "strings"

    "github.com/sonemas/goraecle"
)

type ComplexObject struct {
    number int
}

func (o ComplexObject) ServeOracle(r *goraecle.Request) (string, error) {
    return fmt.Sprintf("The number is: %d", o.number), nil
}

func helloQueryHandler(r *goraecle.Request) (string, error) {
    name, ok := r.Args["name"] // Get name or set to "stranger" if not provided
    if !ok {
        name = "stranger"
    }

    // Error handling
    if ok && strings.Contains(strings.ToLower(name.(string)), "vitalik") {
        return "", fmt.Errorf("Go away!")
    }

    // Return an answer
    answer := fmt.Sprintf("Hello, %s", name)
    fmt.Println(answer)
    return answer, nil
}

func main() {
    // goraecle.AeDebugging = true
    goraecle.DebugMode = true

    goraecle.HandleFunc("hello", helloQueryHandler) // Register handler for hello query

    complex := ComplexObject{number: 42}
    goraecle.Handle("complex", complex)

    // Start the oracle
    if err := goraecle.ListenAndServe(ownerPrivateKey, goraecle.AeternityTestnet); err != nil {
        log.Fatalf("Failed to start oracle: %v", err)
    }
}

State

This project is currently under development and not ready for production use.

Licensing

Licensed under the ISC license (the "License");

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.

goraecle's People

Contributors

arjanvaneersel avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.