GuidesAPI Reference
DocumentationLog In

Objects

Block

Schema

Blocks contain an array of Transactions that occurred at a particular BlockIdentifier. A hard requirement for blocks returned by Rosetta implementations is that they MUST be inalterable: once a client has requested and received a block identified by a specific BlockIndentifier, all future calls for that same BlockIdentifier must return the same block contents.

{
    "block_identifier": {
        "index": 1123941,
        "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
    },
    "parent_block_identifier": {
        "index": 1123941,
        "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
    },
    "timestamp": 1582833600000,
    "transactions": [
        {
            "transaction_identifier": {
                "hash": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f"
            },
            "operations": [
                {
                    "operation_identifier": {
                        "index": 5,
                        "network_index": 0
                    },
                    "related_operations": [
                        {
                            "index": 1
                        },
                        {
                            "index": 2
                        }
                    ],
                    "type": "Transfer",
                    "status": "Reverted",
                    "account": {
                        "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
                        "sub_account": {
                            "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
                            "metadata": {}
                        },
                        "metadata": {}
                    },
                    "amount": {
                        "value": "1238089899992",
                        "currency": {
                            "symbol": "BTC",
                            "decimals": 8,
                            "metadata": {
                                "Issuer": "Satoshi"
                            }
                        },
                        "metadata": {}
                    },
                    "coin_change": {
                        "coin_identifier": {
                            "identifier": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1"
                        },
                        "coin_action": "coin_created"
                    },
                    "metadata": {
                        "asm": "304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd01 03301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2",
                        "hex": "48304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd012103301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2"
                    }
                }
            ],
            "related_transactions": [
                {
                    "network_identifier": {
                        "blockchain": "bitcoin",
                        "network": "mainnet",
                        "sub_network_identifier": {
                            "network": "shard 1",
                            "metadata": {
                                "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
                            }
                        }
                    },
                    "transaction_identifier": {
                        "hash": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f"
                    },
                    "direction": "forward"
                }
            ],
            "metadata": {
                "size": 12378,
                "lockTime": 1582272577
            }
        }
    ],
    "metadata": {
        "transactions_root": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
        "difficulty": "123891724987128947"
    }
}

Transaction

Schema

Transactions contain an array of Operations that are attributable to the same TransactionIdentifier.

{
    "transaction_identifier": {
        "hash": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f"
    },
    "operations": [
        {
            "operation_identifier": {
                "index": 5,
                "network_index": 0
            },
            "related_operations": [
                {
                    "index": 1
                },
                {
                    "index": 2
                }
            ],
            "type": "Transfer",
            "status": "Reverted",
            "account": {
                "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
                "sub_account": {
                    "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
                    "metadata": {}
                },
                "metadata": {}
            },
            "amount": {
                "value": "1238089899992",
                "currency": {
                    "symbol": "BTC",
                    "decimals": 8,
                    "metadata": {
                        "Issuer": "Satoshi"
                    }
                },
                "metadata": {}
            },
            "coin_change": {
                "coin_identifier": {
                    "identifier": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1"
                },
                "coin_action": "coin_created"
            },
            "metadata": {
                "asm": "304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd01 03301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2",
                "hex": "48304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd012103301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2"
            }
        }
    ],
    "related_transactions": [
        {
            "network_identifier": {
                "blockchain": "bitcoin",
                "network": "mainnet",
                "sub_network_identifier": {
                    "network": "shard 1",
                    "metadata": {
                        "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
                    }
                }
            },
            "transaction_identifier": {
                "hash": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f"
            },
            "direction": "forward"
        }
    ],
    "metadata": {
        "size": 12378,
        "lockTime": 1582272577
    }
}

Operation

Schema

Operations contain all balance-changing information within a transaction. They are always one-sided (only affect 1 AccountIdentifier) and can succeed or fail independently from a Transaction. Operations are used both to represent on-chain data (Data API) and to construct new transactions (Construction API), creating a standard interface for reading and writing to blockchains.

{
    "operation_identifier": {
        "index": 5,
        "network_index": 0
    },
    "related_operations": [
        {
            "index": 1
        },
        {
            "index": 2
        }
    ],
    "type": "Transfer",
    "status": "Reverted",
    "account": {
        "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
        "sub_account": {
            "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
            "metadata": {}
        },
        "metadata": {}
    },
    "amount": {
        "value": "1238089899992",
        "currency": {
            "symbol": "BTC",
            "decimals": 8,
            "metadata": {
                "Issuer": "Satoshi"
            }
        },
        "metadata": {}
    },
    "coin_change": {
        "coin_identifier": {
            "identifier": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1"
        },
        "coin_action": "coin_created"
    },
    "metadata": {
        "asm": "304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd01 03301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2",
        "hex": "48304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd012103301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2"
    }
}

Amount

Schema

Amount is some Value of a Currency. It is considered invalid to specify a Value without a Currency.

{
    "value": "1238089899992",
    "currency": {
        "symbol": "BTC",
        "decimals": 8,
        "metadata": {
            "Issuer": "Satoshi"
        }
    },
    "metadata": {}
}

Currency

Schema

Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins).

{
    "symbol": "BTC",
    "decimals": 8,
    "metadata": {
        "Issuer": "Satoshi"
    }
}

Error

Schema

Instead of utilizing HTTP status codes to describe node errors (which often do not have a good analog), rich errors are returned using this object. Both the code and message fields can be individually used to correctly identify an error. Implementations MUST use unique values for both fields.

{
    "code": 12,
    "message": "Invalid account format",
    "description": "This error is returned when the requested AccountIdentifier is improperly formatted.",
    "retriable": true,
    "details": {
        "address": "0x1dcc4de8dec75d7aab85b567b6",
        "error": "not base64"
    }
}

SigningPayload

Schema

SigningPayload is signed by the client with the keypair associated with an AccountIdentifier using the specified SignatureType. SignatureType can be optionally populated if there is a restriction on the signature scheme that can be used to sign the payload.

{
    "address": "string",
    "account_identifier": {
        "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
        "sub_account": {
            "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
            "metadata": {}
        },
        "metadata": {}
    },
    "hex_bytes": "string",
    "signature_type": "ecdsa"
}

PublicKey

Schema

PublicKey contains a public key byte array for a particular CurveType encoded in hex. Note that there is no PrivateKey struct as this is NEVER the concern of an implementation.

{
    "hex_bytes": "string",
    "curve_type": "secp256k1"
}

Signature

Schema

Signature contains the payload that was signed, the public keys of the keypairs used to produce the signature, the signature (encoded in hex), and the SignatureType. PublicKey is often times not known during construction of the signing payloads but may be needed to combine signatures properly.

{
    "signing_payload": {
        "address": "string",
        "account_identifier": {
            "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
            "sub_account": {
                "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
                "metadata": {}
            },
            "metadata": {}
        },
        "hex_bytes": "string",
        "signature_type": "ecdsa"
    },
    "public_key": {
        "hex_bytes": "string",
        "curve_type": "secp256k1"
    },
    "signature_type": "ecdsa",
    "hex_bytes": "string"
}