Submit a message.

POST 
/api/v1/messages

Submit a message. The node takes care of missing fields and tries to build the message. On success, the message will be stored in the Tangle. This endpoint will return the identifier of the built message. The node will try to auto-fill the following fields in case they are missing: networkId, parentMessageIds, nonce. If payload is missing, the message will be built without a payload.

Request

application/json

Body

required

networkId string

Network identifier. This field signifies for which network the message is meant for. It also tells which protocol rules apply to the message. It is computed out of the first 8 bytes of the BLAKE2b-256 hash of the concatenation of the network type and protocol version string.

parentMessageIds string[]

The identifiers of the messages this message references.

payload object
oneOf
TransactionPayload
type integerrequired
Set to value 0 to denote a Transaction Payload.
essence objectrequired
oneOf
TransactionEssence
type integerrequired
Set to value 0 to denote a Transaction Essence.
inputs object[]required
Array [
oneOf
UTXOInput
type integerrequired
Set to value 0 to denote an UTXO Input.
transactionId stringrequired
The BLAKE2b-256 hash of the transaction from which the UTXO comes from.
transactionOutputIndex integerrequired
The index of the output on the referenced transaction to consume.
]
outputs object[]required
Array [
anyOf
SigLockedSingleOutput
type integerrequired
Set to value 0 to denote a SigLockedSingleOutput.
address objectrequired
anyOf
Ed25519Address
type integerrequired
Set to value 0 to denote an Ed25519 Address.
address stringrequired
The hex-encoded BLAKE2b-256 hash of the Ed25519 public key.
amount integerrequired
The amount of tokens to deposit with this SigLockedSingleOutput output.
SigLockedDustAllowanceOutput
type integerrequired
Set to value 1 to denote a SigLockedDustAllowanceOutput.
address objectrequired
anyOf
Ed25519Address
type integerrequired
Set to value 0 to denote an Ed25519 Address.
address stringrequired
The hex-encoded BLAKE2b-256 hash of the Ed25519 public key.
amount integerrequired
The amount of tokens to deposit with this SigLockedDustAllowanceOutput output.
]
payload objectnullablerequired
oneOf
IndexationPayload
type integerrequired
Set to value 2 to denote a Indexation Payload.
index stringrequired
The indexation key to find/look up this message. It has a size between 1 and 64 bytes and must be encoded as a hex-string.
data stringrequired
The optional data to attach. This may have a length of 0.
unlockBlocks object[]required
Array [
oneOf
SignatureUnlockBlock
type integerrequired
Denotes a Signature Unlock Block.
signature objectrequired
oneOf
Ed25519Signature
type integerrequired
Set to value 0 to denote an Ed25519 Signature.
publicKey stringrequired
The public key of the Ed25519 keypair which is used to verify the signature.
signature stringrequired
The signature signing the serialized Transaction Essence.
ReferenceUnlockBlock
type integerrequired
Set to value 1 to denote a Reference Unlock Block.
reference integerrequired
Represents the index of a previous unlock block.
]
MilestonePayload
type integerrequired
Set to value 1 to denote a Milestone Payload.
index integerrequired
The index of the milestone.
timestamp integerrequired
The Unix timestamp at which the milestone was issued. The unix timestamp is specified in seconds.
parents string[]required
The identifiers of the messages this milestone references.
inclusionMerkleProof stringrequired
256-bit hash based on the message IDs of all the not-ignored state-mutating transactions referenced by the milestone.
nextPoWScore numberrequired
nextPoWScoreMilestoneIndex numberrequired
publicKeys string[]required
An array of public keys to validate the signatures. The keys must be in lexicographical order.
signatures string[]required
An array of signatures signing the serialized Milestone Essence. The signatures must be in the same order as the specified public keys.
IndexationPayload
type integerrequired
Set to value 2 to denote a Indexation Payload.
index stringrequired
The indexation key to find/look up this message. It has a size between 1 and 64 bytes and must be encoded as a hex-string.
data stringrequired
The optional data to attach. This may have a length of 0.
TreasuryTransactionPayload
type integerrequired
Set to value 4 to denote a Treasury Payload.
input TreasuryInput
type integerrequired
Set to value 1 to denote a TreasuryInput.
milestoneId stringrequired
output TreasuryOutput
type integerrequired
Set to value 2 to denote a TreasuryOutput.
amount integerrequired
ReceiptPayload
migratedAt integerrequired
final booleanrequired
funds MigratedFundsEntry[]required
Array [
tailTransactionHash stringrequired
address objectrequired
oneOf
Ed25519Address
type integerrequired
Set to value 0 to denote an Ed25519 Address.
address stringrequired
The hex-encoded BLAKE2b-256 hash of the Ed25519 public key.
deposit integerrequired
]
transaction TreasuryTransactionPayloadrequired
type integerrequired
Set to value 4 to denote a Treasury Payload.
input TreasuryInput
type integerrequired
Set to value 1 to denote a TreasuryInput.
milestoneId stringrequired
output TreasuryOutput
type integerrequired
Set to value 2 to denote a TreasuryOutput.
amount integerrequired
nonce string

The nonce which lets this message fulfill the Proof-of-Work requirement.

application/octet-stream

Body

required

• string binary

  message in raw binary format

Responses

201

Successful operation.

application/json

Schema

Schema

data objectrequired

messageId stringrequired

The message identifier of the submitted message.

Example (from schema)

{
  "data": {
    "messageId": "string"
  }
}

default

{
  "data": {
    "messageId": "a4dd36465af63d495d35a05f592d42a51511c153e1bae8fad00453c8cbb48727"
  }
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

503

Unsuccessful operation: indicates that the node can´t auto-fill the parents or perform Proof-of-Work.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 503,
    "message": "service unavailable"
  }
}

Loading...