Skip to main content

Masa SDK


🌽🌽 THIS IS BETA SOFTWARE. IT COULD LEAD TO RAPID UNSCHEDULED DISASSEMBLY. If you run into problems, please open up a new issue. 🌽🌽


Installation

yarn
yarn add @masa-finance/masa-sdk --save

npm
npm i @masa-finance/masa-sdk --save

Usage

Browser:

import { Masa } from "@masa-finance/masa-sdk";
import { ethers } from "ethers";

// with metamask
const provider = new ethers.providers.Web3Provider(window.ethereum);
const signer = provider.getSigner();

export const masa = new Masa({ wallet: signer });

Node:

import { Masa } from "@masa-finance/masa-sdk";
import { ethers } from "ethers";

const provider = new ethers.providers.JsonRpcProvider(
"your blockchain rpc endpoint"
);

const wallet = new ethers.Wallet("your private key", provider);

export const masa = new Masa({ wallet });

Interface

For a detailed interface description see Masa

Configuration

KeyTypeDescriptionDefault Value
cookiestringCookie value. Don't set this manually unless you know what you do!
walletethers.Signer or ethers.WalletThe Wallet instance to use when interacting with the Blockchain."wallet with a random private key"
apiUrlstringThe API Endpoint of the Masa Infrastructure for dev, test, beta and production."https://dev.middleware.masa.finance/"
environmentstringThe environment to use dev, test, beta, production."dev"
networkstringThe network name ie. "goerli"."goerli"
arweave.hoststringThe arweave host to use for loading metadata."arweave.net"
arweave.portnumberThe arweave port to use for loading metadata.443
arweave.protocolstringThe arweave protocol to use for loading metadata."https"
arweave.loggingbooleanTurn arweave logging on or off.false
new Masa({
// cookie value for connecting with the backend
cookie: "my fancy cookie",
// wallet object is always mandatory
wallet,
// api endpoint to the masa infrastructure
apiUrl: "https://middleware.masa.finance",
// masa environment dev, test, beta, prod
environment: "prod",
// network name to use goerli, mainnet
network: "goerli",
// arweave endpoint to use
arweave: {
host: "arweave.net",
port: 443,
protocol: "https",
logging: false,
},
});