nym/contracts/ecash/schema/raw/execute.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ExecuteMsg",
  "oneOf": [
    {
      "description": "Submitted by clients to escrow funds and register a claimed ed25519 identity key. Mints a sequential `deposit_id`. The contract does not verify control of the identity key - that proof is checked off-chain by nym-api signers at blind-sign time.",
      "type": "object",
      "required": [
        "deposit_ticket_book_funds"
      ],
      "properties": {
        "deposit_ticket_book_funds": {
          "type": "object",
          "required": [
            "identity_key"
          ],
          "properties": {
            "identity_key": {
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    {
      "description": "Submitted by gateways to request batch redemption of spent tickets. Dispatches a `Propose` SubMsg to the multisig contract; the actual transfer effect is gated behind multisig approval.",
      "type": "object",
      "required": [
        "request_redemption"
      ],
      "properties": {
        "request_redemption": {
          "type": "object",
          "required": [
            "commitment_bs58",
            "number_of_tickets"
          ],
          "properties": {
            "commitment_bs58": {
              "type": "string"
            },
            "number_of_tickets": {
              "type": "integer",
              "format": "uint16",
              "minimum": 0.0
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    {
      "description": "**Legacy / dead code.** Only callable by the multisig; bumps the unredeemed-tickets counter and emits a `ticket_redemption` event with `moved_to_holding_account = \"false\"`. No known consumer depends on the side effects; candidate for removal in a follow-on breaking-schema change.",
      "type": "object",
      "required": [
        "redeem_tickets"
      ],
      "properties": {
        "redeem_tickets": {
          "type": "object",
          "required": [
            "gw",
            "n"
          ],
          "properties": {
            "gw": {
              "type": "string"
            },
            "n": {
              "type": "integer",
              "format": "uint16",
              "minimum": 0.0
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    {
      "description": "Transfer the contract admin role. Only the current admin may sign. Dispatches via the cw_controllers `execute_update_admin` handshake.",
      "type": "object",
      "required": [
        "update_admin"
      ],
      "properties": {
        "update_admin": {
          "type": "object",
          "required": [
            "admin"
          ],
          "properties": {
            "admin": {
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    {
      "description": "Overwrite `Config::deposit_amount`. Only callable by the contract admin. Rejects values below `nym_network_defaults::TICKETBOOK_SIZE` and trips `TicketBookSizeChanged` if the snapshotted invariant has diverged from the current crate constant.",
      "type": "object",
      "required": [
        "update_default_deposit_value"
      ],
      "properties": {
        "update_default_deposit_value": {
          "type": "object",
          "required": [
            "new_deposit"
          ],
          "properties": {
            "new_deposit": {
              "$ref": "#/definitions/Coin"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    {
      "description": "Set (or overwrite) a reduced deposit price for a specific address. Only callable by the contract admin.",
      "type": "object",
      "required": [
        "set_reduced_deposit_price"
      ],
      "properties": {
        "set_reduced_deposit_price": {
          "type": "object",
          "required": [
            "address",
            "deposit"
          ],
          "properties": {
            "address": {
              "type": "string"
            },
            "deposit": {
              "$ref": "#/definitions/Coin"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    {
      "description": "Remove the reduced deposit price for a specific address, reverting them to the default price. Returns an error if the address has no custom price set. Only callable by the contract admin.",
      "type": "object",
      "required": [
        "remove_reduced_deposit_price"
      ],
      "properties": {
        "remove_reduced_deposit_price": {
          "type": "object",
          "required": [
            "address"
          ],
          "properties": {
            "address": {
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    {
      "description": "**Stubbed**: always returns `EcashContractError::UnimplementedBlacklisting`. Storage, reply handler, and helper paths exist but are unreachable from the public ExecuteMsg surface. Preserved for the redesign.",
      "type": "object",
      "required": [
        "propose_to_blacklist"
      ],
      "properties": {
        "propose_to_blacklist": {
          "type": "object",
          "required": [
            "public_key"
          ],
          "properties": {
            "public_key": {
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    {
      "description": "*Stubbed**: always returns `EcashContractError::UnimplementedBlacklisting`.",
      "type": "object",
      "required": [
        "add_to_blacklist"
      ],
      "properties": {
        "add_to_blacklist": {
          "type": "object",
          "required": [
            "public_key"
          ],
          "properties": {
            "public_key": {
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  ],
  "definitions": {
    "Coin": {
      "type": "object",
      "required": [
        "amount",
        "denom"
      ],
      "properties": {
        "amount": {
          "$ref": "#/definitions/Uint128"
        },
        "denom": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "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"
    }
  }
}