propulsor / zap-nodejs Goto Github PK

• BaseContract
  • Parameters
  • getContractOwner
• ZapArbiter
  • Parameters
  • initiateSubscription
  • getSubscription
  • endSubscriptionSubscriber
  • endSubscriptionProvider
  • listenSubscriptionEnd
  • listenSubscriptionStart
  • listen
• getArtifacts
• ZapBondage
  • Parameters
  • bond
  • unbond
  • getBoundDots
  • calcZapForDots
  • calcBondRate
  • currentCostOfDot
  • getDotsIssued
  • getZapBound
  • listen
  • listenBound
  • listenUnbound
  • listenEscrowed
  • listenReleased
• Curve
  • structurize
  • getPrice
  • convertToBNArrays
• ZapDispatch
  • Parameters
  • queryData
  • respond
  • listen
  • listenIncoming
  • listenFulfillQuery
  • listenOffchainResponse
• ZapProvider
  • initiateProvider
  • initiateProviderCurve
  • getTitle
  • getPubkey
  • getCurve
  • getZapBound
  • getZapRequired
  • calcDotsForZap
  • listenSubscribes
  • listenUnsubscribes
  • listenQueries
  • respond
• ZapRegistry
  • Parameters
  • initiateProvider
  • initiateProviderCurve
  • setEndpointParams
  • getProviderPublicKey
  • getProviderTitle
  • getProviderCurve
  • getNextProvider
  • getNextEndpointParams
  • listen
  • listenNewProvider
  • listenNewCurve
• Subscriber
  • bond
  • unBond
  • subscribe
  • hasEnoughZap
• ZapToken
  • Parameters
  • balanceOf
  • send
  • allocate
  • approve

Parent Class to Dispatch, Bondage, Arbiter, Token, Registry class Provide access to contract instance and web3 provider instance

• artifactsDir (string | null)
• artifactName string
• networkId (number | null)
• networkProvider (any | null) : Ethereum network provider

Get Contract owner address

Returns Promise<string> owner's address of this contract instance

Returns Promise<string> owner's address of this contract instance

Extends BaseContract

Provides interface to Arbiter contract for managing subscriptions activities

• _a
• artifactsDir string
• networkId string
• networkProvider : Ethereum network provider

Start subscription with a provider's endpoint

• _a
• provider address
• endpoint string
• endpoint_params Array<string>
• blocks number that subscription will last
• provider number 's public key
• from address : subscriber
• gas number (optional)

Returns Promise<txid> txid of init transaction

• _a
• provider address
• subscriber address
• endpoint string

Returns Promise<string> Subscription Information

• _a
• provider address
• endpoint string
• from address : subscriber
• gas number

Returns Promise<txid> unsubscribe txid

• _a
• subscriber address
• endpoint string
• from address : provider
• gas number

Returns Promise<txid>

• filters Filter object
• callback Function

• filters Filter
• callback Function

• filter Filter
• callback Function

Get Artifacts in this package

Returns any Artifacts

Extends BaseContract

Manage bondage activities

• artifactsDir any
• artifactName any
• networkId any
• networkProvider any

Bond number of Zap Token from a subscriber to a provider's endpoint, this requires approved Zap Token from subscriber to Bondage contract

• _a
• provider address
• endpoint string
• zapNum number : number of Zap Token to bond
• from address : subscriber
• gas number

Returns Promise<txid>

Unbond number of dots from a subscriber to a provider's endpoint

• _a
• provider address
• endpoint string
• dots number
• from address : subscriber
• gas number

Returns Promise<txid>

Get number of dots that are bounded to a provider's endpoint for a subscriber

• _a
• subscriber address
• provider address
• endpoint string

Returns Promise<number> : number of bound dots

Calculate Zap required to bond number of dots to a provider's endpoint

• _a
• provider address
• endpoint string
• dots number : number of dots that subscriber wants to use

Returns Promise<number> : number of Zap required to bond to use inquired dots

Calculate Bond's rate for a provider's endpoint

• _a
• provider address
• endpoint string
• inquired number zapNum to see how many dots can subscriber get

Returns Promise<number> : number of dots that can be used with inquired Zap Tokens

Get Zap Token cost of next inquired dots

• _a
• provider address
• endpoint string
• dots number : dots that subscriber want to use

Returns Promise<number> : Price of inquired dots

Get the amount of dots that have been issued for a provider's endpoint

• _a
• provider address
• endpoint string

Returns Promise<number> : number of issued dots

Get amount of Zap tokens that are bound to a provider's endpoint

• _a
• provider address
• endpoint string

Returns Promise<number> number of bound Zap tokens

Listen to all Bondage contract's events with optional filters

• filters Filter?
• callback Function

Listen to Bonding events

• filters Filter?
• callback Function

Listen to Unbonding events

• filters Filter
• callback Function

Listen to Escrow events

• filters Filter
• callback Function

Listen to Release Bound Zap Tokens events

• filters Filter
• callback Function

Turn constants, parts, dividers into curve's coef, power, fn, pieces

Get the price of a dot at a given totalBound

• total number bound dots

Returns number

Convert this curve constants, parts, dividers into Array of Bignumbers

Returns Array<Array<BigNumber>>

Extends BaseContract

Provides interface to Dispatch contract

• artifactsDir string
• networkId number
• networkProvider : Ethereum provider instance

Subscriber query data to a provider's endpoint

• _a
• provider address
• query string
• endpoint string
• endpointParams Array<string>
• onchainProvider boolean
• onchainSubscriber boolean
• from address
• gas BigNumber

Returns Promise<txid> txid of query transaction

Provider responds to a query it received

• _a
• queryId string
• responseParams Array<string>
• dynamic boolean number of responses string
• from address : provider
• gas BigNumber

Returns Promise<txid> txid of respond method

Listen for all events with filters

• filters Filter
• callback Function

Listen to Query Incoming events with filters

• filters object
• callback Function

Listen to FUlFill Query when providers respond

• filters object
• callback Function

Listen to Offchain responses from providers

• filters object
• callback Function

Call ZapRegistry to create a new provider in Registry contract

• _a
• public_key string
• title string
• endpoint string
• endpoint_params Array<string>

Returns Promise<txid>

Initiate Curve for an endpoint

• _a
• endpoint string
• constants Array<number>
• parts Array<number>
• dividers Array<number>

Returns Promise<txid>

Get title of this provider from Registry contract

Returns Promise<string>

Get public key of this provider from Registry contract

Returns Promise<string>

Get Curve of an owned endpoint

• endpoint string

Returns Promise<CurveType>

Get amount Zap bound to an owned endpoint

• endpoint string

Returns Promise<number> number of Zap Token bound

• _a
• endpoint
• dots

Returns Promise<number>

Calculate number of dots that subscriber can use for inquired number of Zap Tokens

• _a
• endpoint string
• zapNum number

Returns Promise<number> number of dots subscriber can get

listen to new subscription events to this provider, managed by Arbiter contract

• _a
• subscriber string
• fromBlock number

Returns Promise<void>

Listen to unsubscription events to this provider, managed by Arbiter contract

• _a
• subscriber string
• terminator string : address that call unsubscribe, this can be subscriber or provider
• fromBlock number

Returns Promise<void>

Listen to Queries events, managed by Dispatch contract

• _a
• queryId string
• subscriber address
• fromBlock number

Returns Promise<void>

Respond to a query

• _a
• queryId string
• responseParams Array<string>
• dynamic boolean number of responses or not

Returns Promise<any>

Extends BaseContract

Manage Providers and Curves registration

• artifactsDir any
• networkId any
• networkProvider any

Add a brand new provider in Registry contract, distinguished by provider's address

• _a
• provider string 's public_key
• provider string 's title
• endpoint string
• endpoint_params Array<string>
• from address : provider's address
• gas BigNumber

Returns Promise<txid>

Set Curve for a provider's endpoint Curve can only be set once per endpoint

• _a
• endpoint string
• curve CurveType
• from address : provider
• gas BigNumber

Returns Promise<txid>

Provider can set endpoint params for owned endpoint

• _a
• endpoint string
• endpoint_params Array<string>
• from address : provider
• gas BigNumber

Returns Promise<txid>

Get a provider's public key from Registry contract

• provider address

Returns Promise<number>

Get a provider's title from Registry contract

• provider address

Returns Promise<string>

Get a provider's endpoint's curve from Registry contract

• provider string
• endpoint string

Returns Promise<CurveType>

Get provider in index +1 in Registry contract

• index of next provider

Returns Promise<any>

Get endpoint params at index of a provider's endpoint

• _a
• provider address
• endpoint string
• index number

Returns Promise<string> endpoint's param at index

Listen to all Registry contract events with filters

• filters Filter
• callback Function

Returns Promise<void>

Listen to Registry contracts events for new providers

• filters Filter
• callback Promise<void>

Listen to Registry contract's events for new providers' curve

• provider address
• callback Promise<void>

• _a
• provider string
• endpoint string
• zapNum number

Returns Promise<any>

• _a
• provider string
• endpoint string
• dots number

Returns Promise<any>

• _a
• provider string
• endpoint string
• endpointParams Array<string>
• dots number

Returns Promise<any>

• zapRequired number

Returns Promise<boolean>

Extends BaseContract

ERC20 Tokens methods for Zap Tokens

• artifactsDir string?
• artifactName string
• networkId string?
• networkProvider string?

Get Zap Token balance of address

• address address

Returns Promise<number> Zap balance

Transfer Zap Token

• _a
• to address
• amount number
• from address
• gas number

Returns Promise<txid>

Allocate Zap Token from Zap contract owner to an address

• _a
• to address
• amount number
• from address
• gas number

Returns Promise<txid>

Approve Zap Token to an address

• _a
• to address
• amount number
• from address
• gas number

Returns Promise<txid>