Gateway module

astral/router.go

@@ -1,12 +1,11 @@
 package astral
 
 import (
-	"context"
 	"io"
 )
 
 type Router interface {
 	RouteQuery(ctx *Context, q *Query, w io.WriteCloser) (io.WriteCloser, error)
 }
 
-type RouteQueryFunc func(ctx context.Context, q *Query, w io.WriteCloser) (io.WriteCloser, error)
+type RouteQueryFunc func(ctx *Context, q *Query, w io.WriteCloser) (io.WriteCloser, error)

mod/gateway/README.md

@@ -0,0 +1,16 @@
+# gateway
+
+## Configuration
+
+`gateway.yaml`:
+
+```yaml
+gateway:
+  enabled: true
+  listen:
+    - tcp:<public-ip>:6000       
+
+visibility: public  
+init_conns: 1   
+max_conns: 8 
+```

mod/gateway/client/bind.go

@@ -0,0 +1,24 @@
+package gateway
+
+import (
+	"github.com/cryptopunkscc/astrald/astral"
+	"github.com/cryptopunkscc/astrald/astral/channel"
+	"github.com/cryptopunkscc/astrald/lib/query"
+	gw "github.com/cryptopunkscc/astrald/mod/gateway"
+)
+
+func (c *Client) Bind(ctx *astral.Context, visibility gw.Visibility) (*gw.Socket, error) {
+	ch, err := c.queryCh(ctx, gw.MethodBind, query.Args{"visibility": string(visibility)})
+	if err != nil {
+		return nil, err
+	}
+	defer ch.Close()
+
+	var socket *gw.Socket
+	err = ch.Switch(
+		channel.Expect(&socket),
+		channel.PassErrors,
+	)
+
+	return socket, err
+}

mod/gateway/client/client.go

@@ -0,0 +1,36 @@
+package gateway
+
+import (
+	"github.com/cryptopunkscc/astrald/astral"
+	"github.com/cryptopunkscc/astrald/astral/channel"
+	"github.com/cryptopunkscc/astrald/lib/astrald"
+)
+
+type Client struct {
+	astral   *astrald.Client
+	targetID *astral.Identity
+}
+
+var defaultClient *Client
+
+func New(targetID *astral.Identity, a *astrald.Client) *Client {
+	if a == nil {
+		a = astrald.Default()
+	}
+	return &Client{astral: a, targetID: targetID}
+}
+
+func Default() *Client {
+	if defaultClient == nil {
+		defaultClient = New(nil, nil)
+	}
+	return defaultClient
+}
+
+func SetDefault(client *Client) {
+	defaultClient = client
+}
+
+func (c *Client) queryCh(ctx *astral.Context, method string, args any, cfg ...channel.ConfigFunc) (*channel.Channel, error) {
+	return c.astral.WithTarget(c.targetID).QueryChannel(ctx, method, args, cfg...)
+}

mod/gateway/client/connect.go

@@ -0,0 +1,24 @@
+package gateway
+
+import (
+	"github.com/cryptopunkscc/astrald/astral"
+	"github.com/cryptopunkscc/astrald/astral/channel"
+	"github.com/cryptopunkscc/astrald/lib/query"
+	gw "github.com/cryptopunkscc/astrald/mod/gateway"
+)
+
+func (c *Client) Connect(ctx *astral.Context, target *astral.Identity) (*gw.Socket, error) {
+	ch, err := c.queryCh(ctx, gw.MethodConnect, query.Args{"target": target.String()})
+	if err != nil {
+		return nil, err
+	}
+	defer ch.Close()
+
+	var socket *gw.Socket
+	err = ch.Switch(
+		channel.Expect(&socket),
+		channel.PassErrors,
+	)
+
+	return socket, err
+}

mod/gateway/client/list.go

@@ -0,0 +1,25 @@
+package gateway
+
+import (
+	"github.com/cryptopunkscc/astrald/astral"
+	"github.com/cryptopunkscc/astrald/astral/channel"
+	"github.com/cryptopunkscc/astrald/lib/query"
+	gw "github.com/cryptopunkscc/astrald/mod/gateway"
+)
+
+func (c *Client) List(ctx *astral.Context) ([]*astral.Identity, error) {
+	ch, err := c.queryCh(ctx, gw.MethodList, query.Args{})
+	if err != nil {
+		return nil, err
+	}
+	defer ch.Close()
+
+	var list []*astral.Identity
+	err = ch.Switch(
+		channel.Collect(&list),
+		channel.StopOnEOS,
+		channel.PassErrors,
+	)
+
+	return list, err
+}

mod/gateway/errors.go

@@ -0,0 +1,8 @@
+package gateway
+
+import "errors"
+
+var ErrUnauthorized = errors.New("unauthorized")
+var ErrTargetNotReachable = errors.New("target not reachable")
+var ErrInvalidGateway = errors.New("invalid gateway")
+var ErrSocketUnreachable = errors.New("socket unreachable")

mod/gateway/maintain_binding_task.go

@@ -0,0 +1,7 @@
+package gateway
+
+import "github.com/cryptopunkscc/astrald/mod/scheduler"
+
+type MaintainBindingTask interface {
+	scheduler.Task
+}

mod/gateway/module.go

@@ -0,0 +1,13 @@
+package gateway
+
+const ModuleName = "gateway"
+
+const (
+	MethodBind    = "gateway.node_bind"
+	MethodConnect = "gateway.node_connect"
+	MethodList    = "gateway.node_list"
+	MethodRoute   = "gateway.route"
+)
+
+type Module interface {
+}

mod/gateway/ping_frame.go

@@ -0,0 +1,8 @@
+package gateway
+
+const (
+	BytePing        = byte(0x00)
+	BytePong        = byte(0x01)
+	ByteSignalGo    = byte(0x02)
+	ByteSignalReady = byte(0x03)
+)

mod/gateway/socket.go

@@ -0,0 +1,25 @@
+package gateway
+
+import (
+	"io"
+
+	"github.com/cryptopunkscc/astrald/astral"
+	"github.com/cryptopunkscc/astrald/mod/exonet"
+)
+
+// Socket describes a raw connection point at the gateway. The recipient opens
+// a raw exonet connection to the Endpoint and sends Nonce as the first bytes
+// to identify itself to the gateway.
+type Socket struct {
+	Endpoint exonet.Endpoint
+	Nonce    astral.Nonce
+}
+
+func (Socket) ObjectType() string { return "mod.gateway.socket" }
+
+func (s Socket) WriteTo(w io.Writer) (int64, error)   { return astral.Objectify(&s).WriteTo(w) }
+func (s *Socket) ReadFrom(r io.Reader) (int64, error) { return astral.Objectify(s).ReadFrom(r) }
+
+func init() {
+	astral.Add(&Socket{})
+}