paychan

Documentation

Overview

Package paychan provides unidirectional payment channels for cosmos SDK based blockchains.

This module implements simple but feature complete unidirectional payment channels. Channels can be opened by a sender and closed immediately by the receiver, or by the sender subject to a dispute period. There are no top-ups or partial withdrawals (yet). Channels support multiple currencies.

Index

• Constants
• func EndBlocker(ctx sdk.Context, k Keeper) sdk.Tags
• func NewHandler(k Keeper) sdk.Handler
• func VerifyUpdate(channel types.Channel, update types.Update) sdk.Error
• type AppModule
  • func NewAppModule(keeper Keeper) AppModule
  • func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) sdk.Tags
  • func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) ([]abci.ValidatorUpdate, sdk.Tags)
  • func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage
  • func (am AppModule) InitGenesis(ctx sdk.Context, genesis json.RawMessage) []abci.ValidatorUpdate
  • func (AppModule) Name() string
  • func (am AppModule) NewHandler() sdk.Handler
  • func (AppModule) NewQuerierHandler() sdk.Querier
  • func (AppModule) QuerierRoute() string
  • func (AppModule) RegisterInvariants(_ sdk.InvariantRouter)
  • func (AppModule) Route() string
• type AppModuleBasic
  • func (AppModuleBasic) DefaultGenesis() json.RawMessage
  • func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command
  • func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command
  • func (AppModuleBasic) Name() string
  • func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)
  • func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)
  • func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error
• type Keeper
  • func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, bk bank.Keeper) Keeper
  • func (k Keeper) CloseChannelByReceiver(ctx sdk.Context, update types.Update) (sdk.Tags, sdk.Error)
  • func (k Keeper) CreateChannel(ctx sdk.Context, sender sdk.AccAddress, receiver sdk.AccAddress, ...) (sdk.Tags, sdk.Error)
  • func (k Keeper) InitCloseChannelBySender(ctx sdk.Context, update types.Update) (sdk.Tags, sdk.Error)

Constants

const (
	ModuleName = types.ModuleName
	RouterKey  = types.RouterKey
	StoreKey   = types.StoreKey
)

Functions

func EndBlocker

func EndBlocker(ctx sdk.Context, k Keeper) sdk.Tags

EndBlocker closes channels that have past their execution time. It runs at the end of every block, comparing submitted updates against the current block height.

func NewHandler

func NewHandler(k Keeper) sdk.Handler

NewHandler returns a handler for "paychan" type messages. Called when adding routes to a newly created app.

func VerifyUpdate

func VerifyUpdate(channel types.Channel, update types.Update) sdk.Error

VerifyUpdate checks that a given update is valid for a given channel.

Types

type AppModule

type AppModule struct {
	AppModuleBasic
	// contains filtered or unexported fields
}

AppModule

func NewAppModule

func NewAppModule(keeper Keeper) AppModule

NewAppModule creates a new AppModule object

func (AppModule) BeginBlock

func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) sdk.Tags

module begin-block

func (AppModule) EndBlock

func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) ([]abci.ValidatorUpdate, sdk.Tags)

module end-block

func (AppModule) ExportGenesis

func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage

module export genesis

func (AppModule) InitGenesis

func (am AppModule) InitGenesis(ctx sdk.Context, genesis json.RawMessage) []abci.ValidatorUpdate

module init-genesis

func (AppModule) Name

func (AppModule) Name() string

module name

func (AppModule) NewHandler

func (am AppModule) NewHandler() sdk.Handler

module handler

func (AppModule) NewQuerierHandler

func (AppModule) NewQuerierHandler() sdk.Querier

module querier

func (AppModule) QuerierRoute

func (AppModule) QuerierRoute() string

module querier route name

func (AppModule) RegisterInvariants

func (AppModule) RegisterInvariants(_ sdk.InvariantRouter)

register invariants

func (AppModule) Route

func (AppModule) Route() string

module message route name

type AppModuleBasic

type AppModuleBasic struct{}

AppModuleBasic

func (AppModuleBasic) DefaultGenesis

func (AppModuleBasic) DefaultGenesis() json.RawMessage

default genesis state

func (AppModuleBasic) GetQueryCmd

func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command

get the root query command of this module

func (AppModuleBasic) GetTxCmd

func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command

get the root tx command of this module

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

module name

func (AppModuleBasic) RegisterCodec

func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)

register module codec

func (AppModuleBasic) RegisterRESTRoutes

func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)

register rest routes

func (AppModuleBasic) ValidateGenesis

func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error

module validate genesis

type Keeper

type Keeper struct {
	// contains filtered or unexported fields
}

Keeper contains the main business logic of the module. Handles validation internally. Does not rely on calling code to do validation. Aim to keep public methods safe, private ones not necessarily.

func NewKeeper

func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, bk bank.Keeper) Keeper

NewKeeper returns a new payment channel keeper. This is called when creating new app.

func (Keeper) CloseChannelByReceiver

func (k Keeper) CloseChannelByReceiver(ctx sdk.Context, update types.Update) (sdk.Tags, sdk.Error)

CloseChannelByReceiver immediately closes a payment channel.

func (Keeper) CreateChannel

func (k Keeper) CreateChannel(ctx sdk.Context, sender sdk.AccAddress, receiver sdk.AccAddress, coins sdk.Coins) (sdk.Tags, sdk.Error)

CreateChannel creates a new payment channel in the blockchain and locks up sender funds.

func (Keeper) InitCloseChannelBySender

func (k Keeper) InitCloseChannelBySender(ctx sdk.Context, update types.Update) (sdk.Tags, sdk.Error)

InitCloseChannelBySender initiates the close of a payment channel, subject to a dispute period.