@mintbase-js/sdk - npm Package Compare versions

Comparing version 0.0.4-rc21 to 0.0.4-rc22

lib/execute.d.ts

 import type { Wallet, FinalExecutionOutcome } from '@near-wallet-selector/core';
 import type { providers, Account } from 'near-api-js';
-export declare type TransactionArgs = {
+export type TransactionArgs = {
     contractAddress: string;
@@ -8,11 +8,11 @@ methodName: string;
 };
-export declare type TransactionAttachments = {
+export type TransactionAttachments = {
     gas: string;
     deposit: string;
 };
-export declare type NearContractCall = TransactionArgs & TransactionAttachments & {
+export type NearContractCall = TransactionArgs & TransactionAttachments & {
     signerId?: string;
     callbackUrl?: string;
 };
-export declare type NearCallSigningOptions = {
+export type NearCallSigningOptions = {
     wallet?: Wallet;
@@ -19,0 +19,0 @@ account?: Account;

lib/index.d.ts

@@ -10,1 +10,2 @@ export * from './execute';
 export { InMemoryKeyStore, KeyStore } from 'near-api-js/lib/key_stores';
+export { FinalExecutionOutcome } from '@near-wallet-selector/core';

lib/v1/market.types.d.ts

 import { AccountId, ApproveArgs, TokenArgs, TokenId } from './token.types';
-export declare type PriceArgs = {
+export type PriceArgs = {
     price: {
@@ -8,4 +8,4 @@ amount: string;
 };
-export declare type ListArgs = TokenArgs & ApproveArgs & PriceArgs;
-export declare type BuyArgs = TokenArgs & PriceArgs & {
+export type ListArgs = TokenArgs & ApproveArgs & PriceArgs;
+export type BuyArgs = TokenArgs & PriceArgs & {
     nftContractId: AccountId;
@@ -16,5 +16,5 @@ tokenId: TokenId;
 };
-export declare type DepositStorageArgs = {
+export type DepositStorageArgs = {
     listAmount: number;
     marketAddress: AccountId;
 };

lib/v1/token.types.d.ts

@@ -1,7 +0,7 @@
-export declare type AccountId = string;
-export declare type TokenId = string;
-export declare type TokenArgs = {
+export type AccountId = string;
+export type TokenId = string;
+export type TokenArgs = {
     network?: string;
 };
-export declare type TransferArgs = TokenArgs & {
+export type TransferArgs = TokenArgs & {
     nftContractId: AccountId;
@@ -13,7 +13,7 @@ transfers: {
 };
-export declare type BurnArgs = {
+export type BurnArgs = {
     nftContractId: AccountId;
     tokenIds: TokenId[];
 };
-export declare type DeployTokenContractArgs = TokenArgs & {
+export type DeployTokenContractArgs = TokenArgs & {
     name: string;
@@ -30,3 +30,3 @@ factoryContractId?: AccountId;
 };
-export declare type TransferTokenContractOwnership = TokenArgs & {
+export type TransferTokenContractOwnership = TokenArgs & {
     nftContractId: AccountId;
@@ -38,4 +38,4 @@ nextOwner: AccountId;
 };
-export declare type Splits = Record<AccountId, number>;
-export declare type MintArgs = TokenArgs & {
+export type Splits = Record<AccountId, number>;
+export type MintArgs = TokenArgs & {
     nftContractId: AccountId;
@@ -55,7 +55,7 @@ metadata: {
 };
-export declare type AddRemoveMinterArgs = TokenArgs & {
+export type AddRemoveMinterArgs = TokenArgs & {
     minterId: AccountId;
     nftContractId: AccountId;
 };
-export declare type BatchChangeMinters = TokenArgs & {
+export type BatchChangeMinters = TokenArgs & {
     addMinters: AccountId[];
@@ -65,3 +65,3 @@ removeMinters: AccountId[];
 };
-export declare type RevokeAccountArgs = TokenArgs & {
+export type RevokeAccountArgs = TokenArgs & {
     nftContractId: AccountId;
@@ -71,3 +71,3 @@ tokenId: TokenId;
 };
-export declare type ApproveArgs = TokenArgs & {
+export type ApproveArgs = TokenArgs & {
     tokenId: TokenId;
@@ -74,0 +74,0 @@ nftContractId: AccountId;

package.json

 {
   "name": "@mintbase-js/sdk",
-  "version": "0.0.4-rc21",
+  "version": "0.0.4-rc22",
   "description": "Core functions for  Mintbase JS SDK",
@@ -25,3 +25,3 @@ "main": "lib/index.js",
   },
-  "gitHead": "a7baa6d1550a245a4b52a34007a9428e857357a2"
+  "gitHead": "9fd5b879467fbce379431074133e8cff9fb332ea"
 }

README.md

 [//]: # `{ "title": "@mintbase-js/sdk", "order": 0 }`
-# @mintbase-js/sdk
+## SDK Core Javascript Modules
 
-This module provides a set of convenience wrappers around invocation of Mintbase smart contract methods, but also exposes a low-level isomorphic [execute](#execute) method that can be passed raw `NearContractCall` information.
+The core `@mintbase-js/sdk` is a set of convenience wrappers around invocation of Mintbase smart contract methods.
 
-Finish implementations and documentation for:
+It also exposes a low-level isomorphic [execute](#execute) method that can be passed raw `NearContractCall` information.
 
-- [ ] Transfer Token
-- [ ] Buy Token
-- [ ] List Token
-- [ ] Rest of the methods...
+## Calling Smart Contract Methods
 
-Later TODOs:
-- [ ] Analytics via Opt in
-- [ ] Compute NEAR [gas fees](https://github.com/near/near-api-js/blob/master/packages/cookbook/utils/calculate-gas.js) and report consumption analytics
+In order to invoke a smart contract method, the transaction has to be signed using a public/private key pair.
 
-# execute(callOptions, signingOptions)
+There are two options, both provided from the [@mintbase-js/auth](../auth/) module:
 
-`execute` is the Core method used to invoke smart contract methods via browser [wallet](https://github.com/near/wallet-selector) or an authenticated NEAR Account via [functionCall](https://docs.near.org/tools/near-api-js/reference/classes/account.Account#functioncall) method.
+  1. Sign with a browser wallet
+  2. Sign with an authenticated account.
 
+## Using API Methods <div name="api"></div>
+
+The easiest way to call mintbase token and market contracts are with the convenience methods.
+
+Details such as the method name, arguments, gas supplied, deposits and some other less than convenient aspects of blockchain development **will be abstracted away for you**, or at least well documented in each example.
+
+{% hint style="warning" %}
+This is a work in progress, please reach out to us on [Telegram](https://t.me/mintdev) for support.
+{% endhint }
+
+Check back soon for details. Individual methods and documentation will start to be available as we implement in the gitbook documentation menu.
+
+## Using `execute` <div name="execute"></div>
+
+You are always free to use the core execute method without the API methods, which will allow you to specify all options of the contract call.
+
+The method will accept a single `NearContractCall` object or an array of calls and determine how batch based on `NearCallSigningOptions` (browser wallet, or near-api-js Account).
+
+```
+execute(
+  calls: NearContractCall | NearContractCall[],
+  signingOptions: NearCallSigningOptions
+): Promise<void | providers.FinalExecutionOutcome>
+```
+
+Here is an example using the raw function call
+# NearContractCall
+
+The `NearContractCall` type specifies the properties that our contract calls must specify:
+
+{% code title="executeContractMethod.ts" overflow="wrap" lineNumbers="true" %}
+```typescript
+import { execute, MAX_GAS, ONE_YOCTO } from '@mintbase-js/sdk';
+import { getWallet } from '@mintbase-js/auth';
+import type {
+  NearContractCall,
+  NearCallSigningOptions,
+  FinalExecutionOutcome
+} from '@mintbase-js/sdk';
+
+
+const call: NearContractCall = {
+  // the smart contract address for which we will call
+  // most of the time, this will be supplied as an environment variable
+  contractAddress: 'mytokencontract.mintbase1.near',
+
+  // the smart contract method
+  methodName: 'transfer',
+
+  // the arguments supplied to the method
+  args: { receiver_id: 'bob.near', token_id: '123' },
+
+  // how much gas you would like to send
+  // you will be refunded unused gas so MAX_GAS is always a safe bet
+  gas: MAX_GAS,
+
+  // most methods require the min amount of deposit (ONE_YOCTO) to be accepted.
+  // in some cases deposit amount is the amount of currency to be transfer,
+  deposit: ONE_YOCTO,
+}
+
+const makeSmartContractCall = async (): Promise<FinalExecutionOutcome> => {
+
+  // to better understand signing options, read the auth module docs
+  // to use an account directly, you have to implement this method
+  // const account = await authenticateAccount('mynearaccount.near');
+
+  // before the getWallet can be called, you will need to setup the components in the browser, it will throw othwerise
+  const wallet = await getWallet();
+
+  const sign: NearCallSigningOptions = {
+    // account
+    wallet,
+  }
+  return await execute(call, sign);
+}
+
+makeSmartContractCall()
+  .then((res: FinalExecutionOutcome) => console.log('got transaction result:', res))
+  .catch((err) => console.error('things went wrong', err));
+
+```
+{% endcode %}
+
+## Batching Transactions
+
+The reason for the optional `Promise<void>` return type in the execute method, is that batch methods in some [near/wallet-selector] implementations do not return transactions execution outcomes.
+
+## Further
+
+{% hint style="warning" %}
+
+Should you encounter this [known issue](ttps://docs.near.org/tools/near-api-js/faq#class-x-is-missing-in-schema-publickey) make sure you are not importing modules directly from `near-api-js`, import them from `@mintbase-js/sdk` instead to avoid the duplicate import.
+
+{% endhint %}

No alert changes

Improved metrics

Total package byte prevSize

43402

increased by7.95%

Lines of code

613

increased by0.16%

Number of lines in readme file

112

increased by433.33%

No dependency changes