@aut-protocol/sdk
v0.0.78
Published
The TS/JS SDK package aims to make it easy for frontends/backends to integrate with Aut Smart Contracts
Downloads
124
Readme
Overview
The TS/JS SDK package aims to make it easy for frontends/backends to integrate with Aut Smart Contracts. The SDK abstracts the smart contract calls and brings the web2 development experience when using the Aut Protocol contracts. The SDK consist of two main classes - DAOExpander and AutID. The integrator passes the signer/provider to the SDK so that it can be used with any wallet/provider.
Installation
npm i @aut-protocol/sdk
or if you prefer using yarn
yarn @aut-protocol/sdk
Get Started
const provider = new ethers.providers.Web3Provider(window.ethereum);
const signer = provider.getSigner();
const sdk = new AutSDK({
nftStorageApiKey: process.env.nftStorageKey, // its optional but certain functions depend on it.
});
await sdk.init(
signer,
{
daoTypesAddress: process.env.daoTypesAddress,
autIDAddress: process.env.autIDAddress,
daoExpanderRegistryAddress: process.env.daoExpanderRegistryAddress,
} // Contract addresses are optional, you can provide only the ones that you are going to use
);
const reponse = await sdk.autID.getAutID({ tokenId: "0" });
const {
isSuccess
errorMessage,
data,
transactionHash,
} = response;
Using Biconomy example
Biconomy Installation and usage Biconomo-Wrapper
const provider = new ethers.providers.Web3Provider(window.ethereum);
const signer = provider.getSigner();
const biconomy = new SDKBiconomyWrapper({
enableDebugMode: true,
apiKey: process.env.apiKey,
contractAddresses: [0x...],
});
const sdk = new AutSDK({
nftStorageApiKey: process.env.nftStorageKey,
});
await sdk.init(
signer,
{
daoTypesAddress: process.env.daoTypesAddress,
autIDAddress: process.env.autIDAddress,
daoExpanderRegistryAddress: process.env.daoExpanderRegistryAddress,
},
biconomy
);
const reponse = await sdk.autID.getAutID({ tokenId: "0" });
const {
isSuccess
errorMessage,
data,
transactionHash,
} = response;
More resources
For more information please visit: Aut Docs
Example app: Example SDK app