portal

package module

v0.0.1 Latest Latest Go to latest Published: May 4, 2022 License: MIT Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sbit-project/sbit-portal

README ¶

SBIT DApp Server

A Web Server for running third-party DApps.

All requests made by a DApp would block until you approve it in the authorization UI.

Install sbit-portal

If you have golang installed, you can install the latest version:

go get -u github.com/SBit-Project/sbit-portal/cli/sbitportal

Running A SBIT DApp

First, we'll need to make sure that sbitd is running.

For testing/development purposes, let's start sbitd in regtest mode:

sbitd -regtest -rpcuser=user -rpcpassword=pass

Then use the env variable SBIT_RPC to specify the URL of your local sbitd RPC node:

export SBIT_RPC=http://user:pass@localhost:22302

Documentation ¶

Index ¶

type Authorization
type AuthorizationState
type Server
- func NewServer(opts ServerOption) *Server
- func (s *Server) Start() error
type ServerOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Authorization ¶

type Authorization struct {
	ID        string             `json:"id"`
	State     AuthorizationState `json:"state"`
	Request   *jsonRPCRequest    `json:"request"`
	CreatedAt time.Time          `json:"createdAt"`
}

type AuthorizationState ¶

type AuthorizationState string

AuthorizationState is the state of an Authorization

const (
	AuthorizationPending AuthorizationState = "pending"

	AuthorizationAccepted AuthorizationState = "accepted"

	AuthorizationDenied AuthorizationState = "denied"

	AuthorizationConsumed AuthorizationState = "consumed"
)

type Server ¶

type Server struct {
	Options ServerOption
	// contains filtered or unexported fields
}

func NewServer ¶

func NewServer(opts ServerOption) *Server

func (*Server) Start ¶

func (s *Server) Start() error

type ServerOption ¶

type ServerOption struct {
	Bind          string
	DAppPort      int
	AuthPort      int
	StaticBaseDir string
	SbitdRPCURL   *url.URL
	DebugMode     bool
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cli
sbitportal
ui

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL