mintbase / mintbase-js

Powerful open-source library for doing all things NFTs on the NEAR protocol.

Mintbase JS

A library for making web3 end to end development as easy as possible from smart contract deployment and interaction to metadata storage and blockchain data access. Check our Templates repository for Mintbase.js

Start with a template

Check our Templates website, to bootstrap your dapp with mintbase.js with any of the currently 11 templates;

• AI Chat, AI Minter, Blogchain, Contract Deployer, Minter, Minsta, Marketplace, NFT Stripe Checkout, Next Wallet Starter, Wallet Starter Vite, Token Drop

Status

@mintbase-js/auth:      
@mintbase-js/data:      
@mintbase-js/react:     
@mintbase-js/rpc:        
@mintbase-js/sdk:        
@mintbase-js/storage:
@mintbase-js/wallet:

{% hint style="danger" %}

All packages are currently in beta.

Breaking changes can and will be introduced on a regular basis until an official release later this year.

{% endhint %}

Getting started

For guides and specific use case examples visit our General Documentation

Specific Module Documentation

@mintbase-js/wallet docs

• the mintbase wallet js sdk.

@mintbase-js/sdk docs

• Deploy or interact with smart contracts and mintbase market

@mintbase-js/react docs

• Add and manage wallet connection on your react dapp out of the box

@mintbase-js/data docs

• Get blockchain data in a few lines of code

@mintbase-js/storage docs

• Upload metadata to permanent storage

@mintbase-js/auth docs

• near-api-js convenience wrappers for loading accounts and managing keys
• Message singing and verification utils.

Join us in Building the Future

Have feedback or perhaps need a hand?

Reach out on our Telegram public developer support channel.

Building something cool?

Consider applying for a grant.

mintbase-js's Issues

Improve test coverage

How should we approach testing to improve our test coverage on Mintbase.js?

test issue

Rate limit through NFT ownership

• Map user wallet to NFT token
• Generate an API key (may need to be updated)
• For every request, check if API key -> NFT -> user (dev) wallet

Compile list of queries that need updating

Google doc with links to code in github to locations to update queries

Doc: https://docs.google.com/spreadsheets/d/1fBVLuhDBeztbJI5pqZ_VEIwxZrzD28Dpuiuor4Ezzzw/edit#gid=0

Developer telegram link in doc navigates me here

Plz check and update the telegram link on https://docs.mintbase.io/dev/mintbasejs, thanks!

(Mintbase-JS) Fix low hanging console errors and warnings

Create a general Mintbase class

• Re-org classes
• Create Mintbase class. That will be init'd with external constants.
• Instantiate wallet, api, minter, and any other module through this general class.

The goal of this is to allow using the different modules of Mintbase independently.

Re-write GraphQL queries as REST endpoints on Hasura

This will allow us to change queries on the fly.

Create types for request's payload

[Mintbase-JS] Update mintbase.js login method to accept URL redirects

near-api-js allows the specification of success and failure URLs.

This will be useful not just for mintbase.js users, but for the marketplace login/auth flow refactoring

Implement Multiple Call Transactions

Allow batch/multi transactions to multiple contracts.

See Storage Staking

Add tests

Support QR code / Deeplink

Mintbase JS Refactoring Design

A plan for implementations of specific user use cases.

As a mintbase platform developer I want to ______ so that I can ______

https://docs.google.com/document/d/1SA9Pt5_CKe8Im5IkharpvLyTBBjNF_1grwkTB-1dDKI/edit#heading=h.pz2xgamr4nqp

Add standalone minting method

This supports a future looking POC.

Looking to bypass the arweave.net upload workflow to enable use of simple/small SVGs media on-chain.

• Add Wallet.mint_simple_nft method which bypasses the arweave requirements.

Update docs

Some API methods return an array

Assure fetch by id, returns a unique result and not an array.

test123

Test new issue

just a test

Merge batch and non-batch methods

Let's simplify the API by reducing the amount of methods that can for example list tokens in the marketplace to one. Similarly to how transfer works.

Create endpoint for offers

• Create endpoint for offers on mainnet and testnet
• Integrate on API

Update Metadata fields

Update Medatada fields to match NEAR standards.

Sign messages

MintbaseJS Update API to support interop market actions

Support for batch calls have been done.
List - wrap batch deposit + approve

Note: create task for Buy next sprint

Mint method doesn't execute.

I bootstrapped my project from Mintbase Boilerplate and Starter for Next JS 12+, Tailwind CSS 3, and TypeScript.

The application successfully connects to a near wallet when the connect method is invoked, but when I call the
wallet.mint() nothing happens.

I implemented it in a previous version of the application and it worked but it doesn't seem to work on this recent project I'm working on.

What could be the issue?

Folder re-org

Move tests related files to /utils folder

Files: mocks.ts and setupTest.ts

fix fetchMarketplace response

data obj is inside another data obj property.

should be on top level

Things to add

• Util to extract token id from token key ("1:<contract_address>" => 1)

Arweave upload cloud function

This will allow to finish minting through mintbase.js

check omni-site components/Uploader.tsx to see how uploads are done

Fix queries

• Fetch marketplace
• Fetch token metadata
• Fetch lists
• Fetch store
• Fetch thing
• Fetch token
• Fetch metadata
• Fetch owner tokens
• Fetch isOwner

Remove /examples folder and update create-mintbase-app

• Use create-mintbase-app for examples.
• Update https://github.com/Mintbase/create-mintbase-app to the current API

Fix storage calcs

• Remove 0.1 N fixed cost for list
• Create calc for transfer
• Create calc mint

Work is under storage-calc

Thor's explanation:

These are storage costs. Multiply them by 10^19 to get cost in Near.
Eg: if the cost is 440 bytes, it's 4.4 * 10^21 yoctoNear = 0.0044Near.

Mint:

First, you don't actually have to pay the whole cost at each mint. You DO have to pay ONE_YOCTO for a mint, but anything beyond that is unnecessary if you've already deposited enough onto the contract. This is because minting tokens is friggin complicated when in comes to gas costs, and only minters can call mint_tokens in any case.

This one's the most complicated. The size of the metadata AND the size of the royalty AND the size of the split owners can vary.

These costs are paid once, not per token:
100 bytes to create a record that the owner owns a new set of tokens
100 bytes or less, (usually! This can be as large as you want to make it in fact)
80 bytes for each royalty address.

These costs are paid for each token
80 bytes for each split address
360 bytes for the token

Supposing we mint N tokens with S splits, R royalties; this will fail if metadata is larger than expected:
100 + 100 + 80R + N(360 + 80S)
= 200 + 80R + N*(360 + 80*S)

Approve (list):

Here, the complexity is that we have to accomodate the storage costs on both the Store and the Market.

Store:
80 bytes per approval

Market:
360 bytes per list

So 440 bytes per token approved.
=440*N

Transfer:

one yoctoⓝ

Reduce Store deployer cost to 6N

Improve error handling

Instead of throwing errors, return an object { data: any, error?: string }, for example.

Implementation should follow apollo lib design.

Update Queries on non-omni-site properties

MintbaseJS (only one query)
Examples (migrate queries to new schema)
Hasura REST API endpoints - could use auditing. Who is using this?

Add ability to unlist an NFT to compliment listing one for sale

At the moment, it appears that once an NFT is listed for sale via wallet.list() it isn't possible to cancel that operation.

Would it be possible to add a wallet.unlist() function? Assumption is needs complementary contract logic so not a quick fix?

Store page throws an error, because of invalid payload in response

We minted programmatically an NFT (probably we did it in a different way or missed something) and it broke Mintbase UI:

https://testnet.mintbase.io/store/cryptokids.mintspace2.testnet
Returns «An unexpected error has occurred.»

{ "id": "q5LiLpH0QNJ2PojWl4lmUZ3zSss8hbtz--iBLCk5T_g:cryptokids.mintspace2.testnet", "metaId": "q5LiLpH0QNJ2PojWl4lmUZ3zSss8hbtz--iBLCk5T_g", "storeId": "cryptokids.mintspace2.testnet", "store": { "id": "cryptokids.mintspace2.testnet", "name": "cryptokids", "symbol": "crk", "owner": "deus.testnet", "__typename": "stores" }, "tokens": [], "__typename": "things" }

Steps to reproduce:

• mint using mintbase-js from another app without specifying price and royalties
• open your store page

Expected behavior
If the response contains an empty array of tokens, the app should handle it correctly and render the store page.

Rate limit through api key

I have limited anonymous role to 100 req./min.

• https://hasura.io/docs/latest/graphql/cloud/api-limits.html

TODO: Need to find a solution to generate and distribute an API key to developers.

Fix actions npm publish

Handle error "Exceed requests"

Finish Node.js support

As started here: #106

We should spend some time to finish the implementation.

Mintbase JS - new repo auth/core module, start with low level transaction APIs

• Auth via popup (selector would be ideal, but also just supporting sender is easy https://docs.senderwallet.io/guide/sign-in-applications
• Batch/low level direct contract method calls to start, wrap the near object on window https://docs.senderwallet.io/guide/sending-transactions

uploadFileToArweave does not work with Buffer

I'm uploading metadata to form as the reference for a mint. For example:

const metadata = Buffer.from(JSON.stringify({
    extra: "sample"
  }));
const response = await uploadFileToArweave(metadata, "sample-name");
const url = `https://arweave.net/${response.id}`;

If I run this, I will get the following exception, which is misleading because the actual exception being thrown does not work with httpError.response.text:

Cannot read properties of undefined (reading 'text')

The actual exception is:

Failed to execute 'append' on 'FormData': parameter 2 is not of type 'Blob'.

I think somebody just needs to wrap the buffer in "new Blob([buffer])". Wasn't caught because append function is mocked in test.

Optimize gas usage

• Dynamically calculate gas usage for every call
• Create a helper method for this

Add comments + generate docs

Add util method to calculate storage needed

• Mint more
• List 

Update mintbase.js to latest near-api-js version

TypeError: Cannot read property '0' of undefined

mintbase-js/src/api.ts

Line 143 in 4a5906f

const thing = result.token[0]

Should be result.thing.tokens[0]

Fix dist bundle

Alts:

• https://github.com/vitejs/vite