Even though the incubed client is written in C, we are using emscripten to build wasm. Together with some binding-code incubed runs in any Javascript-Runtime. Using WASM gives us 3 important features:
-
Performance. Since WASM runs at almost native speed it is very fast
-
Security Since the WASM-Module has no dependencies it reduces the risk of using a malicious dependency, which would be able to manipulate Prototypes. Also, since the real work is happening inside the wasm, trying to change Prototype would not work.
-
Size The current wasm-file is about 200kb. This is smaller then most other libraries and can easily be used in any app or website.
This client uses the in3-core sources compiled to wasm. The wasm is included into the js-file wich makes it easier to include the data. This module has no dependencies! All it needs is included inta a wasm of about 300kB.
Installing incubed is as easy as installing any other module:
npm install --save in3-wasm
Even though most browsers and javascript enviroment such as nodejs, have full support for wasm, there are ocasions, where WASM is fully supported. In case you want to run incubed within a react native app, you might face such issues. In this case you can use in3-asmjs, which has the same API, but runs on pure javascript (a bit slower and bigger, but full support everywhere).
In order to build the wasm or asmjs from source you need to install emscripten first. In case you have not done it yet:
# Get the emsdk repo
git clone https://github.com/emscripten-core/emsdk.git
# Enter that directory
cd emsdk
# install the latest-upstream sdk and activate it
./emsdk install latest-upstream && ./emsdk activate latest-upstream# Please make sure you add this line to your .bash_profile or .zshrc
source <PATH_TO_EMSDK>/emsdk_env.sh > /dev/nullWith emscripten set up, you can now configure the wasm and build it (in the in3-c directory):
# create a build directory
mkdir -p build
cd build
# configure CMake
emcmake cmake -DWASM=true -DCMAKE_BUILD_TYPE=MINSIZEREL ..
# and build it
make -j8 in3_wasm
# optionally you can also run the tests
make testPer default the generated wasm embedded the wasm-data as base64 and resulted in the build/module.
If you want to build asmjs, use the -DASMJS=true as an additional option.
If you don't want to embedd the wasm, add -DWASM_EMBED=false.
If you want to set the -DCMAKE_BUILD_TYPE=DEBUG your filesize increases but all function names are kept (resulting in readable stacktraces) and emscriptten will add a lot of checks and assertions.
For more options please see the CMake Options.
source : in3-c/wasm/examples/get_block_rpc.js
read block as rpc
/// read block as rpc
const IN3 = require('in3-wasm')
async function showLatestBlock() {
// create new incubed instance
var c = new IN3()
await c.setConfig({
chainId: 0x5 // use goerli
})
// send raw RPC-Request (this would throw if the response contains an error)
const lastBlockResponse = await c.sendRPC('eth_getBlockByNumber', ['latest', false])
console.log("latest Block: ", JSON.stringify(lastBlockResponse, null, 2))
// clean up
c.free()
}
showLatestBlock().catch(console.error)source : in3-c/wasm/examples/get_block_api.ts
read block with API
/// read block with API
import { IN3 } from 'in3-wasm'
async function showLatestBlock() {
// create new incubed instance
const client = new IN3({
chainId: 'goerli'
})
// send raw RPC-Request
const lastBlock = await client.eth.getBlockByNumber()
console.log("latest Block: ", JSON.stringify(lastBlock, null, 2))
// clean up
client.free()
}
showLatestBlock().catch(console.error)source : in3-c/wasm/examples/register_pugin.ts
register a custom plugin
/// register a custom plugin
import { IN3, RPCRequest } from 'in3-wasm'
import * as crypto from 'crypto'
class Sha256Plugin {
// this function will register for handling rpc-methods
// only if we return something other then `undefined`, it will be taken as the result of the rpc.
// if we don't return, the request will be forwarded to the incubed nodes
handleRPC(c: IN3, request: RPCRequest): any {
if (request.method === 'sha256') {
// assert params
if (request.params.length != 1 || typeof (request.params[0]) != 'string')
throw new Error('Only one parameter with as string is expected!')
// create hash
const hash = crypto.createHash('sha256').update(Buffer.from(request.params[0], 'utf8')).digest()
// return the result
return '0x' + hash.toString('hex')
}
}
}
async function registerPlugin() {
// create new incubed instance
const client = new IN3()
// register the plugin
client.registerPlugin(new Sha256Plugin())
// exeucte a rpc-call
const result = await client.sendRPC("sha256", ["testdata"])
console.log(" sha256: ", result)
// clean up
client.free()
}
registerPlugin().catch(console.error)source : in3-c/wasm/examples/use_web3.ts
use incubed as Web3Provider in web3js
/// use incubed as Web3Provider in web3js
// import in3-Module
import { IN3 } from 'in3-wasm'
const Web3 = require('web3')
const in3 = new IN3({
proof: 'standard',
signatureCount: 1,
requestCount: 1,
chainId: 'mainnet',
replaceLatestBlock: 10
})
// use the In3Client as Http-Provider
const web3 = new Web3(in3.createWeb3Provider());
(async () => {
// use the web3
const block = await web3.eth.getBlock('latest')
console.log("Block : ", block)
})().catch(console.error);source : in3-c/wasm/examples/in3_in_browser.html
use incubed directly in html
<!-- use incubed directly in html -->
<html>
<head>
<script src="node_modules/in3-wasm/index.js"></script>
</head>
<body>
IN3-Demo
<div>
result:
<pre id="result"> ...waiting... </pre>
</div>
<script>
var in3 = new IN3({ chainId: 0x1, replaceLatestBlock: 6, requestCount: 3 });
in3.eth.getBlockByNumber('latest', false)
.then(block => document.getElementById('result').innerHTML = JSON.stringify(block, null, 2))
.catch(alert)
.finally(() => in3.free())
</script>
</body>
</html>In order to run those examples, you need to install in3-wasm and typescript first. The build.sh will do this and the run the tsc-compiler
./build.shIn order to run a example use
node build/get_block_api.ts
This page contains a list of all Datastructures and Classes used within the IN3 WASM-Client
Importing incubed is as easy as
import {IN3} from "in3-wasm"The WASM-Module comes with no dependencies. This means per default it uses the standard classes provided as part of the EMCAScript-Standard.
If you work with a library which expects different types, you can change the generic-type and giving a converter:
Per default we use bigint. This is used whenever we work with number too big to be stored as a number-type.
If you want to change this type, use setConverBigInt() function.
Per default we use UInt8Array. This is used whenever we work with raw bytes.
If you want to change this type, use setConverBuffer() function.
import {IN3Generic} from 'in3-wasm'
import BN from 'bn.js'
// create a new client by setting the Generic Types
const c = new IN3Generic<BN,Buffer>()
// set the converter-functions
IN3Generic.setConverBuffer(val => Buffer.from(val))
IN3Generic.setConverBigInt(val => new BN(val))While the In3Client-class is also the default import, the following imports can be used:
.. list-table::
:widths: auto
* - | `IN3 <#type-in3>`_
- | Class
- | default Incubed client with
| bigint for big numbers
| Uint8Array for bytes
* - | `IN3Generic <#type-in3generic>`_
- | Class
- | the IN3Generic
* - | `SimpleSigner <#type-simplesigner>`_
- | Class
- | the SimpleSigner
* - | `AccountAPI <#type-accountapi>`_
- | Interface
- | The Account API
* - | `BTCBlock <#type-btcblock>`_
- | Interface
- | a full Block including the transactions
* - | `BTCBlockHeader <#type-btcblockheader>`_
- | Interface
- | a Block header
* - | `BlockInfo <#type-blockinfo>`_
- | Interface
- | the BlockInfo
* - | `BtcAPI <#type-btcapi>`_
- | Interface
- | API for handling BitCoin data
* - | `BtcTransaction <#type-btctransaction>`_
- | Interface
- | a BitCoin Transaction.
* - | `BtcTransactionInput <#type-btctransactioninput>`_
- | Interface
- | a Input of a Bitcoin Transaction
* - | `BtcTransactionOutput <#type-btctransactionoutput>`_
- | Interface
- | a Input of a Bitcoin Transaction
* - | `DepositResponse <#type-depositresponse>`_
- | Interface
- | the DepositResponse
* - | `ETHOpInfoResp <#type-ethopinforesp>`_
- | Interface
- | the ETHOpInfoResp
* - | `EthAPI <#type-ethapi>`_
- | Interface
- | The API for ethereum operations.
* - | `Fee <#type-fee>`_
- | Interface
- | the Fee
* - | `IN3Config <#type-in3config>`_
- | Interface
- | the configuration of the IN3-Client. This can be changed at any time.
| All properties are optional and will be verified when sending the next request.
* - | `IN3NodeConfig <#type-in3nodeconfig>`_
- | Interface
- | a configuration of a in3-server.
* - | `IN3NodeWeight <#type-in3nodeweight>`_
- | Interface
- | a local weight of a n3-node. (This is used internally to weight the requests)
* - | `IN3Plugin <#type-in3plugin>`_
- | Interface
- | a Incubed plugin.
|
| Depending on the methods this will register for those actions.
|
* - | `IpfsAPI <#type-ipfsapi>`_
- | Interface
- | API for storing and retrieving IPFS-data.
* - | `RPCRequest <#type-rpcrequest>`_
- | Interface
- | a JSONRPC-Request with N3-Extension
* - | `RPCResponse <#type-rpcresponse>`_
- | Interface
- | a JSONRPC-Responset with N3-Extension
* - | `Signer <#type-signer>`_
- | Interface
- | the Signer
* - | `Token <#type-token>`_
- | Interface
- | the Token
* - | `Tokens <#type-tokens>`_
- | Interface
- | the Tokens
* - | `TxInfo <#type-txinfo>`_
- | Interface
- | the TxInfo
* - | `TxType <#type-txtype>`_
- | Interface
- | the TxType
* - | `Utils <#type-utils>`_
- | Interface
- | Collection of different util-functions.
* - | `Web3Contract <#type-web3contract>`_
- | Interface
- | the Web3Contract
* - | `Web3Event <#type-web3event>`_
- | Interface
- | the Web3Event
* - | `Web3TransactionObject <#type-web3transactionobject>`_
- | Interface
- | the Web3TransactionObject
* - | `ZKAccountInfo <#type-zkaccountinfo>`_
- | Interface
- | the ZKAccountInfo
* - | `ZksyncAPI <#type-zksyncapi>`_
- | Interface
- | API for zksync.
* - | `ABI <#type-abi>`_
- | Type literal
- | the ABI
* - | `ABIField <#type-abifield>`_
- | Type literal
- | the ABIField
* - | `Address <#type-address>`_
- | Type alias
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | `Block <#type-block>`_
- | Type literal
- | the Block
* - | `BlockType <#type-blocktype>`_
- | Type
- | BlockNumber or predefined Block
* - | `Data <#type-data>`_
- | Type alias
- | data encoded as Hex (starting with 0x)
* - | `Hash <#type-hash>`_
- | Type alias
- | a 32 byte Hash encoded as Hex (starting with 0x)
* - | `Hex <#type-hex>`_
- | Type
- | a Hexcoded String (starting with 0x)
* - | `Log <#type-log>`_
- | Type literal
- | the Log
* - | `LogFilter <#type-logfilter>`_
- | Type literal
- | the LogFilter
* - | `Quantity <#type-quantity>`_
- | Type
- | a BigInteger encoded as hex.
* - | `Signature <#type-signature>`_
- | Type literal
- | Signature
* - | `Transaction <#type-transaction>`_
- | Type literal
- | the Transaction
* - | `TransactionDetail <#type-transactiondetail>`_
- | Type literal
- | the TransactionDetail
* - | `TransactionReceipt <#type-transactionreceipt>`_
- | Type literal
- | the TransactionReceipt
* - | `TxRequest <#type-txrequest>`_
- | Type literal
- | the TxRequest
* - | `btc_config <#type-btc_config>`_
- | Interface
- | bitcoin configuration.
* - | `zksync_config <#type-zksync_config>`_
- | Interface
- | zksync configuration.
Source: index.d.ts
default Incubed client with bigint for big numbers Uint8Array for bytes
.. list-table::
:widths: auto
* - | `default <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L549>`_
- | `IN3Generic <#type-in3generic>`_
- | supporting both ES6 and UMD usage
* - | `util <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L542>`_
- | `Utils<any> <#type-utils>`_
- | collection of util-functions.
* - | `btc <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L526>`_
- | `BtcAPI<Uint8Array> <#type-btcapi>`_
- | btc API
* - | `config <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L426>`_
- | `IN3Config <#type-in3config>`_
- | IN3 config
* - | `eth <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L518>`_
- | `EthAPI<bigint,Uint8Array> <#type-ethapi>`_
- | eth1 API.
* - | `ipfs <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L524>`_
- | `IpfsAPI<Uint8Array> <#type-ipfsapi>`_
- | ipfs API
* - | `signer <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L482>`_
- | `Signer<bigint,Uint8Array> <#type-signer>`_
- | the signer, if specified this interface will be used to sign transactions, if not, sending transaction will not be possible.
* - | `util <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L531>`_
- | `Utils<Uint8Array> <#type-utils>`_
- | collection of util-functions.
* - | `zksync <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L522>`_
- | `ZksyncAPI<Uint8Array> <#type-zksyncapi>`_
- | zksync API
frees all Incubed instances.
static ``void`` `freeAll <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L512>`_ ()
registers a function to be called as soon as the wasm is ready. If it is already initialized it will call it right away.
static `Promise<T> <#type-t>`_ `onInit <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L506>`_ (
fn:() => `T <#type-t>`_ )
Parameters:
.. list-table::
:widths: auto
* - | fn
- | () => `T <#type-t>`_
- | the function to call
Returns:
static `Promise<T> <#type-t>`_
set convert big int
static ``any`` `setConvertBigInt <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L566>`_ (
convert:(``any``) => ``any``)
Parameters:
.. list-table::
:widths: auto
* - | convert
- | (``any``) => ``any``
- | convert
Returns:
static ``any``
set convert buffer
static ``any`` `setConvertBuffer <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L567>`_ (
convert:(``any``) => ``any``)
Parameters:
.. list-table::
:widths: auto
* - | convert
- | (``any``) => ``any``
- | convert
Returns:
static ``any``
changes the storage handler, which is called to read and write to the cache.
static ``void`` `setStorage <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L495>`_ (
handler:)
Parameters:
.. list-table::
:widths: auto
* - | handler
- |
- | handler
changes the default transport-function.
static ``void`` `setTransport <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L490>`_ (
fn:(``string`` , ``string`` , ``number``) => ``Promise<string>``)
Parameters:
.. list-table::
:widths: auto
* - | fn
- | (``string`` , ``string`` , ``number``) => ``Promise<string>``
- | the function to fetch the response for the given url
|
creates a new client.
`IN3 <#type-in3>`_ `constructor <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L557>`_ (
config:`Partial<IN3Config> <#type-in3config>`_ )
Parameters:
.. list-table::
:widths: auto
* - | config
- | `Partial<IN3Config> <#type-in3config>`_
- | a optional config
|
Returns:
`IN3 <#type-in3>`_
returns a Object, which can be used as Web3Provider.
const web3 = new Web3(new IN3().createWeb3Provider())
``any`` `createWeb3Provider <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L477>`_ ()
Returns:
``any``
disposes the Client. This must be called in order to free allocated memory!
``any`` `free <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L468>`_ ()
Returns:
``any``
rregisters a plugin. The plugin may define methods which will be called by the client.
``void`` `registerPlugin <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L537>`_ (
plugin:`IN3Plugin<bigint,Uint8Array> <#type-in3plugin>`_ )
Parameters:
.. list-table::
:widths: auto
* - | plugin
- | `IN3Plugin<bigint,Uint8Array> <#type-in3plugin>`_
- | the plugin-object to register
|
sends a raw request. if the request is a array the response will be a array as well. If the callback is given it will be called with the response, if not a Promise will be returned. This function supports callback so it can be used as a Provider for the web3.
`Promise<RPCResponse> <#type-rpcresponse>`_ `send <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L444>`_ (
request:`RPCRequest <#type-rpcrequest>`_ ,
callback:(`Error <#type-error>`_ , `RPCResponse <#type-rpcresponse>`_ ) => ``void``)
Parameters:
.. list-table::
:widths: auto
* - | request
- | `RPCRequest <#type-rpcrequest>`_
- | a JSONRPC-Request with N3-Extension
* - | callback
- | (`Error <#type-error>`_ , `RPCResponse <#type-rpcresponse>`_ ) => ``void``
- | callback
Returns:
`Promise<RPCResponse> <#type-rpcresponse>`_
sends a RPC-Requests specified by name and params.
if the response contains an error, this will be thrown. if not the result will be returned.
``Promise<any>`` `sendRPC <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L453>`_ (
method:``string``,
params:``any`` [])
Parameters:
.. list-table::
:widths: auto
* - | method
- | ``string``
- | the method to call.
|
* - | params
- | ``any`` []
- | params
Returns:
``Promise<any>``
sends a RPC-Requests specified by name and params as a sync call. This is only alowed if the request is handled internally, like web3_sha3,
if the response contains an error, this will be thrown. if not the result will be returned.
``any`` `sendSyncRPC <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L463>`_ (
method:``string``,
params:``any`` [])
Parameters:
.. list-table::
:widths: auto
* - | method
- | ``string``
- | the method to call.
|
* - | params
- | ``any`` []
- | params
Returns:
``any``
sets configuration properties. You can pass a partial object specifieing any of defined properties.
``void`` `setConfig <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L436>`_ (
config:`Partial<IN3Config> <#type-in3config>`_ )
Parameters:
.. list-table::
:widths: auto
* - | config
- | `Partial<IN3Config> <#type-in3config>`_
- | config
Source: index.d.ts
.. list-table::
:widths: auto
* - | `default <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L549>`_
- | `IN3Generic <#type-in3generic>`_
- | supporting both ES6 and UMD usage
* - | `util <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L542>`_
- | `Utils<any> <#type-utils>`_
- | collection of util-functions.
* - | `btc <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L526>`_
- | `BtcAPI<BufferType> <#type-btcapi>`_
- | btc API
* - | `config <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L426>`_
- | `IN3Config <#type-in3config>`_
- | IN3 config
* - | `eth <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L518>`_
- | `EthAPI<BigIntType,BufferType> <#type-ethapi>`_
- | eth1 API.
* - | `ipfs <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L524>`_
- | `IpfsAPI<BufferType> <#type-ipfsapi>`_
- | ipfs API
* - | `signer <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L482>`_
- | `Signer<BigIntType,BufferType> <#type-signer>`_
- | the signer, if specified this interface will be used to sign transactions, if not, sending transaction will not be possible.
* - | `util <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L531>`_
- | `Utils<BufferType> <#type-utils>`_
- | collection of util-functions.
* - | `zksync <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L522>`_
- | `ZksyncAPI<BufferType> <#type-zksyncapi>`_
- | zksync API
frees all Incubed instances.
static ``void`` `freeAll <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L512>`_ ()
registers a function to be called as soon as the wasm is ready. If it is already initialized it will call it right away.
static `Promise<T> <#type-t>`_ `onInit <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L506>`_ (
fn:() => `T <#type-t>`_ )
Parameters:
.. list-table::
:widths: auto
* - | fn
- | () => `T <#type-t>`_
- | the function to call
Returns:
static `Promise<T> <#type-t>`_
set convert big int
static ``any`` `setConvertBigInt <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L544>`_ (
convert:(``any``) => ``any``)
Parameters:
.. list-table::
:widths: auto
* - | convert
- | (``any``) => ``any``
- | convert
Returns:
static ``any``
set convert buffer
static ``any`` `setConvertBuffer <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L545>`_ (
convert:(``any``) => ``any``)
Parameters:
.. list-table::
:widths: auto
* - | convert
- | (``any``) => ``any``
- | convert
Returns:
static ``any``
changes the storage handler, which is called to read and write to the cache.
static ``void`` `setStorage <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L495>`_ (
handler:)
Parameters:
.. list-table::
:widths: auto
* - | handler
- |
- | handler
changes the default transport-function.
static ``void`` `setTransport <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L490>`_ (
fn:(``string`` , ``string`` , ``number``) => ``Promise<string>``)
Parameters:
.. list-table::
:widths: auto
* - | fn
- | (``string`` , ``string`` , ``number``) => ``Promise<string>``
- | the function to fetch the response for the given url
|
creates a new client.
`IN3Generic <#type-in3generic>`_ `constructor <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L426>`_ (
config:`Partial<IN3Config> <#type-in3config>`_ )
Parameters:
.. list-table::
:widths: auto
* - | config
- | `Partial<IN3Config> <#type-in3config>`_
- | a optional config
|
Returns:
`IN3Generic <#type-in3generic>`_
returns a Object, which can be used as Web3Provider.
const web3 = new Web3(new IN3().createWeb3Provider())
``any`` `createWeb3Provider <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L477>`_ ()
Returns:
``any``
disposes the Client. This must be called in order to free allocated memory!
``any`` `free <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L468>`_ ()
Returns:
``any``
rregisters a plugin. The plugin may define methods which will be called by the client.
``void`` `registerPlugin <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L537>`_ (
plugin:`IN3Plugin<BigIntType,BufferType> <#type-in3plugin>`_ )
Parameters:
.. list-table::
:widths: auto
* - | plugin
- | `IN3Plugin<BigIntType,BufferType> <#type-in3plugin>`_
- | the plugin-object to register
|
sends a raw request. if the request is a array the response will be a array as well. If the callback is given it will be called with the response, if not a Promise will be returned. This function supports callback so it can be used as a Provider for the web3.
`Promise<RPCResponse> <#type-rpcresponse>`_ `send <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L444>`_ (
request:`RPCRequest <#type-rpcrequest>`_ ,
callback:(`Error <#type-error>`_ , `RPCResponse <#type-rpcresponse>`_ ) => ``void``)
Parameters:
.. list-table::
:widths: auto
* - | request
- | `RPCRequest <#type-rpcrequest>`_
- | a JSONRPC-Request with N3-Extension
* - | callback
- | (`Error <#type-error>`_ , `RPCResponse <#type-rpcresponse>`_ ) => ``void``
- | callback
Returns:
`Promise<RPCResponse> <#type-rpcresponse>`_
sends a RPC-Requests specified by name and params.
if the response contains an error, this will be thrown. if not the result will be returned.
``Promise<any>`` `sendRPC <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L453>`_ (
method:``string``,
params:``any`` [])
Parameters:
.. list-table::
:widths: auto
* - | method
- | ``string``
- | the method to call.
|
* - | params
- | ``any`` []
- | params
Returns:
``Promise<any>``
sends a RPC-Requests specified by name and params as a sync call. This is only alowed if the request is handled internally, like web3_sha3,
if the response contains an error, this will be thrown. if not the result will be returned.
``any`` `sendSyncRPC <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L463>`_ (
method:``string``,
params:``any`` [])
Parameters:
.. list-table::
:widths: auto
* - | method
- | ``string``
- | the method to call.
|
* - | params
- | ``any`` []
- | params
Returns:
``any``
sets configuration properties. You can pass a partial object specifieing any of defined properties.
``void`` `setConfig <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L436>`_ (
config:`Partial<IN3Config> <#type-in3config>`_ )
Parameters:
.. list-table::
:widths: auto
* - | config
- | `Partial<IN3Config> <#type-in3config>`_
- | config
Source: index.d.ts
.. list-table::
:widths: auto
* - | `accounts <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L661>`_
- |
- | the accounts
constructor
`SimpleSigner <#type-simplesigner>`_ `constructor <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L663>`_ (
pks:``string`` | `BufferType <#type-buffertype>`_ [])
Parameters:
.. list-table::
:widths: auto
* - | pks
- | ``string`` | `BufferType <#type-buffertype>`_ []
- | pks
Returns:
`SimpleSigner <#type-simplesigner>`_
optiional method which allows to change the transaction-data before sending it. This can be used for redirecting it through a multisig.
`Promise<Transaction> <#type-transaction>`_ `prepareTransaction <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L667>`_ (
client:`IN3Generic<BigIntType,BufferType> <#type-in3generic>`_ ,
tx:`Transaction <#type-transaction>`_ )
Parameters:
.. list-table::
:widths: auto
* - | client
- | `IN3Generic<BigIntType,BufferType> <#type-in3generic>`_
- | client
* - | tx
- | `Transaction <#type-transaction>`_
- | tx
Returns:
`Promise<Transaction> <#type-transaction>`_
signing of any data. if hashFirst is true the data should be hashed first, otherwise the data is the hash.
`Promise<BufferType> <#type-buffertype>`_ `sign <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L676>`_ (
data:`Hex <#type-hex>`_ ,
account:`Address <#type-address>`_ ,
hashFirst:``boolean``,
ethV:``boolean``)
Parameters:
.. list-table::
:widths: auto
* - | data
- | `Hex <#type-hex>`_
- | a Hexcoded String (starting with 0x)
* - | account
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | hashFirst
- | ``boolean``
- | hash first
* - | ethV
- | ``boolean``
- | eth v
Returns:
`Promise<BufferType> <#type-buffertype>`_
add account
``string`` `addAccount <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L665>`_ (
pk:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | pk
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
``string``
returns true if the account is supported (or unlocked)
``Promise<boolean>`` `canSign <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L670>`_ (
address:`Address <#type-address>`_ )
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
Returns:
``Promise<boolean>``
Source: index.d.ts
The Account API
adds a private key to sign with. This method returns address of the pk
``Promise<string>`` `add <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1205>`_ (
pk:``string`` | `BufferType <#type-buffertype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | pk
- | ``string`` | `BufferType <#type-buffertype>`_
- |
|
Returns:
``Promise<string>``
Source: index.d.ts
a full Block including the transactions
.. list-table::
:widths: auto
* - | `bits <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1671>`_
- | ``string``
- | bits (target) for the block as hex
* - | `chainwork <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1675>`_
- | ``string``
- | total amount of work since genesis
* - | `confirmations <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1655>`_
- | ``number``
- | number of confirmations or blocks mined on top of the containing block
* - | `difficulty <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1673>`_
- | ``number``
- | difficulty of the block
* - | `hash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1653>`_
- | ``string``
- | the hash of the blockheader
* - | `height <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1657>`_
- | ``number``
- | block number
* - | `mediantime <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1667>`_
- | ``string``
- | unix timestamp in seconds since 1970
* - | `merkleroot <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1663>`_
- | ``string``
- | merkle root of the trie of all transactions in the block
* - | `nTx <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1677>`_
- | ``number``
- | number of transactions in the block
* - | `nextblockhash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1681>`_
- | ``string``
- | hash of the next blockheader
* - | `nonce <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1669>`_
- | ``number``
- | nonce-field of the block
* - | `previousblockhash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1679>`_
- | ``string``
- | hash of the parent blockheader
* - | `time <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1665>`_
- | ``string``
- | unix timestamp in seconds since 1970
* - | `tx <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1687>`_
- | `T <#type-t>`_ []
- | the transactions
* - | `version <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1659>`_
- | ``number``
- | used version
* - | `versionHex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1661>`_
- | ``string``
- | version as hex
Source: index.d.ts
a Block header
.. list-table::
:widths: auto
* - | `bits <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1671>`_
- | ``string``
- | bits (target) for the block as hex
* - | `chainwork <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1675>`_
- | ``string``
- | total amount of work since genesis
* - | `confirmations <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1655>`_
- | ``number``
- | number of confirmations or blocks mined on top of the containing block
* - | `difficulty <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1673>`_
- | ``number``
- | difficulty of the block
* - | `hash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1653>`_
- | ``string``
- | the hash of the blockheader
* - | `height <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1657>`_
- | ``number``
- | block number
* - | `mediantime <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1667>`_
- | ``string``
- | unix timestamp in seconds since 1970
* - | `merkleroot <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1663>`_
- | ``string``
- | merkle root of the trie of all transactions in the block
* - | `nTx <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1677>`_
- | ``number``
- | number of transactions in the block
* - | `nextblockhash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1681>`_
- | ``string``
- | hash of the next blockheader
* - | `nonce <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1669>`_
- | ``number``
- | nonce-field of the block
* - | `previousblockhash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1679>`_
- | ``string``
- | hash of the parent blockheader
* - | `time <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1665>`_
- | ``string``
- | unix timestamp in seconds since 1970
* - | `version <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1659>`_
- | ``number``
- | used version
* - | `versionHex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1661>`_
- | ``string``
- | version as hex
Source: index.d.ts
.. list-table::
:widths: auto
* - | `blockNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L826>`_
- | ``number``
- | the blockNumber
* - | `committed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L827>`_
- | ``boolean``
- | the committed
* - | `verified <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L828>`_
- | ``boolean``
- | the verified
Source: index.d.ts
API for handling BitCoin data
retrieves the serialized block (bytes) including all transactions
`Promise<BufferType> <#type-buffertype>`_ `getBlockBytes <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1714>`_ (
blockHash:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | blockHash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<BufferType> <#type-buffertype>`_
retrieves the blockheader and returns the data as json.
`Promise<BTCBlockHeader> <#type-btcblockheader>`_ `getBlockHeader <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1702>`_ (
blockHash:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | blockHash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<BTCBlockHeader> <#type-btcblockheader>`_
retrieves the serialized blockheader (bytes)
`Promise<BufferType> <#type-buffertype>`_ `getBlockHeaderBytes <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1705>`_ (
blockHash:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | blockHash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<BufferType> <#type-buffertype>`_
retrieves the block including all tx data as json.
`Promise<BTCBlock> <#type-btcblock>`_ `getBlockWithTxData <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1708>`_ (
blockHash:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | blockHash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<BTCBlock> <#type-btcblock>`_
retrieves the block including all tx ids as json.
`Promise<BTCBlock> <#type-btcblock>`_ `getBlockWithTxIds <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1711>`_ (
blockHash:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | blockHash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<BTCBlock> <#type-btcblock>`_
retrieves the transaction and returns the data as json.
`Promise<BtcTransaction> <#type-btctransaction>`_ `getTransaction <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1696>`_ (
txid:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | txid
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<BtcTransaction> <#type-btctransaction>`_
retrieves the serialized transaction (bytes)
`Promise<BufferType> <#type-buffertype>`_ `getTransactionBytes <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1699>`_ (
txid:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | txid
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<BufferType> <#type-buffertype>`_
Source: index.d.ts
a BitCoin Transaction.
.. list-table::
:widths: auto
* - | `blockhash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1632>`_
- | `Hash <#type-hash>`_
- | the block hash of the block containing this transaction.
* - | `blocktime <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1641>`_
- | ``number``
- | The block time in seconds since epoch (Jan 1 1970 GMT)
* - | `confirmations <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1635>`_
- | ``number``
- | The confirmations.
* - | `hash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1614>`_
- | `Hash <#type-hash>`_
- | The transaction hash (differs from txid for witness transactions)
* - | `hex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1608>`_
- | `Data <#type-data>`_
- | the hex representation of raw data
* - | `in_active_chain <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1605>`_
- | ``boolean``
- | true if this transaction is part of the longest chain
* - | `locktime <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1629>`_
- | ``number``
- | The locktime
* - | `size <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1617>`_
- | ``number``
- | The serialized transaction size
* - | `time <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1638>`_
- | ``number``
- | The transaction time in seconds since epoch (Jan 1 1970 GMT)
* - | `txid <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1611>`_
- | `Hash <#type-hash>`_
- | The requested transaction id.
* - | `version <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1626>`_
- | ``number``
- | The version
* - | `vin <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1644>`_
- | `BtcTransactionInput <#type-btctransactioninput>`_ []
- | the transaction inputs
* - | `vout <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1647>`_
- | `BtcTransactionOutput <#type-btctransactionoutput>`_ []
- | the transaction outputs
* - | `vsize <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1620>`_
- | ``number``
- | The virtual transaction size (differs from size for witness transactions)
* - | `weight <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1623>`_
- | ``number``
- | The transaction’s weight (between vsize4-3 and vsize4)
Source: index.d.ts
a Input of a Bitcoin Transaction
.. list-table::
:widths: auto
* - | `scriptSig <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1554>`_
- |
- | the script
* - | `sequence <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1563>`_
- | ``number``
- | The script sequence number
* - | `txid <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1548>`_
- | `Hash <#type-hash>`_
- | the transaction id
* - | `txinwitness <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1566>`_
- | `Data <#type-data>`_ []
- | hex-encoded witness data (if any)
* - | `vout <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1551>`_
- | ``number``
- | the index of the transactionoutput
Source: index.d.ts
a Input of a Bitcoin Transaction
.. list-table::
:widths: auto
* - | `n <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1576>`_
- | ``number``
- | the index
* - | `scriptPubKey <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1582>`_
- |
- | the script
* - | `value <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1573>`_
- | ``number``
- | the value in BTC
* - | `vout <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1579>`_
- | ``number``
- | the index of the transactionoutput
Source: index.d.ts
.. list-table::
:widths: auto
* - | `receipt <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L868>`_
- | `TransactionReceipt <#type-transactionreceipt>`_
- | the receipt
Source: index.d.ts
.. list-table::
:widths: auto
* - | `block <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L840>`_
- | `BlockInfo <#type-blockinfo>`_
- | the block
* - | `executed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L839>`_
- | ``boolean``
- | the executed
Source: index.d.ts
The API for ethereum operations.
.. list-table::
:widths: auto
* - | `accounts <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1294>`_
- | `AccountAPI<BufferType> <#type-accountapi>`_
- | accounts-API
* - | `client <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1284>`_
- | `IN3Generic<BigIntType,BufferType> <#type-in3generic>`_
- | the client used.
* - | `signer <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1289>`_
- | `Signer<BigIntType,BufferType> <#type-signer>`_
- | a custom signer *(optional)*
Returns the number of most recent block. (as number)
``Promise<number>`` `blockNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1300>`_ ()
Returns:
``Promise<number>``
Executes a new message call immediately without creating a transaction on the block chain.
``Promise<string>`` `call <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1308>`_ (
tx:`Transaction <#type-transaction>`_ ,
block:`BlockType <#type-blocktype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | tx
- | `Transaction <#type-transaction>`_
- | tx
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
Returns:
``Promise<string>``
Executes a function of a contract, by passing a method-signature and the arguments, which will then be ABI-encoded and send as eth_call.
``Promise<any>`` `callFn <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1312>`_ (
to:`Address <#type-address>`_ ,
method:``string``,
args:``any`` [])
Parameters:
.. list-table::
:widths: auto
* - | to
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | method
- | ``string``
- | method
* - | args
- | ``any`` []
- | args
Returns:
``Promise<any>``
Returns the EIP155 chain ID used for transaction signing at the current best block. Null is returned if not available.
``Promise<string>`` `chainId <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1316>`_ ()
Returns:
``Promise<string>``
Returns the clientVersion. This may differ in case of an network, depending on the node it communicates with.
``Promise<string>`` `clientVersion <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1320>`_ ()
Returns:
``Promise<string>``
constructor
``any`` `constructor <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1296>`_ (
client:`IN3Generic<BigIntType,BufferType> <#type-in3generic>`_ )
Parameters:
.. list-table::
:widths: auto
* - | client
- | `IN3Generic<BigIntType,BufferType> <#type-in3generic>`_
- | client
Returns:
``any``
contract at
`contractAt <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1479>`_ (
abi:`ABI <#type-abi>`_ [],
address:`Address <#type-address>`_ )
Parameters:
.. list-table::
:widths: auto
* - | abi
- | `ABI <#type-abi>`_ []
- | abi
* - | address
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
decode event data
``any`` `decodeEventData <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1519>`_ (
log:`Log <#type-log>`_ ,
d:`ABI <#type-abi>`_ )
Parameters:
.. list-table::
:widths: auto
* - | log
- | `Log <#type-log>`_
- | log
* - | d
- | `ABI <#type-abi>`_
- | d
Returns:
``any``
Makes a call or transaction, which won’t be added to the blockchain and returns the used gas, which can be used for estimating the used gas.
``Promise<number>`` `estimateGas <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1324>`_ (
tx:`Transaction <#type-transaction>`_ )
Parameters:
.. list-table::
:widths: auto
* - | tx
- | `Transaction <#type-transaction>`_
- | tx
Returns:
``Promise<number>``
Returns the current price per gas in wei. (as number)
``Promise<number>`` `gasPrice <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1304>`_ ()
Returns:
``Promise<number>``
Returns the balance of the account of given address in wei (as hex).
`Promise<BigIntType> <#type-biginttype>`_ `getBalance <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1328>`_ (
address:`Address <#type-address>`_ ,
block:`BlockType <#type-blocktype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
Returns:
`Promise<BigIntType> <#type-biginttype>`_
Returns information about a block by hash.
`Promise<Block> <#type-block>`_ `getBlockByHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1340>`_ (
hash:`Hash <#type-hash>`_ ,
includeTransactions:``boolean``)
Parameters:
.. list-table::
:widths: auto
* - | hash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
* - | includeTransactions
- | ``boolean``
- | include transactions
Returns:
`Promise<Block> <#type-block>`_
Returns information about a block by block number.
`Promise<Block> <#type-block>`_ `getBlockByNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1344>`_ (
block:`BlockType <#type-blocktype>`_ ,
includeTransactions:``boolean``)
Parameters:
.. list-table::
:widths: auto
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
* - | includeTransactions
- | ``boolean``
- | include transactions
Returns:
`Promise<Block> <#type-block>`_
Returns the number of transactions in a block from a block matching the given block hash.
``Promise<number>`` `getBlockTransactionCountByHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1348>`_ (
block:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | block
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
``Promise<number>``
Returns the number of transactions in a block from a block matching the given block number.
``Promise<number>`` `getBlockTransactionCountByNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1352>`_ (
block:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | block
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
``Promise<number>``
Returns code at a given address.
``Promise<string>`` `getCode <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1332>`_ (
address:`Address <#type-address>`_ ,
block:`BlockType <#type-blocktype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
Returns:
``Promise<string>``
Polling method for a filter, which returns an array of logs which occurred since last poll.
``Promise<>`` `getFilterChanges <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1356>`_ (
id:`Quantity <#type-quantity>`_ )
Parameters:
.. list-table::
:widths: auto
* - | id
- | `Quantity <#type-quantity>`_
- | a BigInteger encoded as hex.
Returns:
``Promise<>``
Returns an array of all logs matching filter with given id.
``Promise<>`` `getFilterLogs <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1360>`_ (
id:`Quantity <#type-quantity>`_ )
Parameters:
.. list-table::
:widths: auto
* - | id
- | `Quantity <#type-quantity>`_
- | a BigInteger encoded as hex.
Returns:
``Promise<>``
Returns an array of all logs matching a given filter object.
``Promise<>`` `getLogs <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1364>`_ (
filter:`LogFilter <#type-logfilter>`_ )
Parameters:
.. list-table::
:widths: auto
* - | filter
- | `LogFilter <#type-logfilter>`_
- | filter
Returns:
``Promise<>``
Returns the value from a storage position at a given address.
``Promise<string>`` `getStorageAt <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1336>`_ (
address:`Address <#type-address>`_ ,
pos:`Quantity <#type-quantity>`_ ,
block:`BlockType <#type-blocktype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | pos
- | `Quantity <#type-quantity>`_
- | a BigInteger encoded as hex.
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
Returns:
``Promise<string>``
Returns information about a transaction by block hash and transaction index position.
`Promise<TransactionDetail> <#type-transactiondetail>`_ `getTransactionByBlockHashAndIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1368>`_ (
hash:`Hash <#type-hash>`_ ,
pos:`Quantity <#type-quantity>`_ )
Parameters:
.. list-table::
:widths: auto
* - | hash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
* - | pos
- | `Quantity <#type-quantity>`_
- | a BigInteger encoded as hex.
Returns:
`Promise<TransactionDetail> <#type-transactiondetail>`_
Returns information about a transaction by block number and transaction index position.
`Promise<TransactionDetail> <#type-transactiondetail>`_ `getTransactionByBlockNumberAndIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1372>`_ (
block:`BlockType <#type-blocktype>`_ ,
pos:`Quantity <#type-quantity>`_ )
Parameters:
.. list-table::
:widths: auto
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
* - | pos
- | `Quantity <#type-quantity>`_
- | a BigInteger encoded as hex.
Returns:
`Promise<TransactionDetail> <#type-transactiondetail>`_
Returns the information about a transaction requested by transaction hash.
`Promise<TransactionDetail> <#type-transactiondetail>`_ `getTransactionByHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1376>`_ (
hash:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | hash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<TransactionDetail> <#type-transactiondetail>`_
Returns the number of transactions sent from an address. (as number)
``Promise<number>`` `getTransactionCount <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1380>`_ (
address:`Address <#type-address>`_ ,
block:`BlockType <#type-blocktype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
Returns:
``Promise<number>``
Returns the receipt of a transaction by transaction hash. Note That the receipt is available even for pending transactions.
`Promise<TransactionReceipt> <#type-transactionreceipt>`_ `getTransactionReceipt <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1385>`_ (
hash:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | hash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
`Promise<TransactionReceipt> <#type-transactionreceipt>`_
Returns information about a uncle of a block by hash and uncle index position. Note: An uncle doesn’t contain individual transactions.
`Promise<Block> <#type-block>`_ `getUncleByBlockHashAndIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1390>`_ (
hash:`Hash <#type-hash>`_ ,
pos:`Quantity <#type-quantity>`_ )
Parameters:
.. list-table::
:widths: auto
* - | hash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
* - | pos
- | `Quantity <#type-quantity>`_
- | a BigInteger encoded as hex.
Returns:
`Promise<Block> <#type-block>`_
Returns information about a uncle of a block number and uncle index position. Note: An uncle doesn’t contain individual transactions.
`Promise<Block> <#type-block>`_ `getUncleByBlockNumberAndIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1395>`_ (
block:`BlockType <#type-blocktype>`_ ,
pos:`Quantity <#type-quantity>`_ )
Parameters:
.. list-table::
:widths: auto
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
* - | pos
- | `Quantity <#type-quantity>`_
- | a BigInteger encoded as hex.
Returns:
`Promise<Block> <#type-block>`_
Returns the number of uncles in a block from a block matching the given block hash.
``Promise<number>`` `getUncleCountByBlockHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1399>`_ (
hash:`Hash <#type-hash>`_ )
Parameters:
.. list-table::
:widths: auto
* - | hash
- | `Hash <#type-hash>`_
- | a 32 byte Hash encoded as Hex (starting with 0x)
Returns:
``Promise<number>``
Returns the number of uncles in a block from a block matching the given block hash.
``Promise<number>`` `getUncleCountByBlockNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1403>`_ (
block:`BlockType <#type-blocktype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | block
- | `BlockType <#type-blocktype>`_
- | BlockNumber or predefined Block
Returns:
``Promise<number>``
a Hexcoded String (starting with 0x)
`Hex <#type-hex>`_ `hashMessage <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1520>`_ (
data:`Data <#type-data>`_ )
Parameters:
.. list-table::
:widths: auto
* - | data
- | `Data <#type-data>`_
- | data encoded as Hex (starting with 0x)
Returns:
`Hex <#type-hex>`_
Creates a filter in the node, to notify when a new block arrives. To check if the state has changed, call eth_getFilterChanges.
``Promise<string>`` `newBlockFilter <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1407>`_ ()
Returns:
``Promise<string>``
Creates a filter object, based on filter options, to notify when the state changes (logs). To check if the state has changed, call eth_getFilterChanges.
A note on specifying topic filters: Topics are order-dependent. A transaction with a log with topics [A, B] will be matched by the following topic filters:
[] “anything” [A] “A in first position (and anything after)” [null, B] “anything in first position AND B in second position (and anything after)” [A, B] “A in first position AND B in second position (and anything after)” [[A, B], [A, B]] “(A OR B) in first position AND (A OR B) in second position (and anything after)”
``Promise<string>`` `newFilter <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1420>`_ (
filter:`LogFilter <#type-logfilter>`_ )
Parameters:
.. list-table::
:widths: auto
* - | filter
- | `LogFilter <#type-logfilter>`_
- | filter
Returns:
``Promise<string>``
Creates a filter in the node, to notify when new pending transactions arrive.
To check if the state has changed, call eth_getFilterChanges.
``Promise<string>`` `newPendingTransactionFilter <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1426>`_ ()
Returns:
``Promise<string>``
Returns the current ethereum protocol version.
``Promise<string>`` `protocolVersion <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1434>`_ ()
Returns:
``Promise<string>``
resolves a name as an ENS-Domain.
`Promise<Address> <#type-address>`_ `resolveENS <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1457>`_ (
name:``string``,
type:`Address <#type-address>`_ ,
registry:``string``)
Parameters:
.. list-table::
:widths: auto
* - | name
- | ``string``
- | the domain name
* - | type
- | `Address <#type-address>`_
- | the type (currently only addr is supported)
* - | registry
- | ``string``
- | optionally the address of the registry (default is the mainnet ens registry)
|
Returns:
`Promise<Address> <#type-address>`_
Creates new message call transaction or a contract creation for signed transactions.
``Promise<string>`` `sendRawTransaction <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1462>`_ (
data:`Data <#type-data>`_ )
Parameters:
.. list-table::
:widths: auto
* - | data
- | `Data <#type-data>`_
- | data encoded as Hex (starting with 0x)
Returns:
``Promise<string>``
sends a Transaction
``Promise<>`` `sendTransaction <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1470>`_ (
args:`TxRequest <#type-txrequest>`_ )
Parameters:
.. list-table::
:widths: auto
* - | args
- | `TxRequest <#type-txrequest>`_
- | args
Returns:
``Promise<>``
signs any kind of message using the \x19Ethereum Signed Message:\n-prefix
`Promise<BufferType> <#type-buffertype>`_ `sign <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1468>`_ (
account:`Address <#type-address>`_ ,
data:`Data <#type-data>`_ )
Parameters:
.. list-table::
:widths: auto
* - | account
- | `Address <#type-address>`_
- | the address to sign the message with (if this is a 32-bytes hex-string it will be used as private key)
* - | data
- | `Data <#type-data>`_
- | the data to sign (Buffer, hexstring or utf8-string)
|
Returns:
`Promise<BufferType> <#type-buffertype>`_
Returns the state of the underlying node.
``Promise<>`` `syncing <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1442>`_ ()
Returns:
``Promise<>``
Returns the value in wei as hexstring.
``string`` `toWei <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1438>`_ (
value:``string``,
unit:``string``)
Parameters:
.. list-table::
:widths: auto
* - | value
- | ``string``
- | value
* - | unit
- | ``string``
- | unit
Returns:
``string``
Uninstalls a filter with given id. Should always be called when watch is no longer needed. Additonally Filters timeout when they aren’t requested with eth_getFilterChanges for a period of time.
`Promise<Quantity> <#type-quantity>`_ `uninstallFilter <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1430>`_ (
id:`Quantity <#type-quantity>`_ )
Parameters:
.. list-table::
:widths: auto
* - | id
- | `Quantity <#type-quantity>`_
- | a BigInteger encoded as hex.
Returns:
`Promise<Quantity> <#type-quantity>`_
web3 contract at
`Web3Contract <#type-web3contract>`_ `web3ContractAt <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1472>`_ (
abi:`ABI <#type-abi>`_ [],
address:`Address <#type-address>`_ ,
options:)
Parameters:
.. list-table::
:widths: auto
* - | abi
- | `ABI <#type-abi>`_ []
- | abi
* - | address
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | options
- |
- | options
Returns:
`Web3Contract <#type-web3contract>`_
Source: index.d.ts
.. list-table::
:widths: auto
* - | `feeType <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L848>`_
- | `TxType <#type-txtype>`_
- | the feeType
* - | `gasFee <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L851>`_
- | ``number``
- | the gasFee
* - | `gasPrice <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L850>`_
- | ``number``
- | the gasPrice
* - | `totalFee <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L853>`_
- | ``number``
- | the totalFee
* - | `totalGas <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L849>`_
- | ``number``
- | the totalGas
* - | `zkpFee <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L852>`_
- | ``number``
- | the zkpFee
Source: index.d.ts
the configuration of the IN3-Client. This can be changed at any time. All properties are optional and will be verified when sending the next request.
.. list-table::
:widths: auto
* - | `autoUpdateList <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L52>`_
- | ``boolean``
- | if true the nodelist will be automaticly updated if the lastBlock is newer.
|
| default: true
| *(optional)*
* - | `bootWeights <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L99>`_
- | ``boolean``
- | if true, the first request (updating the nodelist) will also fetch the current health status
| and use it for blacklisting unhealthy nodes. This is used only if no nodelist is availabkle from cache.
|
| default: false
| *(optional)*
* - | `btc <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L254>`_
- | `btc_config <#type-btc_config>`_
- | config for btc *(optional)*
* - | `chainId <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L67>`_
- | ``string``
- | The chain-id based on EIP-155.
| or the name of the supported chain.
|
| Currently we support 'mainnet', 'goerli', 'kovan', 'ipfs' and 'local'
|
| While most of the chains use preconfigured chain settings,
| 'local' actually uses the local running client turning of proof.
|
| example: '0x1' or 'mainnet' or 'goerli'
|
| default: 'mainnet'
|
* - | `chainRegistry <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L186>`_
- | ``string``
- | main chain-registry contract
| example: 0xe36179e2286ef405e929C90ad3E70E649B22a945 *(optional)*
* - | `finality <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L82>`_
- | ``number``
- | the number in percent needed in order reach finality if you run on a POA-Chain.
| (% of signature of the validators)
|
| default: 0
| *(optional)*
* - | `includeCode <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L91>`_
- | ``boolean``
- | if true, the request should include the codes of all accounts.
| Otherwise only the the codeHash is returned.
| In this case the client may ask by calling eth_getCode() afterwards
|
| default: false
| *(optional)*
* - | `keepIn3 <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L117>`_
- | ``boolean``
- | if true, the in3-section of the response will be kept and returned.
| Otherwise it will be removed after validating the data.
| This is useful for debugging or if the proof should be used afterwards.
|
| default: false
| *(optional)*
* - | `key <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L122>`_
- | `Hash <#type-hash>`_
- | the key to sign requests. This is required for payments. *(optional)*
* - | `mainChain <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L191>`_
- | ``string``
- | main chain-id, where the chain registry is running.
| example: 0x1 *(optional)*
* - | `maxAttempts <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L107>`_
- | ``number``
- | max number of attempts in case a response is rejected.
| Incubed will retry to find a different node giving a verified response.
|
| default: 5
| *(optional)*
* - | `minDeposit <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L149>`_
- | ``number``
- | min stake of the server. Only nodes owning at least this amount will be chosen.
|
| default: 0
|
* - | `nodeLimit <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L129>`_
- | ``number``
- | the limit of nodes to store in the client. If set a random seed will be picked, which is the base for a deterministic verifiable partial nodelist.
|
| default: 0
| *(optional)*
* - | `nodeProps <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L154>`_
- | ``number`` | `Hex <#type-hex>`_
- | a bitmask-value combining the minimal properties as filter for the selected nodes. See https://in3.readthedocs.io/en/develop/spec.html#node-structure for details.
* - | `nodes <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L195>`_
- |
- | the nodelists per chain. the chain_id will be used as key within the object. *(optional)*
* - | `proof <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L161>`_
- | ``'none'`` | ``'standard'`` | ``'full'``
- | if true the nodes should send a proof of the response
|
| default: 'standard'
| *(optional)*
* - | `replaceLatestBlock <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L168>`_
- | ``number``
- | if specified, the blocknumber *latest* will be replaced by blockNumber- specified value
|
| default: 6
| *(optional)*
* - | `requestCount <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L175>`_
- | ``number``
- | the number of request send when getting a first answer
|
| default: 1
|
* - | `rpc <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L180>`_
- | ``string``
- | url of a rpc-endpoints to use. If this is set proof will be turned off and it will be treated like local_chain. *(optional)*
* - | `signatureCount <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L74>`_
- | ``number``
- | number of signatures requested. The more signatures, the more security you get, but responses may take longer.
|
| default: 0
| *(optional)*
* - | `stats <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L136>`_
- | ``boolean``
- | if false, the requests will not be included in the stats of the nodes ( or marked as intern ).
|
| default: true
| *(optional)*
* - | `timeout <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L143>`_
- | ``number``
- | specifies the number of milliseconds before the request times out. increasing may be helpful if the device uses a slow connection.
|
| default: 5000
| *(optional)*
* - | `zksync <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L252>`_
- | `zksync_config <#type-zksync_config>`_
- | config for zksync *(optional)*
sets the transport-function.
``Promise<string>`` `transport <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L45>`_ (
url:``string``,
payload:``string``,
timeout:``number``)
Parameters:
.. list-table::
:widths: auto
* - | url
- | ``string``
- | url
* - | payload
- | ``string``
- | payload
* - | timeout
- | ``number``
- | timeout
Returns:
``Promise<string>``
Source: index.d.ts
a configuration of a in3-server.
.. list-table::
:widths: auto
* - | `address <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L269>`_
- | ``string``
- | the address of the node, which is the public address it iis signing with.
| example: 0x6C1a01C2aB554930A937B0a2E8105fB47946c679
* - | `capacity <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L294>`_
- | ``number``
- | the capacity of the node.
| example: 100 *(optional)*
* - | `chainIds <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L284>`_
- | ``string`` []
- | the list of supported chains
| example: 0x1
* - | `deposit <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L289>`_
- | ``number``
- | the deposit of the node in wei
| example: 12350000
* - | `index <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L264>`_
- | ``number``
- | the index within the contract
| example: 13 *(optional)*
* - | `props <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L299>`_
- | ``number``
- | the properties of the node.
| example: 3 *(optional)*
* - | `registerTime <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L304>`_
- | ``number``
- | the UNIX-timestamp when the node was registered
| example: 1563279168 *(optional)*
* - | `timeout <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L274>`_
- | ``number``
- | the time (in seconds) until an owner is able to receive his deposit back after he unregisters himself
| example: 3600 *(optional)*
* - | `unregisterTime <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L309>`_
- | ``number``
- | the UNIX-timestamp when the node is allowed to be deregister
| example: 1563279168 *(optional)*
* - | `url <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L279>`_
- | ``string``
- | the endpoint to post to
| example: https://in3.slock.it
Source: index.d.ts
a local weight of a n3-node. (This is used internally to weight the requests)
.. list-table::
:widths: auto
* - | `avgResponseTime <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L329>`_
- | ``number``
- | average time of a response in ms
| example: 240 *(optional)*
* - | `blacklistedUntil <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L343>`_
- | ``number``
- | blacklisted because of failed requests until the timestamp
| example: 1529074639623 *(optional)*
* - | `lastRequest <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L338>`_
- | ``number``
- | timestamp of the last request in ms
| example: 1529074632623 *(optional)*
* - | `pricePerRequest <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L333>`_
- | ``number``
- | last price *(optional)*
* - | `responseCount <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L324>`_
- | ``number``
- | number of uses.
| example: 147 *(optional)*
* - | `weight <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L319>`_
- | ``number``
- | factor the weight this noe (default 1.0)
| example: 0.5 *(optional)*
Source: index.d.ts
Source: index.d.ts
API for storing and retrieving IPFS-data.
retrieves the content for a hash from IPFS.
`Promise<BufferType> <#type-buffertype>`_ `get <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1533>`_ (
multihash:``string``)
Parameters:
.. list-table::
:widths: auto
* - | multihash
- | ``string``
- | the IPFS-hash to fetch
|
|
Returns:
`Promise<BufferType> <#type-buffertype>`_
stores the data on ipfs and returns the IPFS-Hash.
``Promise<string>`` `put <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1538>`_ (
content:`BufferType <#type-buffertype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | content
- | `BufferType <#type-buffertype>`_
- | puts a IPFS content
|
Returns:
``Promise<string>``
Source: index.d.ts
a JSONRPC-Request with N3-Extension
.. list-table::
:widths: auto
* - | `id <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L363>`_
- | ``number`` | ``string``
- | the identifier of the request
| example: 2 *(optional)*
* - | `jsonrpc <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L353>`_
- | ``'2.0'``
- | the version
* - | `method <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L358>`_
- | ``string``
- | the method to call
| example: eth_getBalance
* - | `params <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L368>`_
- | ``any`` []
- | the params
| example: 0xe36179e2286ef405e929C90ad3E70E649B22a945,latest *(optional)*
Source: index.d.ts
a JSONRPC-Responset with N3-Extension
.. list-table::
:widths: auto
* - | `error <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L386>`_
- | ``string``
- | in case of an error this needs to be set *(optional)*
* - | `id <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L382>`_
- | ``string`` | ``number``
- | the id matching the request
| example: 2
* - | `jsonrpc <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L377>`_
- | ``'2.0'``
- | the version
* - | `result <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L391>`_
- | ``any``
- | the params
| example: 0xa35bc *(optional)*
Source: index.d.ts
optiional method which allows to change the transaction-data before sending it. This can be used for redirecting it through a multisig.
`Promise<Transaction> <#type-transaction>`_ `prepareTransaction <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L648>`_ (
client:`IN3Generic<BigIntType,BufferType> <#type-in3generic>`_ ,
tx:`Transaction <#type-transaction>`_ )
Parameters:
.. list-table::
:widths: auto
* - | client
- | `IN3Generic<BigIntType,BufferType> <#type-in3generic>`_
- | client
* - | tx
- | `Transaction <#type-transaction>`_
- | tx
Returns:
`Promise<Transaction> <#type-transaction>`_
signing of any data. if hashFirst is true the data should be hashed first, otherwise the data is the hash.
`Promise<BufferType> <#type-buffertype>`_ `sign <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L657>`_ (
data:`Hex <#type-hex>`_ ,
account:`Address <#type-address>`_ ,
hashFirst:``boolean``,
ethV:``boolean``)
Parameters:
.. list-table::
:widths: auto
* - | data
- | `Hex <#type-hex>`_
- | a Hexcoded String (starting with 0x)
* - | account
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
* - | hashFirst
- | ``boolean``
- | hash first
* - | ethV
- | ``boolean``
- | eth v
Returns:
`Promise<BufferType> <#type-buffertype>`_
returns true if the account is supported (or unlocked)
``Promise<boolean>`` `canSign <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L651>`_ (
address:`Address <#type-address>`_ )
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | a 20 byte Address encoded as Hex (starting with 0x)
Returns:
``Promise<boolean>``
Source: index.d.ts
.. list-table::
:widths: auto
* - | `address <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L861>`_
- | `String <#type-string>`_
- | the address
* - | `decimals <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L862>`_
- | ``number``
- | the decimals
* - | `id <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L863>`_
- | ``number``
- | the id
* - | `symbol <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L864>`_
- | `String <#type-string>`_
- | the symbol
Source: index.d.ts
Source: index.d.ts
.. list-table::
:widths: auto
* - | `block <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L832>`_
- | `BlockInfo <#type-blockinfo>`_
- | the block
* - | `executed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L833>`_
- | ``boolean``
- | the executed
* - | `failReason <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L834>`_
- | ``string``
- | the failReason
* - | `success <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L835>`_
- | ``boolean``
- | the success
Source: index.d.ts
.. list-table::
:widths: auto
* - | `type <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L844>`_
- | ``'Withdraw'``
| | ``'Transfer'``
| | ``'TransferToNew'``
- | the type
Source: index.d.ts
Collection of different util-functions.
decodes the given data as ABI-encoded (without the methodHash)
``any`` [] `abiDecode <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L702>`_ (
signature:``string``,
data:`Data <#type-data>`_ )
Parameters:
.. list-table::
:widths: auto
* - | signature
- | ``string``
- | the method signature, which must contain a return description
* - | data
- | `Data <#type-data>`_
- | the data to decode
|
Returns:
``any`` []
encodes the given arguments as ABI-encoded (including the methodHash)
`Hex <#type-hex>`_ `abiEncode <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L695>`_ (
signature:``string``,
args:``any`` [])
Parameters:
.. list-table::
:widths: auto
* - | signature
- | ``string``
- | the method signature
* - | args
- | ``any`` []
- | the arguments
|
Returns:
`Hex <#type-hex>`_
checks whether the given address is a correct checksumAddress If the chainId is passed, it will be included accord to EIP 1191
``boolean`` `checkAddressChecksum <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L718>`_ (
address:`Address <#type-address>`_ ,
chainId:``number``)
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | the address (as hex)
* - | chainId
- | ``number``
- | the chainId (if supported)
|
Returns:
``boolean``
a Hexcoded String (starting with 0x)
`Hex <#type-hex>`_ `createSignatureHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L685>`_ (
def:`ABI <#type-abi>`_ )
Parameters:
.. list-table::
:widths: auto
* - | def
- | `ABI <#type-abi>`_
- | def
Returns:
`Hex <#type-hex>`_
decode event
``any`` `decodeEvent <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L687>`_ (
log:`Log <#type-log>`_ ,
d:`ABI <#type-abi>`_ )
Parameters:
.. list-table::
:widths: auto
* - | log
- | `Log <#type-log>`_
- | log
* - | d
- | `ABI <#type-abi>`_
- | d
Returns:
``any``
create a signature (65 bytes) for the given message and kexy
`BufferType <#type-buffertype>`_ `ecSign <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L782>`_ (
pk:`Hex <#type-hex>`_ | `BufferType <#type-buffertype>`_ ,
msg:`Hex <#type-hex>`_ | `BufferType <#type-buffertype>`_ ,
hashFirst:``boolean``,
adjustV:``boolean``)
Parameters:
.. list-table::
:widths: auto
* - | pk
- | `Hex <#type-hex>`_
| | `BufferType <#type-buffertype>`_
- | the private key
* - | msg
- | `Hex <#type-hex>`_
| | `BufferType <#type-buffertype>`_
- | the message
* - | hashFirst
- | ``boolean``
- | if true the message will be hashed first (default:true), if not the message is the hash.
* - | adjustV
- | ``boolean``
- | if true (default) the v value will be adjusted by adding 27
|
Returns:
`BufferType <#type-buffertype>`_
returns the incubed version.
``string`` `getVersion <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L747>`_ ()
Returns:
``string``
checks whether the given address is a valid hex string with 0x-prefix and 20 bytes
``boolean`` `isAddress <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L724>`_ (
address:`Address <#type-address>`_ )
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | the address (as hex)
|
Returns:
``boolean``
calculates the keccack hash for the given data.
`BufferType <#type-buffertype>`_ `keccak <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L730>`_ (
data:`BufferType <#type-buffertype>`_ | `Data <#type-data>`_ )
Parameters:
.. list-table::
:widths: auto
* - | data
- | `BufferType <#type-buffertype>`_
| | `Data <#type-data>`_
- | the data as Uint8Array or hex data.
|
Returns:
`BufferType <#type-buffertype>`_
generates the public address from the private key.
`Address <#type-address>`_ `private2address <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L796>`_ (
pk:`Hex <#type-hex>`_ | `BufferType <#type-buffertype>`_ )
Parameters:
.. list-table::
:widths: auto
* - | pk
- | `Hex <#type-hex>`_
| | `BufferType <#type-buffertype>`_
- | the private key.
|
Returns:
`Address <#type-address>`_
returns a Buffer with strong random bytes. Thsi will use the browsers crypto-module or in case of nodejs use the crypto-module there.
`BufferType <#type-buffertype>`_ `randomBytes <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L737>`_ (
len:``number``)
Parameters:
.. list-table::
:widths: auto
* - | len
- | ``number``
- | the number of bytes to generate.
|
Returns:
`BufferType <#type-buffertype>`_
solidity sha3
``string`` `soliditySha3 <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L688>`_ (
args:``any`` [])
Parameters:
.. list-table::
:widths: auto
* - | args
- | ``any`` []
- | args
Returns:
``string``
takes raw signature (65 bytes) and splits it into a signature object.
`Signature <#type-signature>`_ `splitSignature <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L790>`_ (
signature:`Hex <#type-hex>`_ | `BufferType <#type-buffertype>`_ ,
message:`BufferType <#type-buffertype>`_ | `Hex <#type-hex>`_ ,
hashFirst:``boolean``)
Parameters:
.. list-table::
:widths: auto
* - | signature
- | `Hex <#type-hex>`_
| | `BufferType <#type-buffertype>`_
- | the 65 byte-signature
* - | message
- | `BufferType <#type-buffertype>`_
| | `Hex <#type-hex>`_
- | the message
* - | hashFirst
- | ``boolean``
- | if true (default) this will be taken as raw-data and will be hashed first.
|
Returns:
`Signature <#type-signature>`_
converts any value to a Buffer. optionally the target length can be specified (in bytes)
`BufferType <#type-buffertype>`_ `toBuffer <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L762>`_ (
data:`Hex <#type-hex>`_ | `BufferType <#type-buffertype>`_ | ``number`` | ``bigint``,
len:``number``)
Parameters:
.. list-table::
:widths: auto
* - | data
- | `Hex <#type-hex>`_
| | `BufferType <#type-buffertype>`_
| | ``number``
| | ``bigint``
- | data
* - | len
- | ``number``
- | len
Returns:
`BufferType <#type-buffertype>`_
generates a checksum Address for the given address. If the chainId is passed, it will be included accord to EIP 1191
`Address <#type-address>`_ `toChecksumAddress <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L710>`_ (
address:`Address <#type-address>`_ ,
chainId:``number``)
Parameters:
.. list-table::
:widths: auto
* - | address
- | `Address <#type-address>`_
- | the address (as hex)
* - | chainId
- | ``number``
- | the chainId (if supported)
|
Returns:
`Address <#type-address>`_
converts any value to a hex string (with prefix 0x). optionally the target length can be specified (in bytes)
`Hex <#type-hex>`_ `toHex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L743>`_ (
data:`Hex <#type-hex>`_ | `BufferType <#type-buffertype>`_ | ``number`` | ``bigint``,
len:``number``)
Parameters:
.. list-table::
:widths: auto
* - | data
- | `Hex <#type-hex>`_
| | `BufferType <#type-buffertype>`_
| | ``number``
| | ``bigint``
- | data
* - | len
- | ``number``
- | len
Returns:
`Hex <#type-hex>`_
removes all leading 0 in the hexstring
``string`` `toMinHex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L750>`_ (
key:``string`` | `BufferType <#type-buffertype>`_ | ``number``)
Parameters:
.. list-table::
:widths: auto
* - | key
- | ``string``
| | `BufferType <#type-buffertype>`_
| | ``number``
- | key
Returns:
``string``
converts any value to a hex string (with prefix 0x). optionally the target length can be specified (in bytes)
``number`` `toNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L768>`_ (
data:``string`` | `BufferType <#type-buffertype>`_ | ``number`` | ``bigint``)
Parameters:
.. list-table::
:widths: auto
* - | data
- | ``string``
| | `BufferType <#type-buffertype>`_
| | ``number``
| | ``bigint``
- | data
Returns:
``number``
converts any value to a Uint8Array. optionally the target length can be specified (in bytes)
`BufferType <#type-buffertype>`_ `toUint8Array <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L756>`_ (
data:`Hex <#type-hex>`_ | `BufferType <#type-buffertype>`_ | ``number`` | ``bigint``,
len:``number``)
Parameters:
.. list-table::
:widths: auto
* - | data
- | `Hex <#type-hex>`_
| | `BufferType <#type-buffertype>`_
| | ``number``
| | ``bigint``
- | data
* - | len
- | ``number``
- | len
Returns:
`BufferType <#type-buffertype>`_
convert to String
``string`` `toUtf8 <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L773>`_ (
val:``any``)
Parameters:
.. list-table::
:widths: auto
* - | val
- | ``any``
- | val
Returns:
``string``
Source: index.d.ts
.. list-table::
:widths: auto
* - | `events <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1255>`_
- |
- | the events
* - | `methods <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1249>`_
- |
- | the methods
* - | `options <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1235>`_
- |
- | the options
deploy
`Web3TransactionObject <#type-web3transactionobject>`_ `deploy <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1245>`_ (
args:)
Parameters:
.. list-table::
:widths: auto
* - | args
- |
- | args
Returns:
`Web3TransactionObject <#type-web3transactionobject>`_
once
``void`` `once <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1253>`_ (
eventName:``string``,
options:,
handler:(`Error <#type-error>`_ , `Web3Event <#type-web3event>`_ ) => ``void``)
Parameters:
.. list-table::
:widths: auto
* - | eventName
- | ``string``
- | event name
* - | options
- |
- | options
* - | handler
- | (`Error <#type-error>`_ , `Web3Event <#type-web3event>`_ ) => ``void``
- | handler
get past events
``Promise<>`` `getPastEvents <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1268>`_ (
evName:``string``,
options:)
Parameters:
.. list-table::
:widths: auto
* - | evName
- | ``string``
- | ev name
* - | options
- |
- | options
Returns:
``Promise<>``
Source: index.d.ts
.. list-table::
:widths: auto
* - | `address <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1184>`_
- | `Address <#type-address>`_
- | the address
* - | `blockHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1186>`_
- | `Hash <#type-hash>`_
- | the blockHash
* - | `blockNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1185>`_
- | ``number``
- | the blockNumber
* - | `event <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1179>`_
- | ``string``
- | the event
* - | `logIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1181>`_
- | ``number``
- | the logIndex
* - | `raw <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1187>`_
- |
- | the raw
* - | `returnValues <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1176>`_
- |
- | the returnValues
* - | `signature <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1180>`_
- | ``string``
- | the signature
* - | `transactionHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1183>`_
- | `Hash <#type-hash>`_
- | the transactionHash
* - | `transactionIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1182>`_
- | ``number``
- | the transactionIndex
Source: index.d.ts
call
``Promise<any>`` `call <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1211>`_ (
options:)
Parameters:
.. list-table::
:widths: auto
* - | options
- |
- | options
Returns:
``Promise<any>``
a Hexcoded String (starting with 0x)
`Hex <#type-hex>`_ `encodeABI <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1231>`_ ()
Returns:
`Hex <#type-hex>`_
estimate gas
``Promise<number>`` `estimateGas <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1225>`_ (
options:)
Parameters:
.. list-table::
:widths: auto
* - | options
- |
- | options
Returns:
``Promise<number>``
send
``Promise<any>`` `send <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1217>`_ (
options:)
Parameters:
.. list-table::
:widths: auto
* - | options
- |
- | options
Returns:
``Promise<any>``
Source: index.d.ts
.. list-table::
:widths: auto
* - | `address <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L802>`_
- | ``string``
- | the address
* - | `committed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L803>`_
- |
- | the committed
* - | `depositing <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L810>`_
- |
- | the depositing
* - | `id <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L815>`_
- | ``number``
- | the id
* - | `verified <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L816>`_
- |
- | the verified
Source: index.d.ts
API for zksync.
deposits the declared amount into the rollup
`Promise<DepositResponse> <#type-depositresponse>`_ `deposit <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L935>`_ (
amount:``number``,
token:``string``,
approveDepositAmountForERC20:``boolean``,
account:``string``)
Parameters:
.. list-table::
:widths: auto
* - | amount
- | ``number``
- | amount in wei to deposit
* - | token
- | ``string``
- | the token identifier e.g. ETH
* - | approveDepositAmountForERC20
- | ``boolean``
- | bool that is set to true if it is a erc20 token that needs approval
* - | account
- | ``string``
- | address of the account that wants to deposit (if left empty it will be taken from current signer)
|
Returns:
`Promise<DepositResponse> <#type-depositresponse>`_
executes an emergency withdrawel onchain
`Promise<String> <#type-string>`_ `emergencyWithdraw <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L959>`_ (
token:``string``)
Parameters:
.. list-table::
:widths: auto
* - | token
- | ``string``
- | the token identifier e.g. ETH
|
Returns:
`Promise<String> <#type-string>`_
gets current account Infoa and balances.
`Promise<ZKAccountInfo> <#type-zkaccountinfo>`_ `getAccountInfo <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L880>`_ (
account:``string``)
Parameters:
.. list-table::
:widths: auto
* - | account
- | ``string``
- | the address of the account . if not specified, the first signer is used.
|
Returns:
`Promise<ZKAccountInfo> <#type-zkaccountinfo>`_
gets the contract address of the zksync contract
`Promise<String> <#type-string>`_ `getContractAddress <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L885>`_ ()
Returns:
`Promise<String> <#type-string>`_
returns the state of receipt of the PriorityOperation
`Promise<ETHOpInfoResp> <#type-ethopinforesp>`_ `getEthopInfo <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L907>`_ (
opId:``number``)
Parameters:
.. list-table::
:widths: auto
* - | opId
- | ``number``
- | the id of the PriorityOperation
|
Returns:
`Promise<ETHOpInfoResp> <#type-ethopinforesp>`_
returns private key used for signing zksync transactions
`String <#type-string>`_ `getSyncKey <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L926>`_ ()
Returns:
`String <#type-string>`_
returns the current token price
`Promise<Number> <#type-number>`_ `getTokenPrice <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L913>`_ (
tokenSymbol:``string``)
Parameters:
.. list-table::
:widths: auto
* - | tokenSymbol
- | ``string``
- | the address of the token
|
Returns:
`Promise<Number> <#type-number>`_
returns an object containing Token objects with its short name as key
`Promise<Tokens> <#type-tokens>`_ `getTokens <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L890>`_ ()
Returns:
`Promise<Tokens> <#type-tokens>`_
returns the transaction fee
`Promise<Fee> <#type-fee>`_ `getTxFee <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L921>`_ (
txType:`TxType <#type-txtype>`_ ,
receipient:``string``,
token:``string``)
Parameters:
.. list-table::
:widths: auto
* - | txType
- | `TxType <#type-txtype>`_
- | either Withdraw or Transfer
* - | receipient
- | ``string``
- | the address the transaction is send to
* - | token
- | ``string``
- | the token identifier e.g. ETH
|
Returns:
`Promise<Fee> <#type-fee>`_
get transaction info
`Promise<TxInfo> <#type-txinfo>`_ `getTxInfo <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L896>`_ (
txHash:``string``)
Parameters:
.. list-table::
:widths: auto
* - | txHash
- | ``string``
- | the has of the tx you want the info about
|
Returns:
`Promise<TxInfo> <#type-txinfo>`_
set the signer key based on the current pk
`Promise<String> <#type-string>`_ `setKey <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L901>`_ ()
Returns:
`Promise<String> <#type-string>`_
transfers the specified amount to another address within the zksync rollup
`Promise<String> <#type-string>`_ `transfer <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L944>`_ (
to:``string``,
amount:``number``,
token:``string``,
account:``string``)
Parameters:
.. list-table::
:widths: auto
* - | to
- | ``string``
- | address of the receipient
* - | amount
- | ``number``
- | amount to send in wei
* - | token
- | ``string``
- | the token indentifier e.g. ETH
* - | account
- | ``string``
- | address of the account that wants to transfer (if left empty it will be taken from current signer)
|
Returns:
`Promise<String> <#type-string>`_
withdraws the specified amount from the rollup to a specific address
`Promise<String> <#type-string>`_ `withdraw <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L953>`_ (
ethAddress:``string``,
amount:``number``,
token:``string``,
account:``string``)
Parameters:
.. list-table::
:widths: auto
* - | ethAddress
- | ``string``
- | the receipient address
* - | amount
- | ``number``
- | amount to withdraw in wei
* - | token
- | ``string``
- | the token identifier e.g. ETH
* - | account
- | ``string``
- | address of the account that wants to withdraw (if left empty it will be taken from current signer)
|
Returns:
`Promise<String> <#type-string>`_
Source: index.d.ts
.. list-table::
:widths: auto
* - | `anonymous <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L615>`_
- | ``boolean``
- | the anonymous *(optional)*
* - | `components <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L619>`_
- | `ABIField <#type-abifield>`_ []
- | the components *(optional)*
* - | `constant <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L616>`_
- | ``boolean``
- | the constant *(optional)*
* - | `inputs <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L620>`_
- | `ABIField <#type-abifield>`_ []
- | the inputs *(optional)*
* - | `internalType <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L624>`_
- | ``string``
- | the internalType *(optional)*
* - | `name <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L622>`_
- | ``string``
- | the name *(optional)*
* - | `outputs <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L621>`_
- | `ABIField <#type-abifield>`_ [] | ``any`` []
- | the outputs *(optional)*
* - | `payable <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L617>`_
- | ``boolean``
- | the payable *(optional)*
* - | `stateMutability <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L618>`_
- | ``'pure'``
| | ``'view'``
| | ``'nonpayable'``
| | ``'payable'``
| | ``string``
- | the stateMutability *(optional)*
* - | `type <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L623>`_
- | ``'function'``
| | ``'constructor'``
| | ``'event'``
| | ``'fallback'``
| | ``string``
- | the type
Source: index.d.ts
.. list-table::
:widths: auto
* - | `indexed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L610>`_
- | ``boolean``
- | the indexed *(optional)*
* - | `internalType <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L609>`_
- | ``string``
- | the internalType *(optional)*
* - | `name <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L611>`_
- | ``string``
- | the name
* - | `type <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L612>`_
- | ``string``
- | the type
Source: index.d.ts
a 20 byte Address encoded as Hex (starting with 0x)
a Hexcoded String (starting with 0x)
= string
Source: index.d.ts
.. list-table::
:widths: auto
* - | `author <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1079>`_
- | `Address <#type-address>`_
- | 20 Bytes - the address of the author of the block (the beneficiary to whom the mining rewards were given)
* - | `difficulty <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1083>`_
- | `Quantity <#type-quantity>`_
- | integer of the difficulty for this block
* - | `extraData <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1087>`_
- | `Data <#type-data>`_
- | the ‘extra data’ field of this block
* - | `gasLimit <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1091>`_
- | `Quantity <#type-quantity>`_
- | the maximum gas allowed in this block
* - | `gasUsed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1093>`_
- | `Quantity <#type-quantity>`_
- | the total used gas by all transactions in this block
* - | `hash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1063>`_
- | `Hash <#type-hash>`_
- | hash of the block. null when its pending block
* - | `logsBloom <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1071>`_
- | `Data <#type-data>`_
- | 256 Bytes - the bloom filter for the logs of the block. null when its pending block
* - | `miner <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1081>`_
- | `Address <#type-address>`_
- | 20 Bytes - alias of ‘author’
* - | `nonce <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1067>`_
- | `Data <#type-data>`_
- | 8 bytes hash of the generated proof-of-work. null when its pending block. Missing in case of PoA.
* - | `number <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1061>`_
- | `Quantity <#type-quantity>`_
- | The block number. null when its pending block
* - | `parentHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1065>`_
- | `Hash <#type-hash>`_
- | hash of the parent block
* - | `receiptsRoot <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1077>`_
- | `Data <#type-data>`_
- | 32 Bytes - the root of the receipts trie of the block
* - | `sealFields <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1101>`_
- | `Data <#type-data>`_ []
- | PoA-Fields
* - | `sha3Uncles <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1069>`_
- | `Data <#type-data>`_
- | SHA3 of the uncles data in the block
* - | `size <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1089>`_
- | `Quantity <#type-quantity>`_
- | integer the size of this block in bytes
* - | `stateRoot <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1075>`_
- | `Data <#type-data>`_
- | 32 Bytes - the root of the final state trie of the block
* - | `timestamp <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1095>`_
- | `Quantity <#type-quantity>`_
- | the unix timestamp for when the block was collated
* - | `totalDifficulty <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1085>`_
- | `Quantity <#type-quantity>`_
- | integer of the total difficulty of the chain until this block
* - | `transactions <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1097>`_
- | ``string`` | []
- | Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter
* - | `transactionsRoot <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1073>`_
- | `Data <#type-data>`_
- | 32 Bytes - the root of the transaction trie of the block
* - | `uncles <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1099>`_
- | `Hash <#type-hash>`_ []
- | Array of uncle hashes
Source: index.d.ts
data encoded as Hex (starting with 0x)
a Hexcoded String (starting with 0x)
= string
Source: index.d.ts
a 32 byte Hash encoded as Hex (starting with 0x)
a Hexcoded String (starting with 0x)
= string
Source: index.d.ts
.. list-table::
:widths: auto
* - | `address <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1117>`_
- | `Address <#type-address>`_
- | 20 Bytes - address from which this log originated.
* - | `blockHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1113>`_
- | `Hash <#type-hash>`_
- | Hash, 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log.
* - | `blockNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1115>`_
- | `Quantity <#type-quantity>`_
- | the block number where this log was in. null when its pending. null when its pending log.
* - | `data <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1119>`_
- | `Data <#type-data>`_
- | contains the non-indexed arguments of the log.
* - | `logIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1107>`_
- | `Quantity <#type-quantity>`_
- | integer of the log index position in the block. null when its pending log.
* - | `removed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1105>`_
- | ``boolean``
- | true when the log was removed, due to a chain reorganization. false if its a valid log.
* - | `topics <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1121>`_
- | `Data <#type-data>`_ []
- | - Array of 0 to 4 32 Bytes DATA of indexed log arguments. (In solidity: The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declared the event with the anonymous specifier.)
* - | `transactionHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1111>`_
- | `Hash <#type-hash>`_
- | Hash, 32 Bytes - hash of the transactions this log was created from. null when its pending log.
* - | `transactionIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1109>`_
- | `Quantity <#type-quantity>`_
- | integer of the transactions index position log was created from. null when its pending log.
Source: index.d.ts
.. list-table::
:widths: auto
* - | `address <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1130>`_
- | `Address <#type-address>`_
- | (optional) 20 Bytes - Contract address or a list of addresses from which logs should originate.
* - | `fromBlock <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1126>`_
- | `BlockType <#type-blocktype>`_
- | Quantity or Tag - (optional) (default: latest) Integer block number, or 'latest' for the last mined block or 'pending', 'earliest' for not yet mined transactions.
* - | `limit <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1134>`_
- | `Quantity <#type-quantity>`_
- | å(optional) The maximum number of entries to retrieve (latest first).
* - | `toBlock <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1128>`_
- | `BlockType <#type-blocktype>`_
- | Quantity or Tag - (optional) (default: latest) Integer block number, or 'latest' for the last mined block or 'pending', 'earliest' for not yet mined transactions.
* - | `topics <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1132>`_
- | ``string`` | ``string`` [] []
- | (optional) Array of 32 Bytes Data topics. Topics are order-dependent. It’s possible to pass in null to match any topic, or a subarray of multiple topics of which one should be matching.
Source: index.d.ts
Signature
.. list-table::
:widths: auto
* - | `message <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L600>`_
- | `Data <#type-data>`_
- | the message
* - | `messageHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L601>`_
- | `Hash <#type-hash>`_
- | the messageHash
* - | `r <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L603>`_
- | `Hash <#type-hash>`_
- | the r
* - | `s <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L604>`_
- | `Hash <#type-hash>`_
- | the s
* - | `signature <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L605>`_
- | `Data <#type-data>`_
- | the signature *(optional)*
* - | `v <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L602>`_
- | `Hex <#type-hex>`_
- | the v
Source: index.d.ts
.. list-table::
:widths: auto
* - | `chainId <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L642>`_
- | ``any``
- | optional chain id *(optional)*
* - | `data <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L638>`_
- | ``string``
- | 4 byte hash of the method signature followed by encoded parameters. For details see Ethereum Contract ABI.
* - | `from <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L628>`_
- | `Address <#type-address>`_
- | 20 Bytes - The address the transaction is send from.
* - | `gas <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L632>`_
- | `Quantity <#type-quantity>`_
- | Integer of the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
* - | `gasPrice <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L634>`_
- | `Quantity <#type-quantity>`_
- | Integer of the gas price used for each paid gas.
* - | `nonce <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L640>`_
- | `Quantity <#type-quantity>`_
- | nonce
* - | `to <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L630>`_
- | `Address <#type-address>`_
- | (optional when creating new contract) 20 Bytes - The address the transaction is directed to.
* - | `value <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L636>`_
- | `Quantity <#type-quantity>`_
- | Integer of the value sent with this transaction.
Source: index.d.ts
.. list-table::
:widths: auto
* - | `blockHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1022>`_
- | `Hash <#type-hash>`_
- | 32 Bytes - hash of the block where this transaction was in. null when its pending.
* - | `blockNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1024>`_
- | `BlockType <#type-blocktype>`_
- | block number where this transaction was in. null when its pending.
* - | `chainId <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1050>`_
- | `Quantity <#type-quantity>`_
- | the chain id of the transaction, if any.
* - | `condition <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1054>`_
- | ``any``
- | (optional) conditional submission, Block number in block or timestamp in time or null. (parity-feature)
* - | `creates <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1052>`_
- | `Address <#type-address>`_
- | creates contract address
* - | `from <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1028>`_
- | `Address <#type-address>`_
- | 20 Bytes - address of the sender.
* - | `gas <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1036>`_
- | `Quantity <#type-quantity>`_
- | gas provided by the sender.
* - | `gasPrice <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1034>`_
- | `Quantity <#type-quantity>`_
- | gas price provided by the sender in Wei.
* - | `hash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1018>`_
- | `Hash <#type-hash>`_
- | 32 Bytes - hash of the transaction.
* - | `input <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1038>`_
- | `Data <#type-data>`_
- | the data send along with the transaction.
* - | `nonce <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1020>`_
- | `Quantity <#type-quantity>`_
- | the number of transactions made by the sender prior to this one.
* - | `pk <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1056>`_
- | ``any``
- | optional: the private key to use for signing *(optional)*
* - | `publicKey <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1048>`_
- | `Hash <#type-hash>`_
- | public key of the signer.
* - | `r <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1044>`_
- | `Quantity <#type-quantity>`_
- | the R field of the signature.
* - | `raw <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1046>`_
- | `Data <#type-data>`_
- | raw transaction data
* - | `standardV <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1042>`_
- | `Quantity <#type-quantity>`_
- | the standardised V field of the signature (0 or 1).
* - | `to <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1030>`_
- | `Address <#type-address>`_
- | 20 Bytes - address of the receiver. null when its a contract creation transaction.
* - | `transactionIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1026>`_
- | `Quantity <#type-quantity>`_
- | integer of the transactions index position in the block. null when its pending.
* - | `v <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1040>`_
- | `Quantity <#type-quantity>`_
- | the standardised V field of the signature.
* - | `value <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1032>`_
- | `Quantity <#type-quantity>`_
- | value transferred in Wei.
Source: index.d.ts
.. list-table::
:widths: auto
* - | `blockHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L984>`_
- | `Hash <#type-hash>`_
- | 32 Bytes - hash of the block where this transaction was in.
* - | `blockNumber <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L986>`_
- | `BlockType <#type-blocktype>`_
- | block number where this transaction was in.
* - | `contractAddress <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L988>`_
- | `Address <#type-address>`_
- | 20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null.
* - | `cumulativeGasUsed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L990>`_
- | `Quantity <#type-quantity>`_
- | The total amount of gas used when this transaction was executed in the block.
* - | `events <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1010>`_
- |
- | event objects, which are only added in the web3Contract *(optional)*
* - | `from <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L992>`_
- | `Address <#type-address>`_
- | 20 Bytes - The address of the sender.
* - | `gasUsed <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L996>`_
- | `Quantity <#type-quantity>`_
- | The amount of gas used by this specific transaction alone.
* - | `logs <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L998>`_
- | `Log <#type-log>`_ []
- | Array of log objects, which this transaction generated.
* - | `logsBloom <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1000>`_
- | `Data <#type-data>`_
- | 256 Bytes - A bloom filter of logs/events generated by contracts during transaction execution. Used to efficiently rule out transactions without expected logs.
* - | `root <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1002>`_
- | `Hash <#type-hash>`_
- | 32 Bytes - Merkle root of the state trie after the transaction has been executed (optional after Byzantium hard fork EIP609)
* - | `status <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1004>`_
- | `Quantity <#type-quantity>`_
- | 0x0 indicates transaction failure , 0x1 indicates transaction success. Set for blocks mined after Byzantium hard fork EIP609, null before.
* - | `to <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L994>`_
- | `Address <#type-address>`_
- | 20 Bytes - The address of the receiver. null when it’s a contract creation transaction.
* - | `transactionHash <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1006>`_
- | `Hash <#type-hash>`_
- | 32 Bytes - hash of the transaction.
* - | `transactionIndex <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1008>`_
- | `Quantity <#type-quantity>`_
- | Integer of the transactions index position in the block.
Source: index.d.ts
.. list-table::
:widths: auto
* - | `args <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1163>`_
- | ``any`` []
- | the argument to pass to the method *(optional)*
* - | `confirmations <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1169>`_
- | ``number``
- | number of block to wait before confirming *(optional)*
* - | `data <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1145>`_
- | `Data <#type-data>`_
- | the data to send *(optional)*
* - | `from <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1142>`_
- | `Address <#type-address>`_
- | address of the account to use *(optional)*
* - | `gas <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1148>`_
- | ``number``
- | the gas needed *(optional)*
* - | `gasPrice <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1151>`_
- | ``number``
- | the gasPrice used *(optional)*
* - | `method <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1160>`_
- | ``string``
- | the ABI of the method to be used *(optional)*
* - | `nonce <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1154>`_
- | ``number``
- | the nonce *(optional)*
* - | `pk <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1166>`_
- | `Hash <#type-hash>`_
- | raw private key in order to sign *(optional)*
* - | `timeout <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1172>`_
- | ``number``
- | number of seconds to wait for confirmations before giving up. Default: 10 *(optional)*
* - | `to <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1139>`_
- | `Address <#type-address>`_
- | contract *(optional)*
* - | `value <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1157>`_
- | `Quantity <#type-quantity>`_
- | the value in wei *(optional)*
Source: index.d.ts
bitcoin configuration.
.. list-table::
:widths: auto
* - | `maxDAP <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1724>`_
- | ``number``
- | max number of DAPs (Difficulty Adjustment Periods) allowed when accepting new targets. *(optional)*
* - | `maxDiff <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L1729>`_
- | ``number``
- | max increase (in percent) of the difference between targets when accepting new targets. *(optional)*
Source: index.d.ts
zksync configuration.
.. list-table::
:widths: auto
* - | `account <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L975>`_
- | ``string``
- | the account to be used. if not specified, the first signer will be used. *(optional)*
* - | `provider_url <https://github.com/slockit/in3-c/blob/master/wasm/src/index.d.ts#L970>`_
- | ``string``
- | url of the zksync-server *(optional)*
Source: index.d.ts
a Hexcoded String (starting with 0x)
= string
Source: index.d.ts
BlockNumber or predefined Block
= number | 'latest' | 'earliest' | 'pending'
Source: index.d.ts
a BigInteger encoded as hex.
= number | Hex