Skip to content

Latest commit

 

History

History
429 lines (299 loc) · 11.3 KB

evm_streams.md

File metadata and controls

429 lines (299 loc) · 11.3 KB
Raw

evm_streams API:

streams.evm_streams

add_address_to_stream

streams.evm_streams.add_address_to_stream()

Adds an address to a Stream.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
params = {
    "id": "", 
}
body = {
    "address": "", 
}

result = streams.evm_streams.add_address_to_stream(
    api_key=api_key,
    params=params,
    body=body,
)

print(result)

Parameters

Name Type Description Required Default Example
id str The id of the stream to add the address to Yes ""

Body

Object with the properties:

Name Type Description Required Default Example
address str The address or a list of addresses to be added to the Stream. Yes ""

create_stream

streams.evm_streams.create_stream()

Creates a new evm stream.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
body = {
    "webhookUrl": "", 
    "description": "", 
    "tag": "", 
    "topic0": [], 
    "allAddresses": True, 
    "includeNativeTxs": True, 
    "includeContractLogs": True, 
    "includeInternalTxs": True, 
    "includeAllTxLogs": True, 
    "getNativeBalances": [], 
    "abi": {}, 
    "advancedOptions": [], 
    "chainIds": [], 
    "demo": True, 
    "triggers": [], 
}

result = streams.evm_streams.create_stream(
    api_key=api_key,
    body=body,
)

print(result)

Body

Object with the properties:

Name Type Description Required Default Example
webhookUrl str Webhook URL where moralis will send the POST request. Yes ""
description str A description for this stream Yes ""
tag str A user-provided tag that will be send along the webhook, the user can use this tag to identify the specific stream if multiple streams are present Yes ""
topic0 List of str An Array of topic0's in string-signature format ex: ['FunctionName(address,uint256)'] Yes []
allAddresses bool Include events for all addresses (only applied when abi and topic0 is provided) Yes True
includeNativeTxs bool Include or not native transactions defaults to false Yes True
includeContractLogs bool Include or not logs of contract interactions defaults to false Yes True
includeInternalTxs bool Include or not include internal transactions defaults to false Yes True
includeAllTxLogs bool Include all logs if atleast one value in tx or log matches stream config Yes True
getNativeBalances List of object:
- selectors: List of str
- type: enum[str]:
- "tx"
- "log"
- "erc20transfer"
- "erc20approval"
- "nfttransfer"
- "internalTx"		 Include native balances for each address in the webhook Yes []
abi object Yes {}
advancedOptions List of object:
- topic0: str
- filter: object:

- includeNativeTxs: bool		 Yes []
chainIds List of str The ids of the chains for this stream in hex Ex: ["0x1","0x38"] Yes []
demo bool Indicator if it is a demo stream Yes True
triggers List of object:
- type: enum[str]:
- "tx"
- "log"
- "erc20transfer"
- "erc20approval"
- "nfttransfer"
- contractAddress: str
- inputs: List of str
- functionAbi: object:
- anonymous: bool
- constant: bool
- inputs: List of AbiInput
- name: str
- outputs: List of AbiOutput
- payable: bool
- stateMutability: str
- type: str
- gas: float
- topic0: str
- callFrom: str		 triggers Yes []

delete_address_from_stream

streams.evm_streams.delete_address_from_stream()

Deletes an address from a Stream.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
params = {
    "id": "", 
}
body = {
    "address": "", 
}

result = streams.evm_streams.delete_address_from_stream(
    api_key=api_key,
    params=params,
    body=body,
)

print(result)

Parameters

Name Type Description Required Default Example
id str The id of the stream to delete the address from Yes ""

Body

Object with the properties:

Name Type Description Required Default Example
address str The address or a list of addresses to be removed from the Stream. Yes ""

delete_stream

streams.evm_streams.delete_stream()

Delete a specific evm stream.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
params = {
    "id": "", 
}

result = streams.evm_streams.delete_stream(
    api_key=api_key,
    params=params,
)

print(result)

Parameters

Name Type Description Required Default Example
id str The id of the stream to delete Yes ""

get_addresses

streams.evm_streams.get_addresses()

Get all addresses associated with a specific stream.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
params = {
    "id": "", 
    "limit": 1.2, 
    "cursor": "", 
}

result = streams.evm_streams.get_addresses(
    api_key=api_key,
    params=params,
)

print(result)

Parameters

Name Type Description Required Default Example
id str the id of the stream to get the addresses from Yes ""
limit float Limit response results max value 100 Yes 1.2
cursor str Cursor for fetching next page ""

get_stream

streams.evm_streams.get_stream()

Get a specific evm stream.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
params = {
    "id": "", 
}

result = streams.evm_streams.get_stream(
    api_key=api_key,
    params=params,
)

print(result)

Parameters

Name Type Description Required Default Example
id str The id of the stream to get Yes ""

get_streams

streams.evm_streams.get_streams()

Get all the evm streams for the current project based on the project api-key.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
params = {
    "limit": 1.2, 
    "cursor": "", 
}

result = streams.evm_streams.get_streams(
    api_key=api_key,
    params=params,
)

print(result)

Parameters

Name Type Description Required Default Example
limit float Limit response results max value 100 Yes 1.2
cursor str Cursor for fetching next page ""

update_stream

streams.evm_streams.update_stream()

Updates a specific evm stream.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
params = {
    "id": "", 
}
body = {
    "webhookUrl": "", 
    "description": "", 
    "tag": "", 
    "topic0": [], 
    "allAddresses": True, 
    "includeNativeTxs": True, 
    "includeContractLogs": True, 
    "includeInternalTxs": True, 
    "includeAllTxLogs": True, 
    "getNativeBalances": [], 
    "abi": {}, 
    "advancedOptions": [], 
    "chainIds": [], 
    "demo": True, 
    "triggers": [], 
}

result = streams.evm_streams.update_stream(
    api_key=api_key,
    params=params,
    body=body,
)

print(result)

Parameters

Name Type Description Required Default Example
id str The id of the stream to update Yes ""

Body

Object with the properties:

Name Type Description Required Default Example
webhookUrl str Webhook URL where moralis will send the POST request. Yes ""
description str A description for this stream Yes ""
tag str A user-provided tag that will be send along the webhook, the user can use this tag to identify the specific stream if multiple streams are present Yes ""
topic0 List of str An Array of topic0's in string-signature format ex: ['FunctionName(address,uint256)'] Yes []
allAddresses bool Include events for all addresses (only applied when abi and topic0 is provided) Yes True
includeNativeTxs bool Include or not native transactions defaults to false Yes True
includeContractLogs bool Include or not logs of contract interactions defaults to false Yes True
includeInternalTxs bool Include or not include internal transactions defaults to false Yes True
includeAllTxLogs bool Include all logs if atleast one value in tx or log matches stream config Yes True
getNativeBalances List of object:
- selectors: List of str
- type: enum[str]:
- "tx"
- "log"
- "erc20transfer"
- "erc20approval"
- "nfttransfer"
- "internalTx"		 Include native balances for each address in the webhook Yes []
abi object Yes {}
advancedOptions List of object:
- topic0: str
- filter: object:

- includeNativeTxs: bool		 Yes []
chainIds List of str The ids of the chains for this stream in hex Ex: ["0x1","0x38"] Yes []
demo bool Indicator if it is a demo stream Yes True
triggers List of object:
- type: enum[str]:
- "tx"
- "log"
- "erc20transfer"
- "erc20approval"
- "nfttransfer"
- contractAddress: str
- inputs: List of str
- functionAbi: object:
- anonymous: bool
- constant: bool
- inputs: List of AbiInput
- name: str
- outputs: List of AbiOutput
- payable: bool
- stateMutability: str
- type: str
- gas: float
- topic0: str
- callFrom: str		 triggers Yes []

update_stream_status

streams.evm_streams.update_stream_status()

Updates the status of specific evm stream.

Example

from moralis import streams

api_key = "YOUR_API_KEY"
params = {
    "id": "", 
}
body = {
    "status": "", 
}

result = streams.evm_streams.update_stream_status(
    api_key=api_key,
    params=params,
    body=body,
)

print(result)

Parameters

Name Type Description Required Default Example
id str The id of the stream to update Yes ""

Body

Object with the properties:

Name Type Description Required Default Example
status enum[str]:
- "active"
- "paused"
- "error"
- "terminated"		 The status of the stream. Yes ""