@dippixyz/base

Dippi SDK for JS

This is the Dippi SDK for JavaScript, providing a wrapper around the Dippi API.

Installation

npm i @dippixyz/base

Usage

Go to client.dippi.xyz to sign up and obtain an appToken and appId.

Class Definitions

Dippi

• appToken: string;
• appId: string;
• url: string;
• authToken: string;
• urlReturn: string;
• auth: AuthInterface;
• user: UserInterface;
• wallet: WalletInterface;
• application: ApplicationInterface;
• applicationToken: ApplicationTokenInterface;

TBA

• appToken: string;
• appId: string;
• url: string;
• authToken: string;
• auth: Auth;
• _tokenBoundAccount: TokenBoundAccountInterface;

Dippi Client

To use the Dippi Client, follow the steps below:

1. Initialization:

   const { Dippi, TBA } = require('@dippixyz/base');
   
   const dippiClient = new Dippi({
       appToken: [appToken],
       appId: [appId],
       url: 'https://api.dippi.xyz',
   });

2. Authentication:

   const { accessToken } = await dippiClient.auth.login();
   dippiClient.setAuthToken(accessToken);

3. Fetching User Profile:

   const userProfile = await dippiClient.user.getProfile(userId);

4. Working with Wallets, Applications, and Application Tokens:

   const userWallets = await dippiClient.wallet.list();
   const userApplications = await dippiClient.application.list();
   const userApplicationToken = await dippiClient.applicationToken.retrieve(
       applicationId,
   );

Token Bound Account (TBA)

To utilize the Token Bound Account (TBA) Class:

1. Initialization:

   const tbaConfig = {
       appToken: [appToken],
       appId: [appId],
       url: 'https://api.dippi.xyz',
       auth: dippiClient.auth, // Passing the auth instance from Dippi client
   };
   
   const tba = new TBA(tbaConfig);

2. Initialization and Creation for TBA:

   const initArgs = {
       destinationWallet: 'destinationWalletAddress',
       nftContract: 'nftContractAddress',
       nftId: 'nftId',
   };
   
   await tba.init(initArgs);
   await tba.create();

Example Application

Below is an example of how you can utilize the Dippi SDK and the TBA feature in a simple Node.js application.

const { Dippi, TBA } = require('@dippixyz/base');

// Initialize Dippi Client
const dippiClient = new Dippi({
    appToken: 'yourAppToken',
    appId: 'yourAppId',
    url: 'https://api.dippi.xyz',
});

(async () => {
    // Authenticate Dippi Client
    const { accessToken } = await dippiClient.auth.login();
    dippiClient.setAuthToken(accessToken);

    // Fetch User Profile
    const userId = 'yourUserId';
    const userProfile = await dippiClient.user.getProfile(userId);

    // Create User Profile
    const userProfileData: UserCreatePayload = {
        email: 'your.email@example.com',
        applicationId: 'yourApplicationId',
        password: 'yourPassword',
        authType: 'yourAuthType',
        phone: 'yourPhoneNumber',
    };
    await dippiClient.user.createProfile(userProfileData);

    // Authenticate User
    const signInData: SignInPayload = {
        email: 'your.email@example.com',
        password: 'yourPassword',
        token: 'yourToken',
        applicationId: 'yourApplicationId',
        countryCode: 'yourCountryCode',
    };
    await dippiClient.user.authenticate(signInData);

    // Reset password for user
    const resetPasswordData: ResetPasswordPayload = {
        email: 'your.email@example.com',
    };
    await dippiClient.user.resetPassword(resetPasswordData);

    // Change password for user
    const changePasswordData: ChangePasswordPayload = {
        userEmail: 'your.email@example.com',
        oldPassword: 'your_old_password',
        password: 'your_new_password',
        repeatedPassword: 'your_new_password',
    };
    await dippiClient.user.changePassword(changePasswordData);

    // List User Wallets
    const userWallets = await dippiClient.wallet.list();

    // Create Wallet
    const walletCreateData: WalletCreatePayload = {
        ownerId: 'yourOwnerId',
        walletType: 'yourWalletType',
        isTestNet: true,
        storeOption: 'email',
        userCode: 'yourUserCode',
        name: 'yourWalletName',
        fromMnemonic: true,
        mnemonicPhrase: 'yourMnemonicPhrase',
        fromPrivateKey: true,
        privateKey: 'yourPrivateKey',
        useRecoveryPhrase: true,
        recoveryPhrase: 'yourRecoveryPhrase',
        repeatedRecoveryPhrase: 'yourRepeatedRecoveryPhrase',
        useKeyppiProtocol: true,
        useKeyppiTransactionInfluenciableWallets: true,
        transactionInfluenciableWallets: 'yourTransactionInfluenciableWallets',
        acceptTermsAndConditions: true,
        environment: 'yourEnvironment',
    };
    await dippiClient.wallet.create(walletCreateData);

    // Get NFTs
    const getNFTsData: WalletGetNFTsPayload = {
        address: 'yourWalletAddress',
        chainId: 1, // Replace with actual chainId
    };
    await dippiCliente.wallet.getNFTs(getNFTsData);

    // Get Balance
    await dippiClient.wallet.getBalance('yourWalletAddress');

    // Get Wallet Info
    await dippiClient.wallet.getWalletInfo('yourWalletAddress');

    // List User Applications
    const userApplications = await dippiClient.application.list();

    // Retrieve User Application Token
    const tokenId = 'yourTokenId';
    const userApplicationToken = await dippiClient.applicationToken.retrieve(
        tokenId,
    );

    // Initialize TBA
    const tbaConfig = {
        appToken: 'yourAppToken',
        appId: 'yourAppId',
        url: 'https://api.dippi.xyz',
        auth: dippiClient.auth,
        _tokenBoundAccount: {},
    };

    const tba = new TBA(tbaConfig);

    // Initialize and Create TBA
    const initArgs = {
        destinationWallet: 'destinationWalletAddress',
        chainId: 'chain id',
        nftContract: 'nftContractAddress',
        nftId: 'nftId',
    };

    await tba.init(initArgs);
    await tba.createAccount();

    console.log('TBA created successfully!');
})();

Make sure to replace the placeholders in the code with your actual data. Save this code in a file, say app.js, and run it using node app.js.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• etc