met
metafab
npm i metafab
met

metafab

Complete MetaFab API references and guides can be found at: https://trymetafab.com

by metafab

1.0.1 (see all)License:MITTypeScript:Not Found
npm i metafab
Readme

metafab

Metafab - JavaScript client for metafab Complete MetaFab API references and guides can be found at: https://trymetafab.com This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.1
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://trymetafab.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install metafab --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your metafab from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Metafab = require('metafab');


var api = new Metafab.ContractsApi()
var xAuthorization = game_sk_02z4Mv3c85Ig0gNowY9Dq0N2kjb1xwzr27ArLE0669RrRI6dLf822iPO26K1p1FP; // {String} The `secretKey` of the authenticating game.
var createContractRequest = new Metafab.CreateContractRequest(); // {CreateContractRequest} 
api.createContract(xAuthorization, createContractRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


Documentation for API Endpoints

All URIs are relative to https://api.trymetafab.com

ClassMethodHTTP requestDescription
Metafab.ContractsApicreateContractPOST /v1/contractsCreate custom contract
Metafab.ContractsApigetContractsGET /v1/contractsGet contracts
Metafab.ContractsApireadContractGET /v1/contracts/{contractId}/readsRead contract data
Metafab.ContractsApiwriteContractPOST /v1/contracts/{contractId}/writesWrite contract data
Metafab.CurrenciesApibatchTransferCurrencyPOST /v1/currencies/{currencyId}/batchTransfersBatch transfer currency
Metafab.CurrenciesApiburnCurrencyPOST /v1/currencies/{currencyId}/burnsBurn currency
Metafab.CurrenciesApicreateCurrencyPOST /v1/currenciesCreate currency
Metafab.CurrenciesApigetCurrenciesGET /v1/currenciesGet currencies
Metafab.CurrenciesApigetCurrencyBalancesGET /v1/currencies/{currencyId}/balancesGet currency balance
Metafab.CurrenciesApigetCurrencyFeesGET /v1/currencies/{currencyId}/feesGet currency fees
Metafab.CurrenciesApimintCurrencyPOST /v1/currencies/{currencyId}/mintsMint currency
Metafab.CurrenciesApisetCurrencyFeesPOST /v1/currencies/{currencyId}/feesSet currency fees
Metafab.CurrenciesApitransferCurrencyPOST /v1/currencies/{currencyId}/transfersTransfer currency
Metafab.GamesApiauthGameGET /v1/gamesAuthenticate game
Metafab.GamesApicreateGamePOST /v1/gamesCreate game
Metafab.GamesApiupdateGamePATCH /v1/games/{gameId}Update game
Metafab.PlayersApiauthPlayerGET /v1/playersAuthenticate player
Metafab.PlayersApicreatePlayerPOST /v1/playersCreate player
Metafab.PlayersApiupdatePlayerPATCH /v1/players/{playerId}Update player
Metafab.TransactionsApigetTransactionGET /v1/transactions/{transactionId}Get transaction
Metafab.WalletsApigetWalletBalancesGET /v1/wallets/{walletId}/balancesGet wallet balances
Metafab.WalletsApigetWalletTransactionsGET /v1/wallets/{walletId}/transactionsGet wallet transactions

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication

Downloads/wk

0

GitHub Stars

0
No data available

LAST COMMIT

NaNyrs ago

MAINTAINERS

1

CONTRIBUTORS

0

OPEN ISSUES

0

OPEN PRs

0
No data available
VersionTagPublished
1.0.1
latest
3d ago
No alternatives found
No tutorials found
Add a tutorial

Rate & Review

100
No reviews found
Be the first to rate