Skip to content

Federated inventory

Federated Inventory allows you to integrate with other third-party inventory systems such as Steam's Inventory or Web3 wallets. Because of this intended usage, all FederatedInventory implementations are also Federated Login implementations.

Here is how this works at a high-level:

  • Take a UBeamItemContent or UBeamCurrencyContent whose federation field has a valid Federation Id
  • Whenever the inventory is fetched, if that content object is within its scope, the Beamable backend will invoke the GetInventoryState call with the user's third-party UserId as its parameter
  • Whenever an inventory update is committed, any currencies or items involved that are federated are bundled up and passed into StartInventoryTransaction

Here is some more detail:

  • The id parameter is the UserId that IFederatedLogin.Authenticate generates. GetInventoryState decorates the response with currencies and item instances and forwards it along, nothing more
  • The transaction parameter is an optional string provided by the caller. You are expected to provide an idempotency guarantee that every given transaction string value is only processed once. In most cases, this is a pass-along to Web3 wallets or wherever you are keeping the inventory information. If that is not supported by your third-party, you can use StorageObjects to provide this guarantee

Support in SDK

Support for this federation in the SDK's UBeamInventorySubsystem is coming soon.