identity

package
v1.1.4-rc3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 30, 2024 License: MIT Imports: 15 Imported by: 0

README

layout: default title: x/identity

x/identity

Abstract

The goal of identity module is to provide an aggregated information about Iden3 issuer states. It listens to deployed into Rarimo EVM StateV2 contract and collects the state transition events.

Concepts

Collected events' information is recoded to the dynamic Merkle tree (based on treap data structure). The proof of concept for dynamic merkle tree is here: "https://github.com/olegfomenko/go-treap-merkle".

To collect events identity module uses evm module hooks by defining the following method:

func (k Keeper) PostTxProcessing(ctx sdk.Context, msg core.Message, receipt *ethtypes.Receipt) error

It receives all emitted transaction logs in EVM module and filters them to process only StateTransited events.

After all state updates in the module EndBlock method the IDENTITY_AGGREGATED_TRANSFER operation will be created with current GIST and States root hash information. Also, the in all changed states lastUpdateOperationIndex will be updated.

Architecture

The basic methods of dynamic merkle to work with is defined in x/identity/keeper/treap.go:

func (t Treap) Split(ctx sdk.Context, root, key string) (string, string)

func (t Treap) Merge(ctx sdk.Context, r1, r2 string) string

func (t Treap) Remove(ctx sdk.Context, key string)

func (t Treap) Insert(ctx sdk.Context, key string, priority uint64)

and other...

That method are operating on the Node structure index.

Node index is based on corresponding StateInfo object hash (use CalculateHash()).

Also, every Node contains additional hash field that stores the HASH(self,HASH(left,right)).

Please refer to the corresponding hash(a, b string) string and updateNode(ctx sdk.Context, node *types.Node) to get more context about how we're constructing merkle tree.

In the x/identity/keeper/keeper.go file we are defining the main entrypoints to interact with:

  • updates the dynamic Merle tree corresponding to the received event information:

    func (k Keeper) UpdateIdentity(ctx sdk.Context, gist string, id string, hash string)

  • returns the Merkle path for any tree node.

    func (k Keeper) Path(ctx sdk.Context, id string) []string

State

Params

Definition:

message Params {
  // Linear congruential generator params
  // https://en.wikipedia.org/wiki/Linear_congruential_generator
  uint64 lcgA = 1;
  uint64 lcgB = 2;
  uint64 lcgMod = 3;
  uint64 lcgValue = 4;
  // Address of identity state smart contract in rarimo chain
  string identityContractAddress = 5;
  string chainName = 6;
  string GISTHash = 7;
  uint64 GISTUpdatedTimestamp = 8;
  string treapRootKey = 9;
  repeated string statesWaitingForSign = 10;
}

Example:

{
  "params": {
    "lcgA": "1664525",
    "lcgB": "1013904223",
    "lcgMod": "4294967296",
    "lcgValue": "2900471886",
    "identityContractAddress": "0x753a8678c85d5fb70A97CFaE37c84CE2fD67EDE8",
    "chainName": "Rarimo",
    "GISTHash": "0x049f1325d5227edcefbca1dc4dc1b76dd981e54c874ec49ba964443086b49950",
    "GISTUpdatedTimestamp": "1691866982",
    "treapRootKey": "0x36141b81b879c28068b3df0bbe9fad19c202b3ef7a140046e018c4153a8ce4c1",
    "statesWaitingForSign": []
  }
}

Node

Definition:

message Node {
  // Node key (identity state hash)
  string key = 1;
  // Node priority (should be random)
  uint64 priority = 2;
  // Node left son key
  string left = 4;
  // Node right son key
  string right = 5;
  // Merkle hash. H = Hash(Hash(left_key|right_key)|self_key)
  string hash = 6;
  // Hash(left_key|right_key)
  string childrenHash = 7;
}

Example:

{
  "node": {
    "key": "0x36141b81b879c28068b3df0bbe9fad19c202b3ef7a140046e018c4153a8ce4c1",
    "priority": "4267815944",
    "left": "0x2d6a7c009097397071398f3b2a1855a5df9f6d9ce258846ba92de23aee0dfdf9",
    "right": "0x371e7f58b71fea562aa728619fed387134051e19a3efe0dac2c09557852c5a5c",
    "hash": "0x9cc3d207a5e341279f698cad512f517edb0e9d8df44181680f8d1d75b5573be2",
    "childrenHash": "0xeb2c9ef79b7415a7d38bd1497550084f6bf3ba2f871771b5030c8084b9ff51c8"
  }
}

StateInfo

Definition:

message StateInfo {
  // State info index (issuer id)
  string index = 1;
  // State hash in hex with 0x
  string hash = 2;
  // Creation timestamps
  uint64 createdAtTimestamp = 3;
  // Creation block (will not be used in state hash)
  uint64 createdAtBlock = 4;
  // Index of last update/create operation (will not be used in state hash)
  string lastUpdateOperationIndex = 5;
}

Example:

{
  "state": {
    "index": "0x106d23bb7bedce6caadddf7480ade7f2b8e93fa304fc51cc4030a66de90001",
    "hash": "0x22121ba37492dbb16203cd6dcdb446c4a5c56a4395b145b9403819bcf34141bf",
    "createdAtTimestamp": "1691866982",
    "createdAtBlock": "923813",
    "lastUpdateOperationIndex": "0x2fd7af49f584db04cc8048fd09be7fccf01bd7efe6c93127c0dbae55e643d625"
  }
}

Transactions

SetIdentityContractAddress

SetIdentityContractAddress - sets the Rarimo EVM StateV2 contract address. Can be called only once when the current address is 0x.

message MsgSetIdentityContractAddress {
  string creator = 1;
  string address = 2;
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExportGenesis 

func ExportGenesis(ctx sdk.Context, k keeper.Keeper) *types.GenesisState

ExportGenesis returns the module's exported genesis

func InitGenesis 

func InitGenesis(ctx sdk.Context, k keeper.Keeper, genState types.GenesisState)

InitGenesis initializes the module's state from a provided genesis state.

func NewHandler 

func NewHandler(k keeper.Keeper) sdk.Handler

NewHandler ...

Types

type AppModule 

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

AppModule implements the AppModule interface that defines the inter-dependent methods that modules need to implement

func NewAppModule 

func NewAppModule(
	cdc codec.Codec,
	k keeper.Keeper,
	accountKeeper types.AccountKeeper,
	bankKeeper types.BankKeeper,
) AppModule

func (AppModule) BeginBlock 

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

BeginBlock contains the logic that is automatically triggered at the beginning of each block

func (AppModule) ConsensusVersion 

func (AppModule) ConsensusVersion() uint64

ConsensusVersion is a sequence number for state-breaking change of the module. It should be incremented on each consensus-breaking change introduced by the module. To avoid wrong/empty versions, the initial version should be set to 1

func (AppModule) EndBlock 

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

EndBlock contains the logic that is automatically triggered at the end of each block

func (AppModule) ExportGenesis 

func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.RawMessage

ExportGenesis returns the module's exported genesis state as raw JSON bytes.

func (AppModule) InitGenesis 

func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, gs json.RawMessage) []abci.ValidatorUpdate

InitGenesis performs the module's genesis initialization. It returns no validator updates.

func (AppModule) LegacyQuerierHandler deprecated 

func (am AppModule) LegacyQuerierHandler(_ *codec.LegacyAmino) sdk.Querier

Deprecated: use RegisterServices

func (AppModule) QuerierRoute deprecated 

func (AppModule) QuerierRoute() string

Deprecated: use RegisterServices

func (AppModule) RegisterInvariants 

func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry)

RegisterInvariants registers the invariants of the module. If an invariant deviates from its predicted value, the InvariantRegistry triggers appropriate logic (most often the chain will be halted)

func (AppModule) RegisterServices 

func (am AppModule) RegisterServices(cfg module.Configurator)

RegisterServices registers a gRPC query service to respond to the module-specific gRPC queries

func (AppModule) Route deprecated 

func (am AppModule) Route() sdk.Route

Deprecated: use RegisterServices

type AppModuleBasic 

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

AppModuleBasic implements the AppModuleBasic interface that defines the independent methods a Cosmos SDK module needs to implement.

func NewAppModuleBasic 

func NewAppModuleBasic(cdc codec.BinaryCodec) AppModuleBasic

func (AppModuleBasic) DefaultGenesis 

func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage

DefaultGenesis returns a default GenesisState for the module, marshalled to json.RawMessage. The default GenesisState need to be defined by the module developer and is primarily used for testing

func (AppModuleBasic) GetQueryCmd 

func (AppModuleBasic) GetQueryCmd() *cobra.Command

GetQueryCmd returns the root query command for the module. The subcommands of this root command are used by end-users to generate new queries to the subset of the state defined by the module

func (AppModuleBasic) GetTxCmd 

func (a AppModuleBasic) GetTxCmd() *cobra.Command

GetTxCmd returns the root Tx command for the module. The subcommands of this root command are used by end-users to generate new transactions containing messages defined in the module

func (AppModuleBasic) Name 

func (AppModuleBasic) Name() string

Name returns the name of the module as a string

func (AppModuleBasic) RegisterGRPCGatewayRoutes 

func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux)

RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the module

func (AppModuleBasic) RegisterInterfaces 

func (a AppModuleBasic) RegisterInterfaces(reg cdctypes.InterfaceRegistry)

RegisterInterfaces registers a module's interface types and their concrete implementations as proto.Message

func (AppModuleBasic) RegisterLegacyAminoCodec 

func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

RegisterLegacyAminoCodec registers the amino codec for the module, which is used to marshal and unmarshal structs to/from []byte in order to persist them in the module's KVStore

func (AppModuleBasic) ValidateGenesis 

func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error

ValidateGenesis used to validate the GenesisState, given in its json.RawMessage form

Source Files

View all Source files

Directories

Path Synopsis
client
cli
migrations
v2
pkg
state
Package types is a reverse proxy.
 Package types is a reverse proxy.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.