Class GameFiBase`Abstract`

GameFiBase is a parent for every implementation of GameFi. Game engine specific implementations like Phaser only needs to define its own create and createConnectButton methods.

Hierarchy (view full)

GameFiBase

Constructors

constructor

new GameFiBase(params): GameFiBase
Parameters
- params: GameFiConstructorParams
Returns GameFiBase
- Defined in packages/common/game-fi.ts:102

Properties

`Readonly` assetsSdk

assetsSdk: AssetsSDK

`Optional` `Readonly` merchant

merchant?: Merchant

`Readonly` sender

sender: Sender

`Readonly` walletConnector

walletConnector: TonConnectUI

Accessors

merchantAddress

get merchantAddress(): Address
Returns Address
- Defined in packages/common/game-fi.ts:131

merchantJettonAddress

get merchantJettonAddress(): Address
Returns Address
- Defined in packages/common/game-fi.ts:141

Methods

buyWithJetton

buyWithJetton(params): Promise<void>
Send jetton to merchant wallet address (in-game shop).
Parameters
- params: Omit<JettonTransferRequest, "to" | "jetton">
Returns Promise<void>
- Defined in packages/common/game-fi.ts:176

buyWithTon

buyWithTon(params): Promise<void>
Send TON to merchant wallet address (in-game shop).
Parameters
- params: Omit<TonTransferRequest, "to">
Returns Promise<void>
- Defined in packages/common/game-fi.ts:154

connectWallet

connectWallet(app): Promise<void>
Call connectWallet programmatically in case you are not going to use TonConnectUI provided UI or game engine provided button and you draw your own UI.
Parameters
- app: WalletApp
Returns Promise<void>
- Defined in packages/common/game-fi.ts:268

`Private` createMessagePayload

createMessagePayload(message): Cell
Parameters
- message: string
Returns Cell
- Defined in packages/common/game-fi.ts:298

disconnectWallet

disconnectWallet(): Promise<void>
Call connectWallet programmatically in case you draw your own UI.

Returns Promise<void>
- Defined in packages/common/game-fi.ts:294

onWalletChange

onWalletChange(...params): (() => void)
Watch weather wallet was connected or disconnected. Use the method to reflect it on the UI state.
Parameters
- Rest ...params: [callback: ((wallet) => void), errorsHandler?: ((err) => void)]
Returns (() => void)
- - (): void
  - Returns void
- Defined in packages/common/game-fi.ts:276

openJetton

openJetton(address): OpenedContract<JettonMinter>
Open Jetton contract.
Parameters
- address: Address
Returns OpenedContract<JettonMinter>
- Defined in packages/common/game-fi.ts:252

openJettonWallet

openJettonWallet(address): OpenedContract<JettonWallet>
Open Jetton Wallet contract.
Parameters
- address: Address
Returns OpenedContract<JettonWallet>
- Defined in packages/common/game-fi.ts:259

openNftCollection

openNftCollection(address): OpenedContract<NftCollection>
Open NFT collection contract.
Parameters
- address: Address
Returns OpenedContract<NftCollection>
- Defined in packages/common/game-fi.ts:213

openNftItem

openNftItem(address): OpenedContract<NftItem>
Open NFT contract.
Parameters
- address: Address
Returns OpenedContract<NftItem>
- Defined in packages/common/game-fi.ts:227

openNftItemByIndex

openNftItemByIndex(collectionAddress, itemIndex): Promise<OpenedContract<NftItem>>
Get NFT item from collection using its index.
Parameters
- collectionAddress: Address
- itemIndex: bigint
Returns Promise<OpenedContract<NftItem>>
- Defined in packages/common/game-fi.ts:234

openNftSale

openNftSale(address): OpenedContract<NftSale>
Open NFT sale contract.
Parameters
- address: Address
Returns OpenedContract<NftSale>
- Defined in packages/common/game-fi.ts:220

openSbtCollection

openSbtCollection(address): OpenedContract<SbtCollection>
Open SBT collection contract.
Parameters
- address: Address
Returns OpenedContract<SbtCollection>
- Defined in packages/common/game-fi.ts:245

transferJetton

transferJetton(params): Promise<void>
Send jetton to other wallet address.
Parameters
- params: Omit<JettonTransferRequest, "jetton">
Returns Promise<void>
- Defined in packages/common/game-fi.ts:183

transferTon

transferTon(params): Promise<void>
Send TON to other wallet address.
Parameters
- params: TonTransferRequest
Returns Promise<void>
- Defined in packages/common/game-fi.ts:161

`Static` `Protected` addressToObject

addressToObject(address): Address
Parameters
- address: string | Address
Returns Address
- Defined in packages/common/game-fi.ts:373

`Static` `Protected` createConnectUiWorkaround

createConnectUiWorkaround(params?): TonConnectUI
Parameters
- params: WalletConnectorParams = {}
Returns TonConnectUI
- Defined in packages/common/game-fi.ts:389

`Static` `Protected` createDependencies

createDependencies(params?): Promise<GameFiConstructorParams>
Prepares dependencies to game engine implementations use it for create method. These dependencies will be used to create an GameFi instance further.
Parameters
- params: GameFiInitializationParams = {}
Returns Promise<GameFiConstructorParams>
- Defined in packages/common/game-fi.ts:306

`Static` `Protected` isTonConnectUiInstance

isTonConnectUiInstance(instance): instance is TonConnectUI
Parameters
- instance: unknown
Returns instance is TonConnectUI
- Defined in packages/common/game-fi.ts:381

Class GameFiBaseAbstract

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: GameFiConstructorParams

Returns GameFiBase

Properties

Readonly assetsSdk

Optional Readonly merchant

Readonly sender

Readonly walletConnector

Accessors

merchantAddress

Returns Address

merchantJettonAddress

Returns Address

wallet

Returns Wallet

walletAccount

Returns Account

walletAddress

Returns Address

Methods

buyWithJetton

Parameters

params: Omit<JettonTransferRequest, "to" | "jetton">

Returns Promise<void>

buyWithTon

Parameters

params: Omit<TonTransferRequest, "to">

Returns Promise<void>

connectWallet

Parameters

app: WalletApp

Returns Promise<void>

Private createMessagePayload

Parameters

message: string

Returns Cell

disconnectWallet

Returns Promise<void>

onWalletChange

Parameters

Rest ...params: [callback: ((wallet) => void), errorsHandler?: ((err) => void)]

Returns (() => void)

Returns void

openJetton

Parameters

address: Address

Returns OpenedContract<JettonMinter>

openJettonWallet

Parameters

address: Address

Returns OpenedContract<JettonWallet>

openNftCollection

Parameters

address: Address

Returns OpenedContract<NftCollection>

openNftItem

Parameters

address: Address

Returns OpenedContract<NftItem>

openNftItemByIndex

Parameters

collectionAddress: Address

itemIndex: bigint

Returns Promise<OpenedContract<NftItem>>

openNftSale

Parameters

address: Address

Returns OpenedContract<NftSale>

openSbtCollection

Parameters

address: Address

Class GameFiBase`Abstract`

`Readonly` assetsSdk

`Optional` `Readonly` merchant

`Readonly` sender

`Readonly` walletConnector

`Private` createMessagePayload

`Rest` ...params: [callback: ((wallet) => void), errorsHandler?: ((err) => void)]

`Static` `Protected` addressToObject

`Static` `Protected` createConnectUiWorkaround

`Static` `Protected` createDependencies

`Static` `Protected` isTonConnectUiInstance