toid

Documentation

Index

• Constants
• type ID
  • func AfterLedger(seq int32) *ID
  • func New(ledger int32, tx int32, op int32) *ID
  • func Parse(id int64) (result ID)
  • func (id *ID) IncOperationOrder()
  • func (id *ID) String() string
  • func (id *ID) ToInt64() (result int64)

Examples

• Parse

Constants

const (
	// LedgerMask is the bitmask to mask out ledger sequences in a
	// TotalOrderID
	LedgerMask = (1 << 32) - 1
	// TransactionMask is the bitmask to mask out transaction indexes
	TransactionMask = (1 << 20) - 1
	// OperationMask is the bitmask to mask out operation indexes
	OperationMask = (1 << 12) - 1

	// LedgerShift is the number of bits to shift an int64 to target the
	// ledger component
	LedgerShift = 32
	// TransactionShift is the number of bits to shift an int64 to
	// target the transaction component
	TransactionShift = 12
	// OperationShift is the number of bits to shift an int64 to target
	// the operation component
	OperationShift = 0
)

Types

type ID

type ID struct {
	LedgerSequence   int32
	TransactionOrder int32
	OperationOrder   int32
}

ID represents the total order of Ledgers, Transactions and Operations.

Operations within the stellar network have a total order, expressed by three pieces of information: the ledger sequence the operation was validated in, the order which the operation's containing transaction was applied in that ledger, and the index of the operation within that parent transaction.

We express this order by packing those three pieces of information into a single signed 64-bit number (we used a signed number for SQL compatibility).

The follow diagram shows this format:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                    Ledger Sequence Number                     |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|     Transaction Application Order     |       Op Index        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

By component:

Ledger Sequence: 32-bits

A complete ledger sequence number in which the operation was validated.

Expressed in network byte order.

Transaction Application Order: 20-bits

The order that the transaction was applied within the ledger it was
validated.  Accommodates up to 1,048,575 transactions in a single ledger.

Expressed in network byte order.

Operation Index: 12-bits

The index of the operation within its parent transaction. Accommodates up
to 4095 operations per transaction.

Expressed in network byte order.

Note: API Clients should not be interpreting this value. We will use it as an opaque paging token that clients can parrot back to us after having read it within a resource to page from the represented position in time.

Note: This does not uniquely identify an object. Given a ledger, it will share its id with its first transaction and the first operation of that transaction as well. Given that this ID is only meant for ordering within a single type of object, the sharing of ids across object types seems acceptable.

func AfterLedger

func AfterLedger(seq int32) *ID

AfterLedger returns a new toid that represents the ledger time _after_ any contents (e.g. transactions, operations) that occur within the specified ledger.

func New

func New(ledger int32, tx int32, op int32) *ID

New creates a new total order ID

func Parse

func Parse(id int64) (result ID)

Parse parses an int64 into a TotalOrderID struct

Example

toid := Parse(12884910080)
fmt.Printf("ledger:%d, tx:%d, op:%d", toid.LedgerSequence, toid.TransactionOrder, toid.OperationOrder)

Output:

ledger:3, tx:2, op:0

func (*ID) IncOperationOrder

func (id *ID) IncOperationOrder()

IncOperationOrder increments the operation order, rolling over to the next ledger if overflow occurs. This allows queries to easily advance a cursor to the next operation.

func (*ID) String

func (id *ID) String() string

String returns a string representation of this id

func (*ID) ToInt64

func (id *ID) ToInt64() (result int64)

ToInt64 converts this struct back into an int64