Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TonApi lib for TypeScript #327

Closed
deivana opened this issue Oct 7, 2023 · 15 comments
Closed

TonApi lib for TypeScript #327

deivana opened this issue Oct 7, 2023 · 15 comments
Assignees
Labels
Approved This proposal is approved by the committee Closing Soon as Not planning Proposal awaiting a response and automatically closes after 2 weeks of inactivity. Developer Tool Related to tools or utilities used by developers

Comments

@deivana
Copy link

deivana commented Oct 7, 2023

Summary

Library for typescript for Tonapi with descriptions of all types

Context

The library will make it possible to use different versions of tonapi with testnet and mainnet and with key support

the tonapi library will be a tonapi class for typescript

When creating an instance of the class, you can specify the network and version of the tonepi, as well as the token

The following tonapi methods will be described and divided into subclasses

Blockchain

  • /v2/blockchain/blocks/{block_id}
  • /v2/blockchain/blocks/{block_id}/transactions
  • /v2/blockchain/transactions/{transaction_id}
  • /v2/blockchain/messages/{msg_id}/transaction
  • /v2/blockchain/validators
  • /v2/blockchain/masterchain-head
  • /v2/blockchain/accounts/{account_id}
  • /v2/blockchain/accounts/{account_id}/transactions
  • /v2/blockchain/accounts/{account_id}/methods/{method_name}
  • /v2/blockchain/message
  • /v2/blockchain/config
  • /v2/blockchain/accounts/{account_id}/inspect

Emulation

  • /v2/events/emulate
  • /v2/traces/emulate
  • /v2/wallet/emulate
  • /v2/accounts/{account_id}/events/emulate

Accounts

  • /v2/accounts/_bulk
  • /v2/accounts/{account_id}
  • /v2/accounts/{account_id}/dns/backresolve
  • /v2/accounts/{account_id}/jettons
  • /v2/accounts/{account_id}/jettons/history
  • /v2/accounts/{account_id}/jettons/{jetton_id}/history
  • /v2/accounts/{account_id}/nfts
  • /v2/accounts/{account_id}/events
  • /v2/accounts/{account_id}/events/{event_id}
  • /v2/accounts/{account_id}/traces
  • /v2/accounts/{account_id}/subscriptions
  • /v2/accounts/{account_id}/reindex
  • /v2/accounts/search
  • /v2/accounts/{account_id}/dns/expiring
  • /v2/accounts/{account_id}/publickey
  • /v2/accounts/{account_id}/diff

NFT

  • /v2/accounts/{account_id}/nfts/history
  • /v2/nfts/collections
  • /v2/nfts/collections/{account_id}
  • /v2/nfts/collections/{account_id}/items
  • /v2/nfts/_bulk
  • /v2/nfts/{account_id}
  • /v2/nfts/{account_id}/history

DNS

  • /v2/nfts/{account_id}/history
  • /v2/dns/{domain_name}/resolve
  • /v2/dns/{domain_name}/bids
  • /v2/dns/auctions

Traces

  • /v2/traces/{trace_id}

Events

  • /v2/events/{event_id}

Jettons

  • /v2/jettons
  • /v2/jettons/{account_id}
  • /v2/jettons/{account_id}/holders
  • /v2/events/{event_id}/jettons

Staking

  • /v2/staking/nominator/{account_id}/pools
  • /v2/staking/pool/{account_id}
  • /v2/staking/pool/{account_id}/history
  • /v2/staking/pools

Storage

  • /v2/storage/providers

Rates

  • /v2/rates
  • /v2/rates/chart

Connect

  • /v2/tonconnect/payload
  • /v2/tonconnect/payload

Wallet

  • /v2/wallet/backup
  • /v2/wallet/auth/proof
  • /v2/pubkeys/{public_key}/wallets
  • /v2/wallet/{account_id}/seqno

Lite Server

  • /v2/liteserver/get_masterchain_info
  • /v2/liteserver/get_masterchain_info_ext
  • /v2/liteserver/get_time
  • /v2/liteserver/get_block/{block_id}
  • /v2/liteserver/get_state/{block_id}
  • /v2/liteserver/get_block_header/{block_id}
  • /v2/liteserver/send_message
  • /v2/liteserver/get_account_state/{account_id}
  • /v2/liteserver/get_shard_info/{block_id}
  • /v2/liteserver/get_all_shards_info/{block_id}
  • /v2/liteserver/get_transactions/{account_id}
  • /v2/liteserver/list_block_transactions/{block_id}
  • /v2/liteserver/get_block_proof
  • /v2/liteserver/get_config_all/{block_id}
  • /v2/liteserver/get_shard_block_proof/{block_id}

The following typification of objects will be described

  • Error
  • AccountAddress
  • BlockchainBlock
  • AccountStatus
  • StateInit
  • Message
  • TransactionType
  • AccStatusChange
  • ComputeSkipReason
  • BouncePhaseType
  • ComputePhase
  • StoragePhase
  • CreditPhase
  • ActionPhase
  • Transaction
  • Transactions
  • ValidatorsSet
  • Validator
  • Validators
  • AccountStorageInfo
  • BlockchainRawAccount
  • Account
  • Accounts
  • MethodExecutionResult
  • TvmStackRecord
  • BlockchainConfig
  • DomainNames
  • DomainBid
  • DomainBids
  • JettonVerificationType
  • JettonPreview
  • JettonBalance
  • JettonsBalances
  • Price
  • ImagePreview
  • Sale
  • NftItem
  • NftItems
  • Refund
  • ValueFlow
  • Action
  • TonTransferAction
  • SmartContractAction
  • NftItemTransferAction
  • JettonTransferAction
  • JettonBurnAction
  • JettonMintAction
  • ContractDeployAction
  • SubscriptionAction
  • UnSubscriptionAction
  • AuctionBidAction
  • DepositStakeAction
  • WithdrawStakeAction
  • WithdrawStakeRequestAction
  • ElectionsRecoverStakeAction
  • ElectionsDepositStakeAction
  • JettonSwapAction
  • NftPurchaseAction
  • ActionSimplePreview
  • AccountEvent
  • AccountEvents
  • TraceID
  • TraceIDs
  • ApyHistory
  • Subscription
  • Subscriptions
  • Auction
  • Auctions
  • WalletDNS
  • DomainInfo
  • DnsRecord
  • NftCollection
  • NftCollections
  • Trace
  • MessageConsequences
  • Risk
  • JettonQuantity
  • Event
  • JettonMetadata
  • Jettons
  • JettonInfo
  • JettonHolders
  • AccountStaking
  • AccountStakingInfo
  • PoolInfo
  • PoolImplementation
  • StorageProvider
  • FoundAccounts
  • DnsExpiring
  • AccountInfoByStateInit
  • Seqno
  • BlockRaw
  • InitStateRaw
  • EncryptedComment
  • BlockchainAccountInspect
  • PoolImplementationType

References

tonapi

Estimate suggested reward

$500 in TON

@pyAndr3w
Copy link

pyAndr3w commented Oct 7, 2023

@delovoyhomie
Copy link
Collaborator

https://github.com/ton-community/nft-sdk/blob/main/src/ton-api/TonAPI.ts

@deivana, could you please take a moment to review and share your thoughts on how closely the implemented product aligns with your initial idea?

@deivana
Copy link
Author

deivana commented Oct 13, 2023

@delovoyhomie what is presented there is not even 10% of the capabilities of the tone API - I offer a full-fledged library with typing for a typescript with all tonApi methods

@delovoyhomie
Copy link
Collaborator

@deivana, please describe all the features of the library you offer. And also add a lot more context of your idea, because now it's not clear to me how the ready-made /TonAPI.ts library differs.

@deivana
Copy link
Author

deivana commented Oct 16, 2023

@delovoyhomie I updated the description, please compare the proposed code above that there are only 5 methods and see how many methods I am going to release

@delovoyhomie delovoyhomie added Approved This proposal is approved by the committee Developer Tool Related to tools or utilities used by developers labels Oct 18, 2023
@deivana
Copy link
Author

deivana commented Oct 29, 2023

@deivana
Copy link
Author

deivana commented Nov 10, 2023

all is ready

@mbaneshi
Copy link
Contributor

I am eager and ready to help

@deivana
Copy link
Author

deivana commented Nov 10, 2023

@mbaneshi how do you want to help?

@mbaneshi
Copy link
Contributor

Dear @deivana

Documentation, Review, Summarization, or any possible room for improvement.
I am busy with learning community development staff, so why not?
"Kill two birds with one stone."

@deivana
Copy link
Author

deivana commented Nov 15, 2023

@delovoyhomie Waiting for a response

@delovoyhomie
Copy link
Collaborator

@deivana, please update the status of your completed work in the issue using checkboxes.

@deivana
Copy link
Author

deivana commented Nov 17, 2023

@delovoyhomie done!

@hitaspdotnet
Copy link

@deivana please update ton's dependencies these are deprecated. please use @ton packages
@ton/ton @ton/crypto @ton/core ...

@delovoyhomie delovoyhomie added the Closing Soon as Not planning Proposal awaiting a response and automatically closes after 2 weeks of inactivity. label Jan 12, 2024
@delovoyhomie
Copy link
Collaborator

This issue has been automatically closed due to 14 days of inactivity and lack of the additional information requested.
Please feel free to reopen it if you wish to provide further details or require assistance.

@delovoyhomie delovoyhomie reopened this Jan 20, 2024
@delovoyhomie delovoyhomie closed this as not planned Won't fix, can't repro, duplicate, stale Jan 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved This proposal is approved by the committee Closing Soon as Not planning Proposal awaiting a response and automatically closes after 2 weeks of inactivity. Developer Tool Related to tools or utilities used by developers
Projects
None yet
Development

No branches or pull requests

5 participants