nym/contracts/mixnet/schema/raw/response_to_get_owned_mixnode.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "MixOwnershipResponse",
  "description": "Response containing details of a mixnode belonging to the particular owner.",
  "type": "object",
  "required": [
    "address"
  ],
  "properties": {
    "address": {
      "description": "Validated address of the mixnode owner.",
      "allOf": [
        {
          "$ref": "#/definitions/Addr"
        }
      ]
    },
    "mixnode_details": {
      "description": "If the provided address owns a mixnode, this field contains its detailed information.",
      "anyOf": [
        {
          "$ref": "#/definitions/MixNodeDetails"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "additionalProperties": false,
  "definitions": {
    "Addr": {
      "description": "A human readable address.\n\nIn Cosmos, this is typically bech32 encoded. But for multi-chain smart contracts no assumptions should be made other than being UTF-8 encoded and of reasonable length.\n\nThis type represents a validated address. It can be created in the following ways 1. Use `Addr::unchecked(input)` 2. Use `let checked: Addr = deps.api.addr_validate(input)?` 3. Use `let checked: Addr = deps.api.addr_humanize(canonical_addr)?` 4. Deserialize from JSON. This must only be done from JSON that was validated before such as a contract's state. `Addr` must not be used in messages sent by the user because this would result in unvalidated instances.\n\nThis type is immutable. If you really need to mutate it (Really? Are you sure?), create a mutable copy using `let mut mutable = Addr::to_string()` and operate on that `String` instance.",
      "type": "string"
    },
    "Coin": {
      "type": "object",
      "required": [
        "amount",
        "denom"
      ],
      "properties": {
        "amount": {
          "$ref": "#/definitions/Uint128"
        },
        "denom": {
          "type": "string"
        }
      }
    },
    "Decimal": {
      "description": "A fixed-point decimal value with 18 fractional digits, i.e. Decimal(1_000_000_000_000_000_000) == 1.0\n\nThe greatest possible value that can be represented is 340282366920938463463.374607431768211455 (which is (2^128 - 1) / 10^18)",
      "type": "string"
    },
    "MixNode": {
      "description": "Information provided by the node operator during bonding that are used to allow other entities to use the services of this node.",
      "type": "object",
      "required": [
        "host",
        "http_api_port",
        "identity_key",
        "mix_port",
        "sphinx_key",
        "verloc_port",
        "version"
      ],
      "properties": {
        "host": {
          "description": "Network address of this mixnode, for example 1.1.1.1 or foo.mixnode.com",
          "type": "string"
        },
        "http_api_port": {
          "description": "Port used by this mixnode for its http(s) API",
          "type": "integer",
          "format": "uint16",
          "minimum": 0.0
        },
        "identity_key": {
          "description": "Base58-encoded ed25519 EdDSA public key.",
          "type": "string"
        },
        "mix_port": {
          "description": "Port used by this mixnode for listening for mix packets.",
          "type": "integer",
          "format": "uint16",
          "minimum": 0.0
        },
        "sphinx_key": {
          "description": "Base58-encoded x25519 public key used for sphinx key derivation.",
          "type": "string"
        },
        "verloc_port": {
          "description": "Port used by this mixnode for listening for verloc requests.",
          "type": "integer",
          "format": "uint16",
          "minimum": 0.0
        },
        "version": {
          "description": "The self-reported semver version of this mixnode.",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "MixNodeBond": {
      "description": "Basic mixnode information provided by the node operator.",
      "type": "object",
      "required": [
        "bonding_height",
        "is_unbonding",
        "mix_id",
        "mix_node",
        "original_pledge",
        "owner"
      ],
      "properties": {
        "bonding_height": {
          "description": "Block height at which this mixnode has been bonded.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0.0
        },
        "is_unbonding": {
          "description": "Flag to indicate whether this node is in the process of unbonding, that will conclude upon the epoch finishing.",
          "type": "boolean"
        },
        "mix_id": {
          "description": "Unique id assigned to the bonded mixnode.",
          "type": "integer",
          "format": "uint32",
          "minimum": 0.0
        },
        "mix_node": {
          "description": "Information provided by the operator for the purposes of bonding.",
          "allOf": [
            {
              "$ref": "#/definitions/MixNode"
            }
          ]
        },
        "original_pledge": {
          "description": "Original amount pledged by the operator of this node.",
          "allOf": [
            {
              "$ref": "#/definitions/Coin"
            }
          ]
        },
        "owner": {
          "description": "Address of the owner of this mixnode.",
          "allOf": [
            {
              "$ref": "#/definitions/Addr"
            }
          ]
        },
        "proxy": {
          "description": "Entity who bonded this mixnode on behalf of the owner. If exists, it's most likely the address of the vesting contract.",
          "anyOf": [
            {
              "$ref": "#/definitions/Addr"
            },
            {
              "type": "null"
            }
          ]
        }
      }
    },
    "MixNodeDetails": {
      "description": "Full details associated with given mixnode.",
      "type": "object",
      "required": [
        "bond_information",
        "rewarding_details"
      ],
      "properties": {
        "bond_information": {
          "description": "Basic bond information of this mixnode, such as owner address, original pledge, etc.",
          "allOf": [
            {
              "$ref": "#/definitions/MixNodeBond"
            }
          ]
        },
        "pending_changes": {
          "description": "Adjustments to the mixnode that are ought to happen during future epoch transitions.",
          "default": {
            "cost_params_change": null,
            "pledge_change": null
          },
          "allOf": [
            {
              "$ref": "#/definitions/PendingMixNodeChanges"
            }
          ]
        },
        "rewarding_details": {
          "description": "Details used for computation of rewarding related data.",
          "allOf": [
            {
              "$ref": "#/definitions/NodeRewarding"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "NodeCostParams": {
      "description": "The cost parameters, or the cost function, defined for the particular mixnode that influences how the rewards should be split between the node operator and its delegators.",
      "type": "object",
      "required": [
        "interval_operating_cost",
        "profit_margin_percent"
      ],
      "properties": {
        "interval_operating_cost": {
          "description": "Operating cost of the associated node per the entire interval.",
          "allOf": [
            {
              "$ref": "#/definitions/Coin"
            }
          ]
        },
        "profit_margin_percent": {
          "description": "The profit margin of the associated node, i.e. the desired percent of the reward to be distributed to the operator.",
          "allOf": [
            {
              "$ref": "#/definitions/Percent"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "NodeRewarding": {
      "type": "object",
      "required": [
        "cost_params",
        "delegates",
        "last_rewarded_epoch",
        "operator",
        "total_unit_reward",
        "unique_delegations",
        "unit_delegation"
      ],
      "properties": {
        "cost_params": {
          "description": "Information provided by the operator that influence the cost function.",
          "allOf": [
            {
              "$ref": "#/definitions/NodeCostParams"
            }
          ]
        },
        "delegates": {
          "description": "Total delegation and compounded reward earned by all node delegators.",
          "allOf": [
            {
              "$ref": "#/definitions/Decimal"
            }
          ]
        },
        "last_rewarded_epoch": {
          "description": "Marks the epoch when this node was last rewarded so that we wouldn't accidentally attempt to reward it multiple times in the same epoch.",
          "type": "integer",
          "format": "uint32",
          "minimum": 0.0
        },
        "operator": {
          "description": "Total pledge and compounded reward earned by the node operator.",
          "allOf": [
            {
              "$ref": "#/definitions/Decimal"
            }
          ]
        },
        "total_unit_reward": {
          "description": "Cumulative reward earned by the \"unit delegation\" since the block 0.",
          "allOf": [
            {
              "$ref": "#/definitions/Decimal"
            }
          ]
        },
        "unique_delegations": {
          "type": "integer",
          "format": "uint32",
          "minimum": 0.0
        },
        "unit_delegation": {
          "description": "Value of the theoretical \"unit delegation\" that has delegated to this node at block 0.",
          "allOf": [
            {
              "$ref": "#/definitions/Decimal"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "PendingMixNodeChanges": {
      "type": "object",
      "properties": {
        "cost_params_change": {
          "default": null,
          "type": [
            "integer",
            "null"
          ],
          "format": "uint32",
          "minimum": 0.0
        },
        "pledge_change": {
          "type": [
            "integer",
            "null"
          ],
          "format": "uint32",
          "minimum": 0.0
        }
      },
      "additionalProperties": false
    },
    "Percent": {
      "description": "Percent represents a value between 0 and 100% (i.e. between 0.0 and 1.0)",
      "allOf": [
        {
          "$ref": "#/definitions/Decimal"
        }
      ]
    },
    "Uint128": {
      "description": "A thin wrapper around u128 that is using strings for JSON encoding/decoding, such that the full u128 range can be used for clients that convert JSON numbers to floats, like JavaScript and jq.\n\n# Examples\n\nUse `from` to create instances of this and `u128` to get the value out:\n\n``` # use cosmwasm_std::Uint128; let a = Uint128::from(123u128); assert_eq!(a.u128(), 123);\n\nlet b = Uint128::from(42u64); assert_eq!(b.u128(), 42);\n\nlet c = Uint128::from(70u32); assert_eq!(c.u128(), 70); ```",
      "type": "string"
    }
  }
}