EosioSerializationProviderProtocol

public protocol EosioSerializationProviderProtocol

The protocol to which serialization provider implementations must conform. Serialization providers are responsible for ABI-driven transaction and action serialization and deserialization between JSON and binary data representations.

Show on GitHub

  • Used to hold errors.

    Declaration

    Swift

    var error: String? { get }
    Show on GitHub

  • Initializer for the EosioSerializationProviderProtocol.

    Declaration

    Swift

    init()
    Show on GitHub

  • The method signature for general serialization requests to conforming serialization providers. Carries out JSON to binary conversion using ABIs.

    Throws

    If the data cannot be serialized for any reason.

    Declaration

    Swift

    func serialize(contract: String?, name: String, type: String?, json: String, abi: String) throws -> String

    Parameters

    contract

    An optional String representing contract name for the serialize action lookup for this conversion.
    name

    An optional String representing an action name that is used in conjunction with contract (above) to derive the serialize type name.
    type

    An optional String representing the type name for the action lookup for this serialize conversion.
    json

    The JSON data String to serialize to binary.
    abi

    A String representation of the ABI to use for conversion.

    Return Value

    A String of binary serialized data.

    Show on GitHub

  • The method signature for general deserialization requests to conforming serialization providers. Carries out binary to JSON conversion using ABIs.

    Throws

    If the data cannot be deserialized for any reason.

    Declaration

    Swift

    func deserialize(contract: String?, name: String, type: String?, hex: String, abi: String) throws -> String

    Parameters

    contract

    An optional String representing contract name for the deserialize action lookup for this conversion.
    name

    An optional String representing an action name that is used in conjunction with contract (above) to derive the deserialize type name.
    type

    An optional String representing the type name for the action lookup for this deserialize conversion.
    hex

    The binary data String to deserialize to a JSON String.
    abi

    A String representation of the ABI to use for conversion.

    Return Value

    A String of JSON data.

    Show on GitHub

  • The method signature for transaction serialization requests to conforming serialization providers. Convert JSON Transaction data representation to binary String representation of Transaction data.

    Throws

    If the data cannot be serialized for any reason.

    Declaration

    Swift

    func serializeTransaction(json: String) throws -> String

    Parameters

    json

    The JSON representation of Transaction data to serialize.

    Return Value

    A binary String representation of Transaction data.

    Show on GitHub

  • The method signature for transaction deserialization requests to conforming serialization providers. Converts a binary String representation of Transaction data to JSON String of Transaction data.

    Throws

    If the data cannot be deserialized for any reason.

    Declaration

    Swift

    func deserializeTransaction(hex: String) throws -> String

    Parameters

    hex

    The binary Transaction data String to deserialize.

    Return Value

    A String of JSON Transaction data.

    Show on GitHub

  • The method signature for ABI serialization requests to conforming serialization providers. Convert JSON ABI to a String binary representation of data.

    Throws

    If the data cannot be serialized for any reason.

    Declaration

    Swift

    func serializeAbi(json: String) throws -> String

    Parameters

    json

    The JSON data String to serialize.

    Return Value

    A String representation of binary data.

    Show on GitHub

  • The method signature for ABI deserialization requests to conforming serialization providers. Converts a binary String hex representation of an ABI to a JSON String.

    Throws

    If the data cannot be deserialized for any reason.

    Declaration

    Swift

    func deserializeAbi(hex: String) throws -> String

    Parameters

    hex

    The binary data String to deserialize.

    Return Value

    A String of JSON data.

    Show on GitHub