Skip to main content

Solidity API

ID_KIND_OF_SET​

uint64 ID_KIND_OF_SET

ID_KIND_OF_KIND​

uint64 ID_KIND_OF_KIND

ID_KIND_OF_REL​

uint64 ID_KIND_OF_REL

ID_SET_OF_SET​

uint64 ID_SET_OF_SET

ID_SET_OF_KIND​

uint64 ID_SET_OF_KIND

ID_SET_OF_REL​

uint64 ID_SET_OF_REL

ID_SET_SYSTEM_MAX​

uint64 ID_SET_SYSTEM_MAX

ID_KIND_SYSTEM_MAX​

uint64 ID_KIND_SYSTEM_MAX

ID_REL_SYSTEM_MAX​

uint64 ID_REL_SYSTEM_MAX

ID_MIN​

uint64 ID_MIN

ID_MAX​

uint64 ID_MAX

ID_UNSPECIFIED​

uint64 ID_UNSPECIFIED

ID_WILDCARD​

uint64 ID_WILDCARD

REV_NEW​

uint32 REV_NEW

REV_DESTROYED​

uint32 REV_DESTROYED

STATE_SPEC_CAPACITY​

uint256 STATE_SPEC_CAPACITY

REL_SPEC_CAPACITY​

uint256 REL_SPEC_CAPACITY

ADJ_SPEC_CAPACITY​

uint256 ADJ_SPEC_CAPACITY

RecordStatus​

enum RecordStatus {
  NONE,
  ACTIVE,
  INACTIVE,
  DELETED
}

StateField​

enum StateField {
  NONE,
  IMAGE,
  JSON,
  WASM,
  BYTES32,
  UINT,
  PLANE_SPEC,
  STATE_SPEC,
  END
}

ELEMENT_TYPE_MIN​

uint256 ELEMENT_TYPE_MIN

ELEMENT_TYPE_MAX​

uint256 ELEMENT_TYPE_MAX

ElementType​

enum ElementType {
  NONE,
  IMAGE,
  JSON,
  WASM,
  BYTES32,
  UINT,
  PLANE_SPEC,
  STATE_SPEC,
  END
}

PossessionMode​

enum PossessionMode {
  NONE,
  ATTACH,
  DEPOSIT,
  DELEGATE,
  POST,
  TRANSFER,
  BURN
}

ConnectionMode​

enum ConnectionMode {
  NONE,
  DEP_TO_DEST
}

TokenStandard​

enum TokenStandard {
  NONE,
  NATIVE,
  ERC20,
  ERC721,
  ERC1155
}

FeePolicy​

enum FeePolicy {
  NONE,
  FREE,
  CHARGE
}

PermPolicy​

enum PermPolicy {
  NONE,
  ANYONE,
  OWNER,
  ALLOWLIST,
  NATIVE_HOLDER,
  ERC20_HOLDER,
  ERC721_HOLDER,
  ERC1155_HOLDER
}

ObjectId​

struct ObjectId {
  uint64 chain;
  uint64 bp;
  uint64 fa;
  uint64 sn;
}

ObjectMeta​

struct ObjectMeta {
  uint32 rev;
  uint32 krev;
  uint32 srev;
  uint32 cap;
  uint64 kind;
  uint64 set;
}

ObjectDesign​

struct ObjectDesign {
  uint64 start;
  uint64 end;
  uint64 bpId;
  uint32 bpRev;
  uint32 resId;
  uint256 locator;
  enum StateField[] stored;
  enum StateField[] input;
  enum StateField[] generated;
  uint8[] output;
}

TokenAmount​

struct TokenAmount {
  address addr;
  enum TokenStandard std;
  uint24 id;
  uint64 amount;
}

SupplyRule​

struct SupplyRule {
  uint32 index;
  enum PermPolicy permPolicy;
  enum FeePolicy feePolicy;
  uint40 openning;
  uint40 closing;
  uint64 start;
  uint64 end;
  uint256 perm;
  struct TokenAmount fee;
}

ResourceType​

enum ResourceType {
  NONE,
  PLAIN_TABLE,
  PERMUTATION_TABLE,
  PLAIN_TABLE_ROOT
}

ResourceLocatorType​

enum ResourceLocatorType {
  NONE,
  PATTERN_MAPPING
}

ResourceSchema​

struct ResourceSchema {
  enum ResourceType type_;
  uint16 rows;
  enum StateField[] cols;
  uint16[] ends;
}

ResourceLocatorPatternMapping​

struct ResourceLocatorPatternMapping {
  uint8 type_;
  uint8 _zero;
  uint16 offset;
  int16 multiplier;
  uint16 destStart;
  uint16 destEnd;
}

RuleInput​

struct RuleInput {
  uint32 index;
  bytes32[] proof;
}

ResourceInput​

struct ResourceInput {
  uint8 inputLen;
  uint8 storedLen;
  uint16 row;
  uint256[] input;
  uint256[] storedPreImage;
  bytes32[] storedProof;
}

MintDataLayout​

struct MintDataLayout {
  uint32 rule;
  uint8 ruleProofLen;
  uint8 inputLen;
  uint8 preImageLen;
  uint8 preImageProofLen;
  uint64 preImageIndex;
  bytes32[] ruleProof;
  uint256[] input;
  uint256[] preImage;
  bytes32[] preImageProof;
}

MintData​

struct MintData {
  uint32 rule;
  uint64 preImageIndex;
  bytes32[] ruleProof;
  uint256[] input;
  uint256[] preImage;
  bytes32[] preImageProof;
}