A distributed computing environment for Web 4.0 — integrating AI, decentralisation, and virtual computation.
npm install godprotocol��# G o d P r o t o c o l
A d i s t r i b u t e d c o m p u t i n g e n v i r o n m e n t f o r W e b 4 . 0 i n t e g r a t i n g A I , d e c e n t r a l i s a t i o n , a n d v i r t u a l c o m p u t a t i o n .
T h i s r e p o s i t o r y c o n t a i n s t h e G o d P r o t o c o l c o r e i m p l e m e n t a t i o n : a m o d u l a r , e x t e n s i b l e r u n t i m e b u i l t i n m o d e r n N o d e . j s t h a t o r g a n i z e s c o m p u t a t i o n t h r o u g h a s e t o f O b j e c t s , I n s t a n c e s , D a t a t y p e s , a n d c a l l a b l e s ( a c t i o n p r i m i t i v e s ) .
- - -
# # H i g h l i g h t s
- P u r p o s e : P r o v i d e a f l e x i b l e v i r t u a l c o m p u t a t i o n e n v i r o n m e n t ( a . k . a . " T r i n i t y " ) t h a t c a n b e e m b e d d e d , e x t e n d e d , a n d r u n l o c a l l y o r i n d i s t r i b u t e d s e t u p s .
- B u i l t w i t h : N o d e . j s ( E S M o d u l e s / " t y p e " : " m o d u l e " ) .
- M i n i m u m N o d e . j s : 1 8 + ( s e e p a c k a g e . j s o n ) .
- - -
# # Q u i c k s t a r t
P r e r e q u i s i t e s
- N o d e . j s 1 8 o r n e w e r .
I n s t a l l d e p e n d e n c i e s
p o w e r s h e l l
n p m i n s t a l l
R u n i n d e v e l o p m e n t ( u s e s n o d e m o n ) :
p o w e r s h e l l
n p m r u n s t a r t
R u n w i t h o u t n o d e m o n :
p o w e r s h e l l
n p m r u n d e v
N o t e s :
- s t a r t s c r i p t u s e s n o d e m o n a n d w i l l r e s t a r t o n f i l e c h a n g e s . d e v r u n s t h e e n t r y f i l e o n c e .
- T h e p a c k a g e i s a n E S m o d u l e p a c k a g e ( s e e p a c k a g e . j s o n - > t y p e : " m o d u l e " ) .
- - -
# # P r o g r a m m a t i c u s a g e
T h e r u n t i m e i s b o o t s t r a p p e d f r o m I n d e x . j s w h i c h c r e a t e s a T r i n i t y i n s t a n c e :
- I n d e x . j s i m p o r t s T r i n i t y f r o m O b j e c t s / T r i n i t y . j s a n d e x p o r t s t h e i n s t a n t i a t e d r u n t i m e . Y o u c a n i m p o r t t h i s f i l e f r o m a n o t h e r E S m o d u l e - b a s e d p r o j e c t o r r e q u i r e i t a s p a r t o f a l a r g e r s y s t e m .
E x a m p l e ( i n s i d e a n o t h e r E S m o d u l e f i l e ) :
j s
t r i n i t y
i m p o r t t r i n i t y f r o m " . / I n d e x . j s " ;
/ / i s t h e d e f a u l t r u n t i m e i n s t a n c e c r e a t e d o n i m p o r t
/ / I n t e r a c t w i t h i t a c c o r d i n g t o t h e p r o j e c t ' s A P I ( O b j e c t s / T r i n i t y . j s )
E n v i r o n m e n t v a r i a b l e s
- T r i n i t y i f s e t , t h i s w i l l b e p a s s e d i n t o n e w T r i n i t y ( p r o c e s s . e n v . T r i n i t y | | " G o d P r o t o c o l " ) ( s e e I n d e x . j s ) .
- - -
# # P r o j e c t l a y o u t ( h i g h - l e v e l )
T h i s p r o j e c t i s i n t e n t i o n a l l y m o d u l a r . B e l o w i s a s h o r t d e s c r i p t i o n o f t o p - l e v e l d i r e c t o r i e s a n d n o t a b l e f i l e s .
- I n d e x . j s e n t r y p o i n t ; i n s t a n t i a t e s t h e m a i n T r i n i t y r u n t i m e .
- p a c k a g e . j s o n p r o j e c t m e t a d a t a , d e p e n d e n c i e s a n d s c r i p t s .
- O b j e c t s / c o r e o b j e c t c l a s s e s ( e . g . , T r i n i t y . j s , O r a c l e . j s , R e p o s i t o r y . j s , M a n a g e r . j s , V i r t u a l _ m a c h i n e . j s ) . T h e s e i m p l e m e n t t h e m a j o r r u n t i m e p r i m i t i v e s a n d b e h a v i o r s .
- I n s t a n c e s / c o n c r e t e r u n t i m e i n s t a n c e s a n d a d a p t e r s u s e d b y t h e s y s t e m ( a c c o u n t s , e v e n t s , f o l d e r s , r e s p o n s e s , e t c . ) .
- D a t a t y p e s / p r i m i t i v e a n d c o m p o u n d d a t a t y p e s u s e d t h r o u g h o u t t h e r u n t i m e ( s t r i n g s , n u m b e r s , a r r a y s , b o o l e a n s , c a l l a b l e w r a p p e r s a n d u t i l i t i e s ) . T h e r e i s a l s o a f u n c t i o n s / f o l d e r h e r e f o r d a t a t y p e - s p e c i f i c h e l p e r m o d u l e s l i k e s t o r a g e a n d w a l l e t .
- c a l l a b l e s / a c o l l e c t i o n o f a c t i o n p r i m i t i v e s ( s m a l l f u n c t i o n s t h a t g e t r e g i s t e r e d a n d c a l l e d b y t h e r u n t i m e ) . c a l l a b l e s / r e g i s t e r . j s p r o v i d e s t h e r e g i s t r a t i o n m e c h a n i s m .
- h t m l / h e l p e r s f o r t h e l o a d e r / r e n d e r e r ( c r e a t e , l o a d , p a r s e , r u n a n d u t i l i t y f i l e s u s e d b y t h e H T M L / l o a d e r s u b s y s t e m ) .
- u t i l s / a s s o r t e d u t i l i t i e s a n d s e r v i c e s u s e d b y t h e r u n t i m e ( s e r v e r c r e a t i o n , c r y p t o / h a s h h e l p e r s , s o c k e t s e r v e r , s e r v i c e s . j s f o r H T T P i n t e r a c t i o n s , c e r t i f i c a t e f i l e s , e t c . ) .
F i l e s y o u w i l l l i k e l y r e a d f i r s t
- O b j e c t s / T r i n i t y . j s c o r e r u n t i m e o r c h e s t r a t i o n ( p r i m a r y e n t r y p o i n t f o r u n d e r s t a n d i n g h o w c o m p o n e n t s a r e w i r e d ) .
- O b j e c t s / O r a c l e . j s i m p l e m e n t s a n O r a c l e c l i e n t u s e d t o t a l k t o o r a c l e e n d p o i n t s ( e x a m p l e o f a h i g h e r - l e v e l s e r v i c e t h a t u s e s u t i l s / s e r v i c e s . j s ) .
- u t i l s / c r e a t e _ s e r v e r . j s & u t i l s / s o c k e t _ s e r v e r . j s s e r v e r c r e a t i o n a n d s o c k e t u t i l i t i e s .
- - -
# # C o r e c o n c e p t s
- T r i n i t y : t h e r o o t r u n t i m e . I t w i r e s t o g e t h e r o b j e c t s , i n s t a n c e s , d a t a t y p e s , a n d c a l l a b l e s t o p r o v i d e e x e c u t i o n a n d s t o r a g e s e m a n t i c s .
- O b j e c t s : c l a s s e s t h a t p r o v i d e m a j o r r u n t i m e r o l e s ( b l o c k , r e p o s i t o r y , m a n a g e r , v i r t u a l m a c h i n e , o r a c l e c l i e n t , e t c . ) .
- I n s t a n c e s : r u n t i m e - b o u n d o b j e c t s t h a t r e p r e s e n t e n t i t i e s ( a c c o u n t s , e v e n t s , f o l d e r s , r e s p o n s e s ) .
- D a t a t y p e s : t y p e d w r a p p e r s a n d v a l i d a t o r s u s e d t o k e e p r u n t i m e d a t a c o n s i s t e n t a n d p l u g g a b l e .
- C a l l a b l e s : t h e p r i m i t i v e o p e r a t i o n s ; s m a l l m o d u l e s i n t h e c a l l a b l e s / f o l d e r t h a t a r e r e g i s t e r e d a n d i n v o k e d b y r u n t i m e c o d e .
- - -
# # D e v e l o p m e n t n o t e s
- A d d n e w c a l l a b l e s b y c r e a t i n g m o d u l e s i n c a l l a b l e s / f u n c t i o n s / a n d r e g i s t e r i n g t h e m w i t h c a l l a b l e s / r e g i s t e r . j s .
- T o a d d a n e w D a t a t y p e , f o l l o w t h e p a t t e r n u s e d i n D a t a t y p e s / ( t h e r e a r e e x a m p l e s f o r s t r . j s , n u m . j s , a r r . j s , b o o l . j s , e t c . ) .
- C o r e o b j e c t b e h a v i o r l i v e s i n O b j e c t s / . I f y o u i m p l e m e n t n e w r u n t i m e f e a t u r e s , i m p l e m e n t t h e m a s a n O b j e c t c l a s s a n d w i r e i n t o T r i n i t y .
- K e e p c o d e m o d u l a r a n d s t a t e l e s s w h e r e p o s s i b l e . U s e I n s t a n c e s / f o r p e r - r u n t i m e s t a t e a d a p t e r s .
C e r t i f i c a t e s a n d l o c a l H T T P S
- u t i l s / s e r v e r . c e r t a n d u t i l s / s e r v e r . k e y a r e p r e s e n t f o r d e v e l o p m e n t H T T P S ( l o c a l t e s t i n g ) . D o n o t u s e t h e s e f i l e s f o r p r o d u c t i o n e n c r y p t i o n k e y s .
- - -
# # D e p e n d e n c i e s
- D e c l a r e d i n p a c k a g e . j s o n :
- a i r c o d e 4 ( l a t e s t ) u s e d s o m e w h e r e i n t h e r u n t i m e ( s e e c o d e r e f e r e n c e s ) .
- g e n e r a l i s e d - d a t a s t o r e ( l a t e s t ) d a t a s t o r e a b s t r a c t i o n .
- D e v d e p e n d e n c y : n o d e m o n ( f o r n p m r u n s t a r t ) .
I n s t a l l t h e m w i t h n p m i n s t a l l ( a l r e a d y s h o w n a b o v e ) . P i n v e r s i o n s i f y o u n e e d d e t e r m i n i s t i c i n s t a l l s .
- - -
# # T e s t s & C I
- T h e r e a r e n o a u t o m a t e d t e s t s i n c l u d e d i n t h e r e p o s i t o r y b y d e f a u l t .
- R e c o m m e n d e d : a d d m i n i m a l u n i t t e s t s ( J e s t / A v a / V i t e s t ) f o c u s e d o n O b j e c t s / T r i n i t y . j s a n d s m a l l , p u r e c a l l a b l e s . A b a s i c t e s t s u i t e s h o u l d i n c l u d e :
- T r i n i t y s t a r t u p + s h u t d o w n
- B a s i c c a l l a b l e r e g i s t r a t i o n a n d i n v o c a t i o n
- D a t a t y p e v a l i d a t i o n a n d s e r i a l i z a t i o n
- - -
# # T r o u b l e s h o o t i n g
- N o d e r u n t i m e e r r o r s : e n s u r e N o d e > = 1 8 a n d t h a t t h e t y p e : " m o d u l e " s e t t i n g i n p a c k a g e . j s o n i s r e s p e c t e d b y y o u r e n v i r o n m e n t .
- U n r e s o l v e d i m p o r t s : r u n n p m i n s t a l l a n d v e r i f y t h e n o d e _ m o d u l e s f o l d e r e x i s t s . I f u s i n g a n e d i t o r , r e s t a r t i t s l a n g u a g e s e r v e r .
- H T T P S / c e r t i f i c a t e e r r o r s d u r i n g d e v e l o p m e n t : t h e r e p o i n c l u d e s s a m p l e c e r t s i n u t i l s / c o n f i g u r e y o u r l o c a l c l i e n t t o t r u s t t h e m o r s w i t c h t o H T T P f o r l o c a l d e v e l o p m e n t .
- - -
# # C o n t r i b u t i n g
C o n t r i b u t i o n s a r e w e l c o m e . S u g g e s t e d w o r k f l o w :
1 . F o r k t h e r e p o .
2 . C r e a t e a f e a t u r e b r a n c h f o r y o u r c h a n g e .
3 . R u n t h e p r o j e c t l o c a l l y a n d a d d t e s t s f o r n e w b e h a v i o r .
4 . O p e n a c l e a r P R w i t h a d e s c r i p t i o n o f t h e c h a n g e a n d a n y m i g r a t i o n s t e p s .
P l e a s e f o l l o w t h e e x i s t i n g c o d e s t y l e a n d m o d u l e p a t t e r n s . K e e p c h a n g e s s m a l l a n d f o c u s e d .
- - -
# # L i c e n s e & C o n t a c t
- L i c e n s e : I S C ( s e e p a c k a g e . j s o n ) .
- R e p o s i t o r y : h t t p s : / / g i t h u b . c o m / i m m a n u e l - s a v v y / G o d P r o t o c o l
- A u t h o r : S a v v y < c o n t a c t @ y o u r d o m a i n . c o m >
I f y o u n e e d h e l p o n b o a r d i n g o r w a n t a w a l k t h r o u g h o f t h e m a j o r m o d u l e s , o p e n a n i s s u e o n t h e r e p o s i t o r y o r c o n t a c t t h e a u t h o r d i r e c t l y .
- - -
# # N e x t s t e p s / S u g g e s t e d i m p r o v e m e n t s
- A d d a s m a l l t e s t h a r n e s s & C I c o n f i g u r a t i o n ( G i t H u b A c t i o n s ) t o r u n l i n t a n d t e s t s o n e a c h P R .
- A d d d o c u m e n t a t i o n o n t h e T r i n i t y p u b l i c A P I w i t h e x a m p l e s a n d c o m m o n p a t t e r n s .
- A d d e x a m p l e s d e m o n s t r a t i n g e m b e d d i n g t h e r u n t i m e i n s i d e a n o t h e r a p p l i c a t i o n a n d u s i n g t h e O r a c l e c l i e n t .
T h a n k y o u f o r e x p l o r i n g G o d P r o t o c o l i f y o u w a n t , I c a n a l s o g e n e r a t e a C O N T R I B U T I N G . m d , a d d a b a s i c t e s t s u i t e , o r s c a f f o l d A P I d o c s f r o m t h e O b j e c t s / s o u r c e f i l e s .