API Reference TS¶
This page contains a list of all Datastructures and Classes used within the TypeScript IN3 Client.
Examples¶
This is a collection of different incubed-examples.
using Web3¶
Since incubed works with on a JSON-RPC-Level it can easily be used as Provider for Web3:
// import in3-Module
import In3Client from 'in3'
import * as web3 from 'web3'
// use the In3Client as Http-Provider
const web3 = new Web3(new In3Client({
proof : 'standard',
signatureCount: 1,
requestCount : 2,
chainId : 'mainnet'
}).createWeb3Provider())
// use the web3
const block = await web.eth.getBlockByNumber('latest')
...
using Incubed API¶
Incubed includes a light API, allowinng not only to use all RPC-Methods in a typesafe way, but also to sign transactions and call funnctions of a contract without the web3-library.
For more details see the API-Doc
// import in3-Module
import In3Client from 'in3'
// use the In3Client
const in3 = new In3Client({
proof : 'standard',
signatureCount: 1,
requestCount : 2,
chainId : 'mainnet'
})
// use the api to call a funnction..
const myBalance = await in3.eth.callFn(myTokenContract, 'balanceOf(address):uint', myAccount)
// ot to send a transaction..
const receipt = await in3.eth.sendTransaction({
to : myTokenContract,
method : 'transfer(address,uint256)',
args : [target,amount],
confirmations: 2,
pk : myKey
})
...
Reading event with incubed¶
// import in3-Module
import In3Client from 'in3'
// use the In3Client
const in3 = new In3Client({
proof : 'standard',
signatureCount: 1,
requestCount : 2,
chainId : 'mainnet'
})
// use the ABI-String of the smart contract
abi = [{"anonymous":false,"inputs":[{"indexed":false,"name":"name","type":"string"},{"indexed":true,"name":"label","type":"bytes32"},{"indexed":true,"name":"owner","type":"address"},{"indexed":false,"name":"cost","type":"uint256"},{"indexed":false,"name":"expires","type":"uint256"}],"name":"NameRegistered","type":"event"}]
// create a contract-object for a given address
const contract = in3.eth.contractAt(abi, '0xF0AD5cAd05e10572EfcEB849f6Ff0c68f9700455') // ENS contract.
// read all events starting from a specified block until the latest
const logs = await c.events.NameRegistered.getLogs({fromBlock:8022948}))
// print out the properties of the event.
for (const ev of logs)
console.log(`${ev.owner} registered ${ev.name} for ${ev.cost} wei until ${new Date(ev.expires.toNumber()*1000).toString()}`)
...
Main Module¶
Importing incubed is as easy as
import Client,{util} from "in3"
While the In3Client-class is the default import, the following imports can be used:
anytransport.AxiosTransport_ethapi.defaultany_cboraliases_chainDatanumber[]_header_serializeany_storageany_transporttypes.validationDefany_utilanyvalidateOb.validate
Package client¶
Type Client¶
Source: client/Client.ts
Client for N3.
numbernumberthisPromise<any>voidanybooleanstring)numbernumberthisthisthisthisthisthisthisPromise<>thisnumber)Promise<void>Promise<void>Promise<boolean>
Type ChainContext¶
Source: client/ChainContext.ts
Context for a specific chain including cache and chainSpecs.
stringnumberstringvoidstring)number)stringstring)voidvoidstring,value:string)voidstring)
Type Module¶
Source: client/modules.ts
stringPromise<boolean>
Package index.ts¶
Type AccountProof¶
Source: index.ts
the Proof-for a single Account the Proof-for a single Account
string[]stringstringstringstringstringstring
Type AuraValidatoryProof¶
Source: index.ts
a Object holding proofs for validator logs. The key is the blockNumber as hex a Object holding proofs for validator logs. The key is the blockNumber as hex
stringany[]numberstring[]number
Type ChainSpec¶
Source: index.ts
describes the chainspecific consensus params describes the chainspecific consensus params
numbernumberstring'ethHash'|'authorityRound'|'clique'string[]boolean
Type IN3Client¶
Source: index.ts
Client for N3. Client for N3.
numbernumberthisPromise<any>voidanybooleanstring)numbernumberthisthisthisthisthisthisthisPromise<>thisnumber)Promise<void>Promise<void>Promise<boolean>
Type IN3Config¶
Source: index.ts
the iguration of the IN3-Client. This can be paritally overriden for every request. the iguration of the IN3-Client. This can be paritally overriden for every request.
booleanbooleanbooleanbooleananynumberstringstringnumbernumber'json'|'jsonRef'|'cbor'booleanbooleanbooleananystringstringnumbernumbernumbernumberbooleannumber'none'|'standard'|'full'booleannumbernumberbooleanstringnumbernumberbooleanstring[]string[]string
Type IN3NodeConfig¶
Source: index.ts
a configuration of a in3-server. a configuration of a in3-server.
stringnumberstring[]numbernumbernumbernumbernumbernumberstring
Type IN3NodeWeight¶
Source: index.ts
a local weight of a n3-node. (This is used internally to weight the requests) a local weight of a n3-node. (This is used internally to weight the requests)
numbernumbernumbernumbernumbernumber
Type IN3RPCConfig¶
Source: index.ts
the configuration for the rpc-handler the configuration for the rpc-handler
stringstringnumber
Type IN3RPCHandlerConfig¶
Source: index.ts
the configuration for the rpc-handler the configuration for the rpc-handler
stringnumber'eth'|'ipfs'|'btc'stringnumbernumberstringstringstringstringstringstringnumbernumbernumbernumber
Type IN3RPCRequestConfig¶
Source: index.ts
additional config for a IN3 RPC-Request additional config for a IN3 RPC-Request
stringanynumberbooleannumberstring[]booleanbooleanboolean'never'|'proof'|'proofWithSignature'string[]stringstring
Type IN3ResponseConfig¶
Source: index.ts
additional data returned from a IN3 Server additional data returned from a IN3 Server
numbernumbernumbernumberstring
Type LogProof¶
Source: index.ts
a Object holding proofs for event logs. The key is the blockNumber as hex a Object holding proofs for event logs. The key is the blockNumber as hex
Type Proof¶
Source: index.ts
the Proof-data as part of the in3-section the Proof-data as part of the in3-section
stringany[]string[]string[]any[]numberstring[]'transactionProof'|'receiptProof'|'blockProof'|'accountProof'|'callProof'|'logProof'any[]
Type RPCRequest¶
Source: index.ts
a JSONRPC-Request with N3-Extension a JSONRPC-Request with N3-Extension
Type RPCResponse¶
Source: index.ts
a JSONRPC-Responset with N3-Extension a JSONRPC-Responset with N3-Extension
stringstring|number'2.0'any
Type ServerList¶
Source: index.ts
a List of nodes a List of nodes
stringnumberstringnumber
Type Signature¶
Source: index.ts
Verified ECDSA Signature. Signatures are a pair (r, s). Where r is computed as the X coordinate of a point R, modulo the curve order n. Verified ECDSA Signature. Signatures are a pair (r, s). Where r is computed as the X coordinate of a point R, modulo the curve order n.
stringnumberstringstringstringstringnumber
Package modules/eth¶
Type EthAPI¶
Source: modules/eth/api.ts
Promise<number>Promise<string>Promise<any>Promise<string>anyPromise<number>Promise<number>boolean)boolean)Promise<number>Promise<number>Promise<string>Promise<>Promise<>Promise<>Promise<string>Promise<number>Promise<number>Promise<number>Promise<string>Promise<string>Promise<string>Promise<string>Promise<string>Promise<>Promise<>
Type chainData¶
Source: modules/eth/chainData.ts
Promise<any>Promise<>
Type header¶
Source: modules/eth/header.ts
Promise<void>voidPromise<number>any[],getChainSpec:)voidPromise<void>
Type Signer¶
Source: modules/eth/api.ts
Promise<boolean>
Type Transaction¶
Source: modules/eth/api.ts
anystring
Type ABI¶
Source: modules/eth/api.ts
booleanbooleanstringboolean'nonpayable'|'payable'|'view'|'pure''event'|'function'|'constructor'|'fallback'
Type Log¶
Source: modules/eth/api.ts
boolean
Type Block¶
Source: modules/eth/api.ts
string| []
Type LogFilter¶
Source: modules/eth/api.ts
string|string[] []
Type TransactionDetail¶
Source: modules/eth/api.ts
anyany
Type TransactionReceipt¶
Source: modules/eth/api.ts
Type TxRequest¶
Source: modules/eth/api.ts
any[]numbernumbernumberstringnumber
Type HistoryEntry¶
Source: modules/eth/header.ts
numberstring[]string[]
Package modules/ipfs¶
Type IpfsAPI¶
Source: modules/ipfs/api.ts
simple API for IPFS
Package util¶
a collection of util classes inside incubed. They can be get directly through require('in3/js/srrc/util/util')
Type DeltaHistory¶
Source: util/DeltaHistory.ts
boolean)voidnumber)numbervoidstring[])string[]
Common Module¶
The common module (in3-common) contains all the typedefs used in the node and server.
_transport.AxiosTransport_serialize.Blockanyany)string)anyany)anyany)anyany)_cbor_util.aliasesnumber[]anyany)_serialize.rlp_serialize_storageObject_transportanyany)anyany)anyany)_util_validate
Package index.ts¶
Type BlockData¶
Source: index.ts
Block as returned by eth_getBlockByNumber Block as returned by eth_getBlockByNumber
stringstring|numberstringstring|numberstring|numberstringstringstringstringstring|numberstring|numberstringstringstringstring[]stringstringstring|numberany[]stringstring[]
Type LogData¶
Source: index.ts
LogData as part of the TransactionReceipt LogData as part of the TransactionReceipt
stringstringstringstringstringbooleanstring[]stringstringstring
Type ReceiptData¶
Source: index.ts
TransactionReceipt as returned by eth_getTransactionReceipt TransactionReceipt as returned by eth_getTransactionReceipt
stringstring|numberstring|numberstring|numberstringstringstring|booleanstringnumber
Type TransactionData¶
Source: index.ts
Transaction as returned by eth_getTransactionByHash Transaction as returned by eth_getTransactionByHash
stringnumber|stringnumber|stringstringstringstringstringnumber|stringnumber|stringnumber|stringstringstringnumber|stringstringstringstringstringstringstringnumberstringnumber|string
Type Transport¶
Source: index.ts
A Transport-object responsible to transport the message to the handler. A Transport-object responsible to transport the message to the handler.
Package modules/eth¶
Type Block¶
Source: modules/eth/serialize.ts
encodes and decodes the blockheader
Type Receipt¶
Source: modules/eth/serialize.ts
Buffer[] of the Receipt = [ Buffer ,Buffer ,Buffer ,Buffer , Buffer [] , Buffer [] ]
Type serialize¶
Source: modules/eth/serialize.ts
ethUtil.rlpanyany)string)stringany)anyany)anyany)anyany)anyany)anyany)Objectanyany)anyany)anyany)
Type storage¶
Source: modules/eth/storage.ts
anynumber,arrayIndex:number,structSize:number,structPos:number)anynumber,key:string,structPos:number)Promise<>string,contract:string,pos:number,type:'address'|'bytes32'|'bytes16'|'bytes4'|'int'|'string',keyOrIndex:number|string,structSize:number,structPos:number)string|stringnumber)any)
Type AccountData¶
Source: modules/eth/serialize.ts
Account-Object
stringstringstringstringstring
Package types¶
Type RPCResponse¶
Source: types/types.ts
a JSONRPC-Responset with N3-Extension
stringstring|number'2.0'any
Type IN3RPCRequestConfig¶
Source: types/types.ts
additional config for a IN3 RPC-Request
stringanynumberbooleannumberstring[]booleanbooleanboolean'never'|'proof'|'proofWithSignature'string[]string
Type IN3ResponseConfig¶
Source: types/types.ts
additional data returned from a IN3 Server
numbernumbernumberstring
Type IN3NodeConfig¶
Source: types/types.ts
a configuration of a in3-server.
stringnumberstring[]numbernumbernumbernumbernumbernumberstring
Type Proof¶
Source: types/types.ts
the Proof-data as part of the in3-section
stringany[]string[]string[]any[]numberstring[]'transactionProof'|'receiptProof'|'blockProof'|'accountProof'|'callProof'|'logProof'any[]
Type LogProof¶
Source: types/types.ts
a Object holding proofs for event logs. The key is the blockNumber as hex
Type Signature¶
Source: types/types.ts
Verified ECDSA Signature. Signatures are a pair (r, s). Where r is computed as the X coordinate of a point R, modulo the curve order n.
stringnumberstringstringstringstringnumber
Package util¶
Type AxiosTransport¶
Source: util/transport.ts
Default Transport impl sending http-requests.
Type cbor¶
Source: util/cbor.ts
anyany)anyany)string[])string[])
Type transport¶
Source: util/transport.ts
Type util¶
Source: util/util.ts
ethUtil.BNanyrequire('buffer').Buffernumber[]stringstring)stringstring)stringstring,minLength:number,fill:string)stringstring,minLength:number,fill:string)Promise<any>any,fn:any,args:any[])any)anyany,len:number)stringany,bytes:number)stringnumberany)stringstring)stringany)
Type validate¶
Source: util/validate.ts
new Ajv()voidany,def:any)voidany)