NGC 7293, Helix Nebula

WebSocket API

Connect to the Blocknative service over WebSocket protocol

Creating a Socket Connection

A WebSocket connection should be created with the Blocknative service at wss://api.blocknative.com/v0. A successful connection will receive a response object that contains a status parameter with a value of 'ok'.

Required Parameters

The following parameters are required for all messages that are sent to the Blocknative service:

parameter

type

description

timeStamp

string

an ISO datetime string formatted YYYY-MM-DDThh:mm:ss.sTZD (see example for usage and https://www.w3.org/TR/NOTE-datetime for more details)

dappId

string

your API key

version

string

a version string usually used by the Blocknative SDK, but any version string can be used

blockchain

object

object specifying a the system and network of the blockchain (see next)

system

string

blockchain name, valid value is ethereum

network

string

blockchain network, valid values for support systems are:

Ethereum (and EVM compatible) - main, goerli, kovan, xdai, matic-main,

{

"timeStamp": "2021-01-11T06:21:40.197Z",

"dappId": "<YOUR_API_KEY>",

"version": "1",

"blockchain": {

"system": "ethereum"

"network": "main"

}

// ...rest of the message specific parameter

}

Initialization

Once a connection has been created with the Blocknative WebSocket service, an initialization message must be sent before any other messages so that the API key can be validated.

You API Key is created/managed from the Mempool Explorer account management page at https://explorer.blocknative.com/account. Note that API Key is called dappId in the Blocknative websocket protocol.

{

"categoryCode": "initialize",

"eventCode": "checkDappId",

// ...rest of the required parameters

}

Subscriptions

You can subscribe to receive transaction state change events by either watching a transaction hash/id or an address.

Ethereum Transaction Hash

// subscribe

{

"categoryCode": "activeTransaction",

"eventCode": "txSent",

"transaction": {

"hash": "0x0b4c94c414f71ddd5e7a625fcaa83ff1f93e9a7ca37e0f577b488ac8fd786655"

}

// ...rest of the required parameters

}

// unsubscribe

{

"categoryCode": "activeTransaction",

"eventCode": "unwatch",

"transaction": {

"hash": "0x0b4c94c414f71ddd5e7a625fcaa83ff1f93e9a7ca37e0f577b488ac8fd786655"

}

// ...rest of the required parameters

}

Address (Ethereum)

// subscribe

{

"categoryCode": "accountAddress",

"eventCode": "watch",

"account": {

"address": "0xf5b5bd85157587771db6d49315b1712201569bdd"

}

// ...rest of the required parameters

}

// unsubscribe

{

"categoryCode": "accountAddress",

"eventCode": "unwatch",

"account": {

"address": "0xf5b5bd85157587771db6d49315b1712201569bdd"

}

// ...rest of the required parameters

}

Configurations

A configuration can be sent to the service to filter and/or decode transactions.

Transaction decoding is only available for Ethereum transactions

There is a limit of 50 configurations per connection / API key. If you need to watch more than 50 addresses and also filter them, it is recommended that you subscribe to all of the addresses and then add a 'global' scoped filter that will apply to all of those addresses.

{

"categoryCode": "configs",

"eventCode": "put",

"config": {

"scope": "0xf5b5bd85157587771db6d49315b1712201569bdd",

"filters": [{"contractCall.methodName":"transfer"}],

"abi": [{

"constant": false,

"inputs": [{ "name": "newOwner", "type": "address" }],

"name": "setOwner",

"outputs": [],

"payable": false,

"stateMutability": "nonpayable",

"type": "function"

}],

"watchAddress": true

}

// ...rest of the required parameters

}

parameter

type

description

scope

string

A valid Ethereum address or 'global'

filters

string[]

An array of valid filters. The Blocknative service uses jsql, a JavaScript query language to filter events. Documentation for how to create filter queries can be found here

abi

string[]

A valid JSON ABI that will be used to decode input data for transactions that occur on the contract address defined in scope

watchAddress

boolean

defines whether the service should automatically watch the address as defined in scope

scope establishes the context in which a filter is applied. The global scope applies the filter to all transactions/addresses watched. Therefore a global scope only supports generic transaction elements. A scope set to an address can include filters, such as methodName,that are specific to the contract at that address. Similarly, the abi field only works for a contract specific scope.

Connection Drops

In the event of a WebSocket connection drop, no state is persisted between connections, so upon reconnection there will need to be logic defined that will:

1.Send an initialization message

2.Send all previously subscribed addresses, transactions and configs

Transaction Events

Each message sent to the service will receive an echo of that message back, this echo may be ignored for most purposes.

Every payload contains an eventCode parameter in the event object which indicates the type of event. Detailed documentation for event codes can be found in the here.

Ethereum Transaction Payload

{

"version":0,

"serverVersion":"0.85.8",

"timeStamp":"2021-01-06T01:25:24.716Z",

"connectionId":"49babf8c03a18ca8577b8dc42e4ab9e8cbdf3148d4b4b1e311f54f24c19e0e57",

"status":"ok",

"event":{

"timeStamp":"2021-01-06T01:25:24.716Z",

"categoryCode":"activeAddress",

"eventCode":"txConfirmed",

"dappId":"<DAPP ID>",

"blockchain":{

"system":"ethereum",

"network":"main"

"transaction":{

"status":"confirmed",

"monitorId":"GETH_1_F_PROD",

"monitorVersion":"0.77.3",

"timePending":"5482902",

"blocksPending":410,

"hash":"0x045fbad4090a25fc8267cf80f0f095a202cdac465d534e4c942b2068086e9aa3",

"from":"0xbA99926Be550865a956febAF4A747FFA0648797A",

"to":"0x111111125434b319222CdBf8C261674aDB56F3ae",

"value":"0",

"gas":324499,

"gasPrice":"61000000000",

"nonce":179,

"blockHash":"0x543bd57151cb7ab3024a18a459844790278861c712e9e4b58e1939a207e9fb82",

"blockNumber":11598068,

"transactionIndex":307,

"input": "0x34b0793b000000000000000...",

"gasUsed": 138022,

"asset":"ETH",

"watchedAddress":"0x111111125434b319222cdbf8c261674adb56f3ae",

"direction":"incoming",

"counterparty":"0xbA99926Be550865a956febAF4A747FFA0648797A"

}

Address subscription payload additional properties

If the transaction event is linked to an address subscription it will have the following properties that are unique to address subscriptions:

parameter

type

description

watchedAddress

string

the address subscription that this transaction is linked to, allowing you to match the transaction to a subscription

direction

string

a value of incoming or outgoing indicating whether the watched address is sending or receiving the transaction

counterparty

string

the counter-party to the watched address

Confirmed/failed transaction payload additional properties

Transactions with a status of confirmed will have the following additional properties that are not included in other statuses:

parameter

type

description

timePending

string

the time, in milliseconds, the transaction was pending before being included in a block

blocksPending

string

the number of blocks the transaction was pending before being included in a block

blockHash

string

the hash of the block containing the confirmed (or failed) transaction

blockNumber

number

the number of the block containing the confirmed (or failed) transaction

gasUsed

number

the amount of gas used to confirm (or fail) the transaction

Replaced transactions payload additional properties

Transactions that have been replaced and have a status of speedup or cancel will have the following additional properties that are not included in other statuses:

parameter

type

description

originalHash

string

the hash of the transaction that is being replaced

Errors

Errors from the service are returned as messages with a status = 'error' and a reason string explaining the error.

Websocket payload is too large (60,000 bytes):

{

//...other params

status: 'error',

reason: 'message too large'

}

API key (dappId) parameter is missing:

{

//...other params

status: 'error',

reason: 'missing dappId'

}

API key (dappId) is invalid:

{

//...other params

status: 'error',

reason: '<DAPP-ID> is not a valid API key'

}

Attempt to watch an invalid address:

Address validity is based on the specific blockchain system used (bitcoin or ethereum).

{

//...other params

"status":"error",

"reason":"(string `address`) 0 is an invalid address in object `account` in object `websocket-event`"

}

Amount of messages has exceeded limit, see Rate Limits section below.

{

//...other params

status: 'error',

reason: 'ratelimit',

retryMs: 1000,

blockedMsg: <Message that was blocked>

}

Exceeded daily event limit for your API key, see Rate Limits section below.

{

//...other params

status: 'error',

reason: 'You have reached your event rate limit for today. See account.blocknative.com for details.'

}

IP has been rate limited, see Rate Limits section below.

{

//...other params

status: 'error',

reason: 'IP ratelimited**'**

}

Error received for using incorrect API version.

{

//...other params

status: 'error',

message: 'api version not supported',

}

Supported Networks

See Mempool API Support Networks.

Rate Limits

Daily per API key event rate limits that apply to Webhook events also apply to WebSocket events. Details on those limits can be found here.

The Blocknative service also limits how many messages can be sent over a duration of time, limiting to 50 messages per second.

A strategy that the Blocknative SDK uses to handle these limits is to create a message queue that processes messages and ensures that messages are spaced adequately. This can be especially important to implement when re-sending addresses to be subscribed after a connection dropout.

If a rate limit error message is received you can use the retryMs parameter to wait for that time period to continue sending messages. If a message was blocked due to a rate limit it will be included in the payload in the blockedMsg parameter so you can re-send that message after the retry delay, ensuring that no messages are dropped.

2 notes View Post

blocktopkevinkimapi

1 year ago

Connection

The websocket endpoint is,EnvironmentURIprodwss://ws.blockchain.info/mercury-gateway/v1/ws

In order to connect you have to add the following headers to the connection requestEnvironmentHeadersprodOrigin: https://exchange.blockchain.com

Requests

IF YOU HAVE WEED VAPE PEN YOUR WEED WILL BE ON THE OUTTER RINGER WITH SMUDGES OF ON THE GLASS BURN IT OFF AND AIR

4 notes View Post

blocktopkevinkimapi

1 year ago

Connection

The websocket endpoint is,EnvironmentURIprodwss://ws.blockchain.info/mercury-gateway/v1/ws

In order to connect you have to add the following headers to the connection requestEnvironmentHeadersprodOrigin: https://exchange.blockchain.com

Requests

Blair Waldorf: Carrd.| Only Elegant Aesthetic.

blair waldorf: carrd.| only elegant aesthetic.

like/reblog if you save. @sarccaios

1K notes View Post

blocktopkevinkimapi

1 year ago

Connection

The websocket endpoint is,EnvironmentURIprodwss://ws.blockchain.info/mercury-gateway/v1/ws

In order to connect you have to add the following headers to the connection requestEnvironmentHeadersprodOrigin: https://exchange.blockchain.com

Requests

FY23 Defense Funding Levels (in billions of dollars) Department of Defense $ 816.7 Department of Energy $ 30.3 NDAA Topline $ 847.3 Defense-related Activities Outside NDAA Jurisdiction $ 10.6 National Defense Topline $ 857.9

Authorizes funding to support a 4.6 percent pay raise for both military servicemembers and the DOD civilian workforce.  Authorizes additional funding to address the effects of inflation on compensation.  Authorizes an increase of $70 million for Impact Aid ($50 million for supplemental Impact Aid and $20 million for Impact Aid for military children with severe disabilities).  Broadens the reach and impact of the Basic Needs Allowance by increasing the eligibility threshold and allowance size from 130% of the Federal poverty line to 150% of the Federal poverty line as a baseline, and authorizes the Secretary of Defense to increase this benefit to 200% of the poverty line when appropriate.  Increases maximum amounts for bonus and special pay authorities for servicemembers in certain critical-skill positions.  Revives and extends temporary authority for targeted recruitment incentives to ensure the military can meet its recruiting and retention needs.  Expands the scope of financial reimbursement related to spouse relicensing and business costs arising from a permanent change of station.  Initiates a pilot program to reimburse military families for certain child care costs related to a permanent change of station.  Creates an open season during calendar year 2023 for eligible retired or former members to opt in or out of the Survivor Benefit Plan.  Ensures servicemembers have access to quality housing, including by: extending the authority to adjust the basic allowance for housing (BAH) in high-cost areas; encouraging DOD to coordinate efforts to address housing shortages; and codifying that the Assistant Secretary of Defense for Energy, Installations, and Environment should serve as the Chief Housing Officer. End Strength  Army – 452,000  Navy – 354,000  Air Force – 325,344  Marine Corps – 177,000  Space Force – 8,600  Authorizes reserve component military end strengths in line with President's request, with the exception of Air National Guard military technicians and full-time Reserve and Guard personnel, which are to remain at FY2022 levels.

5 notes View Post