Class GameFi

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
- GameFi

Constructors

constructor

new GameFi(params): GameFi
Parameters
- params: GameFiConstructorParams
Returns GameFi
Inherited from GameFiBase.constructor
- 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
Inherited from GameFiBase.merchantAddress
- Defined in packages/common/game-fi.ts:131

merchantJettonAddress

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

wallet

get wallet(): Wallet
Returns Wallet
Inherited from GameFiBase.wallet
- Defined in packages/common/game-fi.ts:115

walletAccount

get walletAccount(): Account
Returns Account
Inherited from GameFiBase.walletAccount
- Defined in packages/common/game-fi.ts:123

walletAddress

get walletAddress(): Address
Returns Address
Inherited from GameFiBase.walletAddress
- Defined in packages/common/game-fi.ts:127

Methods

buyWithJetton

buyWithJetton(params): Promise<void>
Send jetton to merchant wallet address (in-game shop).
Parameters
- params: Omit<JettonTransferRequest, "to" | "jetton">
Returns Promise<void>
Inherited from GameFiBase.buyWithJetton
- 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>
Inherited from GameFiBase.buyWithTon
- 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>
Inherited from GameFiBase.connectWallet
- Defined in packages/common/game-fi.ts:268

createConnectButton

createConnectButton(params): ConnectWalletButton
Creates the connect button as ConnectWalletButton instance and adds it to the passed scene. ConnectWalletButton is child class of Phaser.GameObjects.Container. It's possible to interact with the button using Container API, like changing position setPosition.
Parameters
- params: CreateConnectButtonParams
Returns ConnectWalletButton
- Defined in packages/phaser/src/game-fi.ts:26

disconnectWallet

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

Returns Promise<void>
Inherited from GameFiBase.disconnectWallet
- 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
Inherited from GameFiBase.onWalletChange
- Defined in packages/common/game-fi.ts:276

openJetton

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

openJettonWallet

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

openNftCollection

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

openNftItem

openNftItem(address): OpenedContract<NftItem>
Open NFT contract.
Parameters
- address: Address
Returns OpenedContract<NftItem>
Inherited from GameFiBase.openNftItem
- 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>>
Inherited from GameFiBase.openNftItemByIndex
- Defined in packages/common/game-fi.ts:234

openNftSale

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

openSbtCollection

openSbtCollection(address): OpenedContract<SbtCollection>
Open SBT collection contract.
Parameters
- address: Address
Returns OpenedContract<SbtCollection>
Inherited from GameFiBase.openSbtCollection
- 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>
Inherited from GameFiBase.transferJetton
- 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>
Inherited from GameFiBase.transferTon
- Defined in packages/common/game-fi.ts:161

`Static` `Protected` addressToObject

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

`Static` create

create(params?): Promise<GameFi>
Setups and creates GameFi instance. The instance provides all the needed functionality via various methods.
Parameters
- params: GameFiInitializationParams = {}
Returns Promise<GameFi>
- Defined in packages/phaser/src/game-fi.ts:17

`Static` `Protected` createConnectUiWorkaround

createConnectUiWorkaround(params?): TonConnectUI
Parameters
- params: WalletConnectorParams = {}
Returns TonConnectUI
Inherited from GameFiBase.createConnectUiWorkaround
- 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>
Inherited from GameFiBase.createDependencies
- Defined in packages/common/game-fi.ts:306

`Static` `Protected` isTonConnectUiInstance

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

Class GameFi

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: GameFiConstructorParams

Returns GameFi

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>

createConnectButton

Parameters

params: CreateConnectButtonParams

Returns ConnectWalletButton

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

`Readonly` assetsSdk

`Optional` `Readonly` merchant

`Readonly` sender

`Readonly` walletConnector

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

`Static` `Protected` addressToObject

`Static` create

`Static` `Protected` createConnectUiWorkaround

`Static` `Protected` createDependencies

`Static` `Protected` isTonConnectUiInstance