Network.Ethereum.Uport

data UPORT :: Effect

This effect is used to annotate code which possibly uses Uport lib for signing etherium transactions.

type OptionsBuilder eff = Options eff -> Options eff

Builder type for Options used to construct Connect

type Options eff = { appName :: Maybe AppName, clientId :: Maybe ClientId, network :: Maybe Network, signer :: Maybe (Signer eff) }

A Type used to create Connect

type Credentials eff = { clientId :: ClientId, network :: Network, signer :: Signer eff }

data Connect :: Type

An instance of Connect class from uport-connect

newtype ClientId

Constructors

• ClientId String

newtype AppName

A type used for representing Uport application name

Constructors

• AppName String

withNetwork :: forall eff. Network -> Options eff -> Options eff

A combinator used as part of OptionsBuilder, it set's network on which Connect will operate. Example:

connect
  $ withAppName (AppName "MyApp")
  >>> withNetwork rinkeby

withCredentials :: forall eff. Credentials eff -> Options eff -> Options eff

A combinator used as part of OptionsBuilder, it set's Uport application credentials (used when signed requests are requried). Example:

connect
  $ withAppName (AppName "MyApp")
  >>> withCredentials myAppCredentials

withAppName :: forall eff. AppName -> Options eff -> Options eff

A combinator used as part of OptionsBuilder, it set's Uport application name. Example:

connect
  $ withAppName (AppName "MyApp")
  >>> withNetwork rinkeby

optionsDefaults :: forall eff. OptionsBuilder eff

OptionsBuilder which could be used to create Connect using default options

getProvider :: forall eff. Connect -> Eff (uport :: UPORT | eff) Provider

Instantiates and returns a web3 styple provider wrapped with uPort functionality

connect :: forall eff. OptionsBuilder eff -> Eff (exception :: EXCEPTION, uport :: UPORT | eff) Connect

type NetworkR = { id :: String, registry :: String, rpcUrl :: String }

Represents Network configuration object.

data Network :: Type

Type representing Etherium Network on which all operations will be performed.

ropsten :: Network

Predefined Network configuration value for "ropsten"

rinkeby :: Network

Predefined Network configuration value for "rinkeby"

mkNetwork :: NetworkR -> Network

Constructs Network configuration object

mkNetwork
  { id: "0x1"
  , registry: "0xab5c8051b9a1df1aab0149f8b0630848b7ecabf6"
  , rpcUrl: "https://mainnet.infura.io"
  }

mainnet :: Network

Predefined Network configuration value for "mainnet"

kovan :: Network

Predefined Network configuration value for "kovan"

newtype SigningInput

Input to signing function

Constructors

• SigningInput String

type SignerCallback eff = EffFn2 eff (Nullable Error) (Nullable Signature) Unit

data Signer :: Row Effect -> Type

Signing function which will be used to sign JWT's in the credentials object. It could be constracted out of mkSigner or more low level function fromRawSigner.

newtype Signature

Result of signing function.

Constructors

• Signature String

type RawSigner eff = EffFn2 eff SigningInput (SignerCallback eff) Unit

Low level representation of Signer

mkSigner :: forall eff. (SigningInput -> Aff eff Signature) -> Eff eff (Signer eff)

Takes Aff based signing function and retusn Signer.

fromRawSigner :: forall eff. RawSigner eff -> Signer eff

newtype PrivateKey

Type containing private key, passed to SimpleSigner function from uport module.

simpleSigner :: forall eff. PrivateKey -> Signer (exception :: EXCEPTION | eff)

Creates Signer from from PrivateKey using SimpleSigner function from uport module.

mkPrivateKey :: String -> PrivateKey

Constructs PrivateKey