radex-js
TypeScript icon, indicating that this package has built-in type declarations

1.0.24 • Public • Published
��# r a d e x - j s A j a v a s c r i p t / t y p e s c r i p t c l i e n t l i b r a r y f o r R a d e x e x c h a n g e . # # I m p o r t a n t n o t e T h i s i s s t i l l a d e v e l o p m e n t v e r s i o n o f r a d e x - j s a n d i s l i k e l y t o c o n t a i n b u g s . # # I n s t a l l a t i o n U s e t h e N o d e . j s ( h t t p : / / n o d e j s . o r g ) p a c k a g e m a n a g e r n p m ( t o i n s t a l l r a d e x - j s ` ` ` n p m i n s t a l l r a d e x - j s ` ` ` # # U p d a t e r a d e x - j s i s s t i l l u n d e r a c t i v e d e v e l o p m e n t . I t i s s u g g e s t e d y o u c h e c k f o r u p d a t e s r e g u l a r l y . T o u p d a t e y o u r r a d e x - j s , y o u c a n r u n n p m u p d a t e . ` ` ` n p m u p d a t e ` ` ` # # U s a g e # # # I m p o r t i n g t h e r a d e x - j s l i b r a b r y i n t o y o u r p r o j e c t T h e e a s i e s t m e t h o d i s t o j u s t i m p o r t a l l t h e r a d e x t y p e s , f u n c t i o n s a n d s t a t e a v a i l a b l e f r o m t h e r a d e x - j s l i b r a b r y a s o n e v a r i a b l e i n t o y o u r p r o j e c t . ` ` ` i m p o r t * a s r a d e x f r o m ' r a d e x - j s ' ; ` ` ` W e w i l l a s s u m e t h i s m e t h o d f o r t h e r e s t o f t h e c o d e e x a m p l e s . # # # E s t a b l i s h i n g a c o n n e c t i o n t o R a D E X T o e s t a b l i s h a c o n n e c t i o n t o R a D E X , y o u n e e d t o r u n t h e i m p o r t e d * c o n n e c t * f u n c t i o n w i t h t h e p a t h t o t h e r a d e x w e b s o c k e t a p i ( c u r r e n t t e s t p a t h = " w s s : / / r a d e x - a p i . h e r o k u a p p . c o m " ) . T h i s f u n c t i o n w i l l c o n n e c t t o R a D E X a n d u p d a t e t h e R a D E X s t a t e v a r i a b l e s . ` ` ` r a d e x . c o n n e c t ( " w s s : / / r a d e x - a p i . h e r o k u a p p . c o m " ) ; ` ` ` # # # E s t a b l i s h i n g a c o n n e c t i o n t o R a D E X a n d s e t t i n g i n i t i a l s t a t e v a l u e s T h e * c o n n e c t * f u n c t i o n r u n s a s y n c r o n o u s l y a n d t h e r e f o r e d o e s n o t c o n n e c t t o R a d e x i m m e d i a t e l y o n c e c a l l e d . T h e c o n n e c t f u n c t i o n p r o v i d e s a c a l l b a c k f u n c t i o n a s a n o p t i o n a l 2 n d p a r a m t e r . T h i s c a l l b a c k f u n c t i o n w i l l b e c a l l e d a s s o o n a s a c o n n e c t i o n w i t h R a d e x h a s b e e n e s t a b l i s h e d a n d c a n b e u s e d t o s e t a n y i n i t i a l R a d e x s t a t e v a r i a b l e s ( e . g . * c u r r e n t P a i r * s t a t e v a r i a b l e ) . e . g . T o s e t t h e i n i t i a l * c u r r e n t P a i r * t o " B T C - X R D " a n d t h e i n i t i a l * p a i r S l i c e D u r * t o " 1 5 m " y o u c o u l d d o i t l i k e t h i s : ` ` ` r a d e x . c o n n e c t ( " w s s : / / r a d e x - a p i . h e r o k u a p p . c o m " , o n O p e n ) ; f u n c t i o n o n O p e n ( ) { r a d e x . s t a t e . s e t C u r r e n t P a i r ( " B T C - X R D " ) ; / / e x a m p l e u s a g e r a d e x . s t a t e . p a i r S l i c e D u r ( " 1 5 m " ) ; / / e x a m p l e u s a g e } ` ` ` I f y o u t r y t o s e t R a d e x s t a t e v a r i a b l e s b e f o r e t h e c o n n e c t i o n t o R a d e x i s e s t a b l i s h e d , i t w i l l n o t w o r k . # # # A c c e s s i n g R a D E X s t a t e v a r i a b l e s Y o u c a n a c c e s s a l l t h e r a d e x - j s s t a t e v a r i a b l e s t h r o u g h t h e i m p o r t e d * s t a t e * v a r i a b l e . E . g . t o a c c e s s t h e * c o n n e c t e d * s t a t e v a r i a b l e y o u w i l l h a v e s o m e t h i n g l i k e t h i s : ` ` ` c o n s t a n t c o n n e c t e d T o R a d e x = r a d e x . s t a t e . c o n n e c t e d ; / / e x a m p l e u s a g e ` ` ` # # R a D E X f u n c t i o n s r a d e x - j s p r o v i d e s f u n c t i o n s t o s u b m i t a n d c a n c e l o r d e r s . # # # s u b m i t O r d e r f u n c t i o n T h e * s u b m i t O r d e r * f u n c t i o n i s u s e d t o s u b m i t a n e w o r d e r t o R a D E X . # # # # U s a g e : ` ` ` r a d e x . s u b m i t O r d e r ( o r d e r O b j ) ` ` ` # # # # P a r a m a t e r s : ` ` ` o r d e r O b j = { o w n e r : s t r i n g * / / i d o f w a l l e t t h a t i s s u b m i t t i n g t h e o r d e r p a i r : s t r i n g * / / c o d e o f p a i r t h a t t h i s o r d e r i s f o r t o k e n 1 : s t r i n g * / / c o d e o f t o k e n 1 o f p a i r t o k e n 2 : s t r i n g * / / c o d e o f t o k e n 2 o f p a i r s i d e : O r d e r S i d e * / / s i d e o f t h i s o r d e r ( s e e O r d e r S i d e e n u m ) t y p e : O r d e r T y p e * / / t y p e o f o r d e r ( s e e O r d e r T y p e e n u m ) q u a n t i t y : n u m b e r * 1 / / q u a n t i t y o f t o k e n 1 s p e c i f i e d f o r o r d e r p r i c e : n u m b e r * 2 / / p r i c e f o r o r d e r , s p e c i f i e d i n t o k e n 2 t e r m s v a l u e : n u m b e r * 3 / / v a l u e o f o r d e r s p e c f i e d a s t o k e n 2 q u a n t i t y q u a n t i t y S p e c i f i e d : b o o l e a n ( t r u e i f n o t s p e c i f e i d ) / / w h e t h e r e x a c t o r d e r q u a n t i t y o r v a l u e m u s t b e f u l f i l l e d } * r e q u i r e d f i e l d s * 1 q u a n t i t y i s r e q u i r e d i f o r d e r t y p e i s n o t " M A R K E T " a n d q u a n i t y S p e c i f i e d i s t r u e * 2 p r i c e i s r e q u i r e d i f o r d e r t y p e i s n o t " M A R K E T " * 3 v a l u e i s r e q u i r e d i f o r d e r t y p e i s n o t " M A R K E T " a n d q u a n t i t y S p e c i f i e d i s f a l s e . ` ` ` # # # # R e t u r n v a l u e T h e * s u b m i t O r d e r * f u n c t i o n r e t u r n s a p r o m i s e w i t h a r e s u l t o b j e c t ` ` ` P r o m i s e <

Package Sidebar

Install

npm i radex-js

Weekly Downloads

1

Version

1.0.24

License

ISC

Unpacked Size

86.5 kB

Total Files

18

Last publish

Collaborators

  • fliebenberg