protobuf
type MarkerAccount struct {
    // cosmos base_account including address and account number
    Address string
    AccountNumber uint64
    PubKey *types.Any // NOTE: not used for marker, it is not possible to sign for a marker account directly
    Sequence uint64 // NOTE: always zero on marker

    // Address that owns the marker configuration. This account must sign any requests
    // to change marker config (only valid for statuses prior to finalization)
    Manager string

    // Access control lists. Account addresses are assigned control of the marker using these entries
    AccessControl []AccessGrant

    // Indicates the current status of this marker record. (Pending, Active, Cancelled, etc)
    Status MarkerStatus

    // value denomination.
    Denom string

    // the total supply expected for a marker. This is the amount that is minted when a marker is created. For
    // SupplyFixed markers this value will be enforced through an invariant that mints/burns from this account to
    // maintain a match between this value and the supply on the chain (maintained by bank module). For all non-fixed
    // supply markers this value will be set to zero when the marker is activated.
    Supply Int

    // Marker type information. The type of marker controls behavior of its account.
    MarkerType MarkerType

    // A fixed supply will mint additional coin automatically if the total supply decreases below a set value. This
    // may occur if the coin is burned or an account holding the coin is slashed. (default: true)
    SupplyFixed bool

    // indicates that governance based control is allowed for this marker
    AllowGovernanceControl bool

    // Whether an admin can transfer restricted coins from a 3rd-party account without their signature.
    AllowForcedTransfer bool

    // list of required attributes on restricted marker in order to send and receive transfers if sender does not have
    // transfer authority
    RequiredAttributes []string
}

• Coin - A marker with a type of coin represents a standard fungible token with zero or more coins in circulation

• Restricted Coin - Restricted Coins work just like a regular coin with one important difference--the bank module "send_enabled" status for the coin is set to false. This means that a user account that holds the coin can not send it to another account directly using the bank module. In order to facilitate exchange there must be an address set on the marker with the "Transfer" permission grant. This address must sign calls to the marker module to move these coins between accounts using the transfer method on the api.

go
const (
    // ACCESS_UNSPECIFIED defines a no-op vote option.
    Access_Unknown Access = 0

    // ACCESS_MINT is the ability to increase the supply of a marker.
    Access_Mint Access = 1

    // ACCESS_BURN is the ability to decrease the supply of the marker using coin held by the marker.
    Access_Burn Access = 2

    // ACCESS_DEPOSIT is the ability to transfer funds from another account to this marker account
    // or to set a reference to this marker in the metadata/scopes module.
    Access_Deposit Access = 3

    // ACCESS_WITHDRAW is the ability to transfer funds from this marker account to another account
    // or to remove a reference to this marker in the metadata/scopes module.
    Access_Withdraw Access = 4

    // ACCESS_DELETE is the ability to move a proposed, finalized or active marker into the cancelled state.
    // This access also allows cancelled markers to be marked for deletion.
    Access_Delete Access = 5

    // ACCESS_ADMIN is the ability to add access grants for accounts to the list of marker permissions.
    // This access also gives the ability to update the marker's denom metadata.
    Access_Admin Access = 6

    // ACCESS_TRANSFER is the ability to manage transfer settings and broker transfers of the marker.
    // Accounts with this access can:
    // - Update the marker's required attributes.
    // - Update the send-deny list.
    // - Use the transfer or bank send endpoints to move marker funds out of their own account.
    // This access right is only supported on RESTRICTED markers.
    Access_Transfer Access = 7

    // ACCESS_FORCE_TRANSFER is the ability to transfer restricted coins from a 3rd-party account without their signature.
    // This access right is only supported on RESTRICTED markers and only has meaning when allow_forced_transfer is true.
    Access_ForceTransfer Access = 8
)

// A structure associating a list of access permissions for a given account identified by is address
type AccessGrant struct {
    // A bech32 encoded address string of the account the permissions are assigned to
    Address string
    // An array of enum values as defined above
    Permissions AccessList
}

• If the supply in circulation exceeds the configured amount the attempted fix is to burn a required amount from the marker's account itself. If this fails an invariant will be broken and the chain will halt.

• If the requested supply is greater than the amount in circulation (as occurs when a coin is burned in a slash) the marker module will mint the difference between expected supply and circulation and place the created coin in the marker's account.

plain text
0x01 | Address -> Address

• Params: Paramsspace("marker") -> legacy_amino(params)

• Proposed is the initial state of a marker by default. It is not possible to transition to this state from any other.

• Finalized

• Cancelled

• Marker must exist

• Caller address must match the manager address on the marker

• Current status of marker must be Proposed

• Supply of the marker must meet or exceed the amount of any existing coin in circulation on the network of the denom of the marker

• Marker status is set to Finalized

• A marker finalize typed event is dispatched

• Active

• Cancelled

• Marker status is set to Active

• Requested coin supply is minted and placed in the marker account

• For markers with a fixed_supply the Invariant checks are performed in begin_block

• Permissions as assigned in the access list are enforced for any management actions performed

• The manager field is cleared. All management actions require explicit permission grants.

• A marker activate typed event is dispatched

• Cancelled

• Caller must have the delete permission assigned to their address or

• Caller must be the manager of the marker (applies only to proposed markers that are Cancelled)

• The supply of the coin in circulation outside of the marker account must be zero.

• Marker status is set to Cancelled

• A marker Cancelled typed event is dispatched

• Destroyed

• All supply of the coin denom will be burned.

• Marker status is set to Destroyed

• Marker will ultimately be deleted from the KVStore during the next ABCI Begin Block (v1.3.0+)

• None

protobuf
message MsgAddMarkerRequest {
  cosmos.base.v1beta1.Coin amount = 1;
  string manager = 3;
  MarkerType marker_type = 4;
  repeated AccessGrant access_list = 5;
  bool supply_fixed = 6;
  bool allow_governance_control = 7;
  bool allow_forced_transfer = 8;
  repeated string required_attributes = 9;
  uint64 usd_mills = 10;
}

• The Denom string is already in use, doesn't conform to validation expressions, or is invalid

• The supply value is less than zero or greater than max supply parameter

• The Marker Status is Active, Cancelled, or Destroyed

• The manager address is invalid

protobuf
message MsgAddAccessRequest {
  string denom = 1;
  string administrator = 2;
  repeated AccessGrant access = 3;
}

• Invalid denom or marker doesn't exist

• Invalid administrator address or insufficient permissions

• Invalid access list with duplicate entries or invalid access values

protobuf
message MsgDeleteAccessRequest {
  string denom = 1;
  string administrator = 2;
  string removed_address = 3;
}

protobuf
message MsgFinalizeRequest {
  string denom = 1;
  string administrator = 2;
}

protobuf
message MsgActivateRequest {
  string denom = 1;
  string administrator = 2;
}

protobuf
message MsgCancelRequest {
  string denom = 1;
  string administrator = 2;
}

protobuf
message MsgDeleteRequest {
  string denom = 1;
  string administrator = 2;
}

protobuf
message MsgMintRequest {
  cosmos.base.v1beta1.Coin amount = 1;
  string administrator = 2;
}

protobuf
message MsgBurnRequest {
  cosmos.base.v1beta1.Coin amount = 1;
  string administrator = 2;
}

protobuf
message MsgWithdrawRequest {
  string denom = 1;
  string administrator = 2;
  string to_address = 3;
  repeated cosmos.base.v1beta1.Coin amount = 4;
}

protobuf
message MsgTransferRequest {
  cosmos.base.v1beta1.Coin amount = 1;
  string administrator = 2;
  string from_address = 3;
  string to_address = 4;
}

protobuf
message MsgIbcTransferRequest {
  cosmos.base.v1beta1.Coin transfer = 1;
  string administrator = 2;
  string from_address = 3;
  string to_address = 4;
}

protobuf
message MsgSetDenomMetadataRequest {
  cosmos.bank.v1beta1.Metadata metadata = 1;
  string administrator = 2;
}

protobuf
message MsgAddFinalizeActivateMarkerRequest {
  cosmos.base.v1beta1.Coin amount = 1;
  string manager = 3;
  MarkerType marker_type = 4;
  repeated AccessGrant access_list = 5;
  bool supply_fixed = 6;
  bool allow_governance_control = 7;
  bool allow_forced_transfer = 8;
  repeated string required_attributes = 9;
  uint64 usd_mills = 10;
}

protobuf
message MsgGrantAllowanceRequest {
  string denom = 1;
  string administrator = 2;
  string grantee = 3;
  google.protobuf.Any allowance = 4;
}

protobuf
message MsgSupplyIncreaseProposalRequest {
  cosmos.base.v1beta1.Coin amount = 1;
  string target_address = 2;
  string authority = 3;
}

protobuf
message MsgUpdateRequiredAttributesRequest {
  string denom = 1;
  repeated string remove_required_attributes = 2;
  repeated string add_required_attributes = 3;
  string transfer_authority = 4;
}

protobuf
message MsgUpdateSendDenyListRequest {
  string denom = 1;
  repeated string remove_denied_addresses = 2;
  repeated string add_denied_addresses = 3;
  string authority = 4;
}

protobuf
message MsgUpdateForcedTransferRequest {
  string denom = 1;
  bool allow_forced_transfer = 2;
  string authority = 3;
}

protobuf
message MsgSetAccountDataRequest {
  string denom = 1;
  string value = 2;
  string signer = 3;
}

protobuf
message MsgAddNetAssetValuesRequest {
  string denom = 1;
  repeated NetAssetValue net_asset_values = 2;
  string administrator = 3;
}

protobuf
message QueryParamsRequest {}

protobuf
message QueryParamsResponse {
  // params defines the parameters of the module.
  Params params = 1 [(gogoproto.nullable) = false];
}

protobuf
message QueryAllMarkersRequest {
  // Optional status to filter request
  MarkerStatus status = 1;
  // pagination defines an optional pagination for the request.
  cosmos.base.query.v1beta1.PageRequest pagination = 2;
}

protobuf
message QueryAllMarkersResponse {
  repeated google.protobuf.Any markers = 1 [(cosmos_proto.accepts_interface) = "MarkerAccountI"];
  // pagination defines an optional pagination for the request.
  cosmos.base.query.v1beta1.PageResponse pagination = 2;
}

protobuf
message QueryMarkerRequest {
  // the address or denom of the marker
  string id = 1;
}

protobuf
message QueryMarkerResponse {
  google.protobuf.Any marker = 1 [(cosmos_proto.accepts_interface) = "MarkerAccountI"];
}

protobuf
message QueryHoldingRequest {
  // the address or denom of the marker
  string id = 1;
  // pagination defines an optional pagination for the request.
  cosmos.base.query.v1beta1.PageRequest pagination = 2;
}

protobuf
message QueryHoldingResponse {
  repeated Balance balances = 1 [(gogoproto.nullable) = false];
  // pagination defines an optional pagination for the request.
  cosmos.base.query.v1beta1.PageResponse pagination = 2;
}

protobuf
message Balance {
  option (gogoproto.equal)           = false;
  option (gogoproto.goproto_getters) = false;

  // address is the address of the balance holder.
  string address = 1;

  // coins defines the different coins this balance holds.
  repeated cosmos.base.v1beta1.Coin coins = 2 [
    (gogoproto.nullable)     = false,
    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
    (amino.dont_omitempty)   = true,
    (amino.encoding)         = "legacy_coins"
  ];
}

protobuf
message QuerySupplyRequest {
  // address or denom for the marker
  string id = 1;
}

protobuf
message QuerySupplyResponse {
  // amount is the supply of the marker.
  cosmos.base.v1beta1.Coin amount = 1 [(gogoproto.nullable) = false];
}

protobuf
message QueryEscrowRequest {
  // address or denom for the marker
  string id = 1;
}

protobuf
message QueryEscrowResponse {
  repeated cosmos.base.v1beta1.Coin escrow = 1 [
    (gogoproto.nullable)     = false,
    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
    (amino.dont_omitempty)   = true,
    (amino.encoding)         = "legacy_coins"
  ];
}

protobuf
message QueryAccessRequest {
  // address or denom for the marker
  string id = 1;
}

protobuf
message QueryAccessResponse {
  repeated AccessGrant accounts = 1 [(gogoproto.nullable) = false];
}

protobuf
message QueryDenomMetadataRequest {
  string denom = 1;
}

protobuf
message QueryDenomMetadataResponse {
  cosmos.bank.v1beta1.Metadata metadata = 1 [(gogoproto.nullable) = false];
}

protobuf
message QueryAccountDataRequest {
  // The denomination to look up.
  string denom = 1;
}

protobuf
message QueryAccountDataResponse {
  // The accountdata for the requested denom.
  string value = 1;
}

protobuf
message QueryNetAssetValuesRequest {
  // address or denom for the marker
  string id = 1;
}

protobuf
message QueryNetAssetValuesResponse {
  // net asset values for marker denom
  repeated NetAssetValue net_asset_values = 1 [(gogoproto.nullable) = false];
}

• Max Total Supply (uint64) - A value indicating the maximum supply level allowed for any added marker. This is now deprecated and should not be used.

• Max Supply (math.Int) - A value indicating the maximum supply level allowed for any added marker.

• Enable Governance (boolean) - A flag indicating if allow_governance_control setting on added markers must be set to true.

• Unrestricted Denom Regex (string) - A regular expression that is used to check the denom value on markers added by calling AddMarker. This is intended to further restrict what may be used for a denom when a generic marker is created.