mustafair-carvid-package-hackathon
Version:
CARV ID implementation files for MustaFair decentralized social media platform
159 lines • 7.46 kB
Markdown
��# M u s t a F a i r C A R V I D F i l e s
A c o l l e c t i o n o f C A R V I D i m p l e m e n t a t i o n f i l e s f o r d e c e n t r a l i z e d s o c i a l m e d i a p l a t f o r m s , f e a t u r i n g m o d u l a r i d e n t i t y m a n a g e m e n t , r e p u t a t i o n s y s t e m s , a n d W e b 2 a c h i e v e m e n t i n t e g r a t i o n .
# # I n s t a l l a t i o n
` ` ` b a s h
n p m i n s t a l l m u s t a f a i r - c a r v i d
` ` `
# # U s a g e
A f t e r i n s t a l l a t i o n , y o u c a n c o p y t h e f i l e s d i r e c t l y i n t o y o u r p r o j e c t :
` ` ` b a s h
# C o p y c o m p o n e n t s t o y o u r p r o j e c t
c p - r n o d e _ m o d u l e s / m u s t a f a i r - c a r v i d / c o m p o n e n t s . / s r c /
# C o p y c o n t r a c t s t o y o u r h a r d h a t p r o j e c t
c p - r n o d e _ m o d u l e s / m u s t a f a i r - c a r v i d / c o n t r a c t s . / h a r d h a t /
# C o p y u t i l i t i e s a n d A B I s
c p - r n o d e _ m o d u l e s / m u s t a f a i r - c a r v i d / l i b . / s r c /
c p - r n o d e _ m o d u l e s / m u s t a f a i r - c a r v i d / h o o k s . / s r c /
` ` `
# # F i l e S t r u c t u r e
` ` `
m u s t a f a i r - c a r v i d /
% % % c o m p o n e n t s / # R e a c t c o m p o n e n t s
% % % % M i n t C a r v I d D i a l o g . t s x
% % % % c a r v - i d - v i e w e r . t s x
% % % % c a r v - i d - l o g i n . t s x
% % % % i d e n t i t y - g r a p h . t s x
% % % % r e p - n f t - m i n t e r . t s x
% % % % i d e n t i t y - w a l l e t - l i n k e r . t s x
% % % c o n t r a c t s / # S m a r t c o n t r a c t s
% % % % M o d u l a r C a r v I D . s o l
% % % % R e p u t a t i o n N F T . s o l
% % % % C a r v I d P o s t V o t i n g . s o l
% % % a r t i f a c t s / # C o n t r a c t a r t i f a c t s a n d A B I s
% % % l i b / # U t i l i t i e s a n d A B I s
% % % % M o d u l a r C a r v I D _ A B I . j s o n
% % % % R e p u t a t i o n N F T _ A B I . j s o n
% % % % C a r v I d P o s t V o t i n g _ A B I . j s o n
% % % % i d e n t i t y - h a s h . t s
% % % % c a r v - i d - p r o v i d e r . t s
% % % % f a i r 3 - r e p u t a t i o n - s d k . t s
% % % h o o k s / # C u s t o m h o o k s
% % % % u s e - i d e n t i t y - w a l l e t - b i n d i n g . t s
% % % R E A D M E . m d # T h i s f i l e
` ` `
# # C o m p o n e n t s
# # # M i n t C a r v I d D i a l o g
M i n t n e w C A R V I D N F T s w i t h W e b 2 a c h i e v e m e n t i n t e g r a t i o n .
# # # C a r v I d P a s s p o r t D i a l o g
V i e w a n d m a n a g e e x i s t i n g C A R V I D p r o f i l e s .
# # # I d e n t i t y G r a p h
V i s u a l i z e i d e n t i t y c o n n e c t i o n s a n d r e l a t i o n s h i p s .
# # # R e p N f t M i n t e r
M i n t r e p u t a t i o n N F T s f o r g o v e r n a n c e p a r t i c i p a t i o n .
# # # I d e n t i t y W a l l e t L i n k e r
L i n k O A u t h i d e n t i t i e s t o W e b 3 w a l l e t s v i a E R C - 7 2 3 1 .
# # S m a r t C o n t r a c t s
T h e p a c k a g e i n c l u d e s t h e f o l l o w i n g s m a r t c o n t r a c t s :
- * * M o d u l a r C a r v I D . s o l * * : C o r e C A R V I D i m p l e m e n t a t i o n
- * * R e p u t a t i o n N F T . s o l * * : R e p u t a t i o n a n d g o v e r n a n c e s y s t e m
- * * C a r v I d P o s t V o t i n g . s o l * * : D e c e n t r a l i z e d v o t i n g s y s t e m
# # U t i l i t i e s
# # # I d e n t i t y H a s h G e n e r a t i o n
` ` ` t y p e s c r i p t
i m p o r t { g e n e r a t e I d e n t i t y H a s h , p a r s e I d e n t i t y D a t a } f r o m ' . / l i b / i d e n t i t y - h a s h ' ;
c o n s t i d e n t i t y D a t a = p a r s e I d e n t i t y D a t a ( ' g i t h u b ' , p r o f i l e , D a t e . n o w ( ) ) ;
c o n s t h a s h = g e n e r a t e I d e n t i t y H a s h ( i d e n t i t y D a t a ) ;
` ` `
# # # C A R V I D P r o v i d e r
` ` ` t y p e s c r i p t
i m p o r t { C a r v I d P r o v i d e r } f r o m ' . / l i b / c a r v - i d - p r o v i d e r ' ;
/ / U s e w i t h N e x t A u t h
c o n s t a u t h O p t i o n s = {
p r o v i d e r s : [
C a r v I d P r o v i d e r ,
/ / . . . o t h e r p r o v i d e r s
] ,
} ;
` ` `
# # C o n f i g u r a t i o n
# # # E n v i r o n m e n t V a r i a b l e s
` ` ` e n v
N E X T _ P U B L I C _ C O N T R A C T _ A D D R E S S = 0 x . . .
N E X T _ P U B L I C _ R E P U T A T I O N _ N F T _ A D D R E S S = 0 x . . .
N E X T _ P U B L I C _ P O S T _ V O T I N G _ A D D R E S S = 0 x . . .
` ` `
# # # N e t w o r k S u p p o r t
- B N B T e s t n e t ( C h a i n I D : 9 7 )
- L o c a l h o s t ( C h a i n I D : 1 3 3 7 )
# # D e p e n d e n c i e s
T h e c o m p o n e n t s r e q u i r e t h e s e d e p e n d e n c i e s i n y o u r p r o j e c t :
` ` ` j s o n
{
" d e p e n d e n c i e s " : {
" e t h e r s " : " ^ 6 . 0 . 0 " ,
" w a g m i " : " ^ 1 . 0 . 0 " ,
" r e a c t " : " ^ 1 8 . 0 . 0 " ,
" r e a c t - d o m " : " ^ 1 8 . 0 . 0 " ,
" n e x t - a u t h " : " ^ 4 . 0 . 0 " ,
" s o n n e r " : " ^ 1 . 0 . 0 " ,
" l u c i d e - r e a c t " : " ^ 0 . 4 0 0 . 0 " ,
" @ r a d i x - u i / r e a c t - d i a l o g " : " ^ 1 . 0 . 0 " ,
" @ r a d i x - u i / r e a c t - b u t t o n " : " ^ 1 . 0 . 0 " ,
" @ r a d i x - u i / r e a c t - c a r d " : " ^ 1 . 0 . 0 " ,
" @ r a d i x - u i / r e a c t - a l e r t " : " ^ 1 . 0 . 0 " ,
" @ r a d i x - u i / r e a c t - b a d g e " : " ^ 1 . 0 . 0 "
}
}
` ` `
# # D e v e l o p m e n t
# # # P u b l i s h i n g U p d a t e s
` ` ` b a s h
# U p d a t e v e r s i o n
n p m v e r s i o n p a t c h
# P u b l i s h
n p m p u b l i s h
` ` `
# # L i c e n s e
M I T L i c e n s e - s e e L I C E N S E f i l e f o r d e t a i l s .
# # S u p p o r t
F o r i s s u e s a n d q u e s t i o n s , p l e a s e o p e n a n i s s u e o n t h e G i t H u b r e p o s i t o r y .