hashgraph / hedera-sdk-js Goto Github PK

View Code? Open in Web Editor NEW

256.0 22.0 133.0 33.2 MB

Hedera™ Hashgraph SDK for JavaScript/TypeScript

Home Page: https://docs.hedera.com/guides/docs/sdks

License: Apache License 2.0

JavaScript 99.35% HTML 0.15% Shell 0.03% Solidity 0.47%

hashgraph hedera sdk distributed-ledger-technology javascript typescript typescript-sdk hedera-sdk javascript-sdk

hedera-sdk-js's Introduction

Hedera™ Hashgraph JavaScript SDK

The JavaScript SDK for interacting with Hedera Hashgraph: the official distributed consensus platform built using the hashgraph consensus algorithm for fast, fair and secure transactions. Hedera enables and empowers developers to build an entirely new class of decentralized applications.

Install

NOTE: v1 of the SDK is deprecated and support will be discontinued after October 2021. Please install the latest version 2.x or migrate from v1 to the latest 2.x version. You can reference the migration documentation.

# with NPM
$ npm install --save @hashgraph/sdk

# with Yarn
$ yarn add @hashgraph/sdk

# with PNPM
$ pnpm add @hashgraph/sdk

Build

After downloading the repo run task build to build the SDK.

React Native Support

The Hedera JavaScript SDK supports the following:

React Native with Expo - keep in mind that the SDK uses some functionalities provided from ethers/ethersproject and there is an issue using parts of ethers.js in this environment. A shims package has to be installed and imported before importing the SDK in your project as it is showed here
Useful information: here and here

The Hedera JavaScript SDK does not currently support the following:

React Native Bare

Usage

See examples.

Every example can be executed using the following command from the root directory: node examples/[name-of-example].js

Start tests

To start the integration tests follow the next steps:
- Run the local node
- Run task test:intergration:node
- Stop the local node
To start unit tests follow the next steps:
- Run task test:unit (Note: the local node should not be running)

Contributing to this Project

We welcome participation from all developers! For instructions on how to contribute to this repo, please review the Contributing Guide.

License Information

Licensed under Apache License, Version 2.0 – see LICENSE in this repo or apache.org/licenses/LICENSE-2.0.

hedera-sdk-js's People

Contributors

Stargazers

Watchers

Forkers

questofiranon vik-bc kenthejr jimmy-james cooper-kunz stackchain sheng-long iamsooraj joe-nano al94hub bitshareslabs mauricedw22 shivasunny9 b-malina jaimesilver christianholman sabri0 keithy stjordanis exodusmovement codedebug marioreis irhonin cied kabbalahoracle hrupprecht alhood77 cristo-conklin nsjames dochavez joonhojhan meeco abraham-yusuf derdis14 launchbadge timicoker simihunjan ssetzer themiridius omki teamfloki naydogdu lgs guardaco anablock pranav0210 ericcrosson-bitgo bitgopatmcl sergmetelin adzman an-2018 forrest-develop mitzvahgirl clarence83 nanseetu kkartunov kelliejanae radu-at m-alifida buidler-labs 0111-b babyfish2littlewhale shemnon kilianb misterrpink1 tomnortonjr topachi sbwengineer pathornteng willparks isaacadams affiner ets-reactnative4 pinpong whotooktwarden bpam1021 ar-conmit mayoral13 neurone imhunterand tinker-michaelj uac-nhan-nguyen shades2 eyargholder mistydawn71 0x4139 artpologabriel greenbaum sharecare-app dekivincc akshaireddy-ids espirus charmful0x smannathan khanbabakhani j746 roheka bguiz andrewdoro sk-web23

hedera-sdk-js's Issues

[CreateAccountTransaction] Set auto renew duration to 7890000 seconds

hashgraph/hedera-sdk-java#223

Implement files

Add Dependabot

https://dependabot.com/

Implement contracts

requires #19

Store the chain code in the keystore if available (and restore when a keystore is used so we can have a derivable key from the keystore)

Expose BigNumber's comparison functions in Hbar class

[Help] Error getting balance - DNS resolution failed

I believe my JS SDK transactions are failing due to MyHbarWallet's proxy being down? If this is the case, can we potentially provide a better error message?

Pablo from Hashing Systems filed a seemingly related issue within the MHW repo here (#280) which actually made me realize this was likely the issue I was encountering.

Additionally, could someone clarify which client proxy config is correct for this release? (discussed in the additional attempts to resolve section)

Details
Running the get-account-info.js example for release v.0.8.0-beta.0 returns the following errors

(node:4974) UnhandledPromiseRejectionWarning: Error: 14 UNAVAILABLE: DNS resolution failed
    at Object.exports.createStatusError (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/common.js:91:15)
    at Object.onReceiveStatus (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/client_interceptors.js:1209:28)
    at InterceptingListener._callNext (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/client_interceptors.js:568:42)
    at InterceptingListener.onReceiveStatus (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/client_interceptors.js:618:8)
    at callback (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/client_interceptors.js:847:24)
(node:4974) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:4974) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Code

require("dotenv").config();

const { Client, AccountBalanceQuery } = require("@hashgraph/sdk");

async function main() {
    const operatorPrivateKey = process.env.OPERATOR_KEY;
    const operatorAccount = process.env.OPERATOR_ID;

    if (operatorPrivateKey == null || operatorAccount == null) {
        throw new Error("environment variables OPERATOR_KEY and OPERATOR_ID must be present");
    }

    const client = new Client({
      network: { "https://grpc-web.myhederawallet.com": "0.0.3" },
      operator: {
            account: operatorAccount,
            privateKey: operatorPrivateKey
        }
    });
    
    const balance = await new AccountBalanceQuery()
        .setAccountId(operatorAccount)
        .execute(client);

    console.log(`${operatorAccount} balance = ${balance.value()}`);
}

main();

Attempt to fix

On the readme for release v.0.8.0-beta.0 it says to proxy to the grpc-web.myhederawallet.com domain, rather than the actual Node IP address that is included in the /examples so I attempted to run this as well...

Updated code

require("dotenv").config();

const { Client, AccountBalanceQuery } = require("@hashgraph/sdk");

async function main() {
    const operatorPrivateKey = process.env.OPERATOR_KEY;
    const operatorAccount = process.env.OPERATOR_ID;

    if (operatorPrivateKey == null || operatorAccount == null) {
        throw new Error("environment variables OPERATOR_KEY and OPERATOR_ID must be present");
    }

    const client = new Client({
      network: { "0.testnet.hedera.com:50211": "0.0.3" },
      operator: {
            account: operatorAccount,
            privateKey: operatorPrivateKey
        }
    });
    
    const balance = await new AccountBalanceQuery()
        .setAccountId(operatorAccount)
        .execute(client);

    console.log(`${operatorAccount} balance = ${balance.value()}`);
}

main();

Which delayed for quite some time before returning the following response.

Updated error

(node:5056) UnhandledPromiseRejectionWarning: Error: 14 UNAVAILABLE: failed to connect to all addresses
    at Object.exports.createStatusError (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/common.js:91:15)
    at Object.onReceiveStatus (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/client_interceptors.js:1209:28)
    at InterceptingListener._callNext (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/client_interceptors.js:568:42)
    at InterceptingListener.onReceiveStatus (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/client_interceptors.js:618:8)
    at callback (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/grpc/src/client_interceptors.js:847:24)
(node:5056) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:5056) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

package.json below, if it's of help

{
  "name": "test1",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@hashgraph/sdk": "^0.8.0-beta.0",
    "dotenv": "^8.2.0"
  }
}

Overall the v.0.8.0-beta.0 functionality is looking nice though - excited to test it out 🎊

[help] FileCreateTransaction is asking to setFile before it exists?

I'm attempting to create a file on release v.0.8.0-beta-0 and getting the following error.

(node:2981) UnhandledPromiseRejectionWarning: Error: FileCreateTransaction failed validation:
FileCreateTransaction must have a file set
    at Object.runValidation (/Users/cooperkunz/Desktop/Hedera-JS-Examples/js-sdk/node_modules/@hashgraph/sdk/lib/util.js:100:15)
    at FileCreateTransaction.validate (/Users/cooperkunz/Desktop/Hedera-JS-Examples/js-sdk/node_modules/@hashgraph/sdk/lib/TransactionBuilder.js:45:16)
    at FileCreateTransaction.build (/Users/cooperkunz/Desktop/Hedera-JS-Examples/js-sdk/node_modules/@hashgraph/sdk/lib/TransactionBuilder.js:79:14)
    at main (/Users/cooperkunz/Desktop/Hedera-JS-Examples/js-sdk/file-create.js:25:6)
    at Object.<anonymous> (/Users/cooperkunz/Desktop/Hedera-JS-Examples/js-sdk/file-create.js:30:1)
    at Module._compile (internal/modules/cjs/loader.js:778:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
    at Module.load (internal/modules/cjs/loader.js:653:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
    at Function.Module._load (internal/modules/cjs/loader.js:585:3)

When running a FileCreateTransaction, why would it expect to have a FileID already set?

Details
There are no examples for using the file service within the repository, but I expected the FileCreateTransaction Test would have been a good indicator for desired behavior. I have now attempted to run this test, and it doesn't appear to be working itself.

The code I would like to work is as follows.

require("dotenv").config();

const { Client, FileCreateTransaction } = require("@hashgraph/sdk");

async function main() {
  const operatorPrivateKey = process.env.OPERATOR_KEY;
  const operatorAccount = process.env.OPERATOR_ID;

  if (operatorPrivateKey == null || operatorAccount == null) {
    throw new Error(
      "environment variables OPERATOR_KEY and OPERATOR_ID must be present"
    );
  }

  const client = new Client({
    network: { "0.testnet.hedera.com:50211": "0.0.3" },
    operator: {
      account: operatorAccount,
      privateKey: operatorPrivateKey
    }
  });

  const transaction = new FileCreateTransaction()
    .setContents("testing file create transaction")
    .build(client);

  console.log(await transaction.execute(client));
}

main();

I would hope to run the above with defaults for fees, operator, no admin key, etc. and then the return value of the transaction execution (record/receipt/etc, whatever it is) would give me the File ID. Similarly to the Java SDK example.

Implement CryptoGetStakers

Error: invalid private key: <pkey>

When I use string type pkey:

import {Client} from "@hashgraph/sdk";

const client = new Client({ 
    // this key defaults to this url, a public free proxy to the Hedera public testnet
    // generously hosted by MyHederaWallet.com
    url: "https://grpc-web.myhederawallet.com",
    operator: {
        // the account which signs transactions and query payments by default
        account: { shard: 0, realm: 0, account: ___ },
        // the private key used to sign the transactions, either encoded as a string
        // or as an `Ed25519PrivateKey` type 
        privateKey: "..."
    },
});

Error:

Error: invalid private key: <pkey>

How I can convert string type pkey to Ed25519 type ?

/** If `privateKey` is a string it will be parsed as an `Ed25519PrivateKey` */
export type PrivateKey = { privateKey: Ed25519PrivateKey | string };
export type PubKeyAndSigner = {
    publicKey: Ed25519PublicKey;
    signer: Signer;
};

Implement CallParams / FunctionResult

#62 adds preliminary smart contract support but only supports passing parameters/results as bytes for the moment.

We have a decently fleshed out API in the Java SDK that we should probably just copy:

implement AccountInfoQuery

Add Transaction.getRecord ( mirror from Java )

This should let us widen support for the SDK.

Add BIP-44 key derivation

See https://iancoleman.io/bip39/#english

API idea

const rootKey = Ed25519PrivateKey.fromMnemonic("word list sep by space");
const yourKey = rootKey.derive({ account: 0, change: 0, index: 0 });

[question] support for custom key types

Does this SDK support threshold or other key schemas yet?

If so, can I get an example of how to use? If not, any ideas on when that may be added?

fromProto and toProto should be private/protected methods everywhere

We don't want to expose that association directly

When generating the keystore from scratch, generate the full entropy and store a chain code so it can be later derived

Implement GetBySolidityId

Help with Account Info Query

Curious if this is just an issue on my end? If so, any suggestions on how to resolve? 🤞

Original issue
When running the get-account-info.js example for release v.0.7.2 I get the following errors

node get-account-info.js
(node:1501) UnhandledPromiseRejectionWarning: Error: AccountInfoQuery failed validation:
`.setPayment()` required
    at Object.runValidation (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/util.js:100:15)
    at AccountInfoQuery.validate (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/QueryBuilder.js:56:16)
    at AccountInfoQuery.<anonymous> (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/QueryBuilder.js:106:18)
    at Generator.next (<anonymous>)
    at /Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/QueryBuilder.js:8:71
    at new Promise (<anonymous>)
    at __awaiter (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/QueryBuilder.js:4:12)
    at AccountInfoQuery.execute (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/QueryBuilder.js:97:16)
    at /Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/get-account-info.js:21:108
    at Object.<anonymous> (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/get-account-info.js:22:2)

Attempt to resolve
After receiving that error, I attempted to setPayment(1000000), making the updated script

require("dotenv").config();

const { AccountInfoQuery, Client } = require("@hashgraph/sdk");

const privateKey = process.env.OPERATOR_KEY;

if (!privateKey) {
  throw new Error("missing env var OPERATOR_KEY");
}

const client = new Client({
  operator: {
    account: { shard: 0, realm: 0, account: process.env.OPERATOR_ID },
    privateKey
  }
});

const accountId = { shard: 0, realm: 0, account: 3 };

(async function() {
  console.log(
    "account info:",
    JSON.stringify(
      await new AccountInfoQuery(client)
        .setAccountId(accountId)
        .setPayment(1000000)
        .execute()
    )
  );
})();

Secondary issue
Which then results in the following error

(node:1518) UnhandledPromiseRejectionWarning: TypeError: c.toArray is not a function
    at Function.jspb.Message.setWrapperField (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/google-protobuf/google-protobuf.js:432:335)
    at proto.proto.QueryHeader.setPayment (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/generated/QueryHeader_pb.js:181:23)
    at AccountInfoQuery.setPayment (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/QueryBuilder.js:52:22)
    at /Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/get-account-info.js:21:108
    at Object.<anonymous> (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/get-account-info.js:22:2)
    at Module._compile (internal/modules/cjs/loader.js:778:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
    at Module.load (internal/modules/cjs/loader.js:653:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
    at Function.Module._load (internal/modules/cjs/loader.js:585:3

package.json below, if it's of help

{
  "name": "test1",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@hashgraph/sdk": "^0.7.2",
    "dotenv": "^8.2.0"
  }
}

Error: Hedera returned response code: KEY_PREFIX_MISMATCH (68)

I am getting Error: Hedera returned response code: KEY_PREFIX_MISMATCH (68) when trying to run FileContentsQuery from the same account using which file is created

const fileIdLike = {
shard: 0, realm: 0, file: fileId
}
let fileQueryResp = await new FileContentsQuery(client).setFileId(fileIdLike).execute()

Re-export types used in public API

MnemonicResult
~~HederaError~~ (already reexported)
~~ResponseCodeEnum~~ (already reexported)

In BaseClient, too much of the operator internals is public

    public operator?: Operator;
    public operatorSigner?: Signer;
    public operatorPublicKey?: Ed25519PublicKey;

Not sure why we store / have all of that and why its all public. Look at the Java SDK Client. I think a step is not storing operator.

Error: "Hedera returned response code: INSUFFICIENT_PAYER_BALANCE (10)"
    node_modules hashgraph/sdk/lib/errors.js:19
    node_modules hashgraph/sdk/lib/errors.js:39
    node_modules hashgraph/sdk/lib/util.js:86
    node_modules hashgraph/sdk/lib/Transaction.js:96
    node_modules hashgraph/sdk/lib/Transaction.js:5

Implement GetByKey

Receipt query should internally retry on UNKNOWN / OK ( _waitForReceipt in Client should be moved to inside of TransactionReceiptQuery )

Issue

After running the updated crypto transfer example I'm getting the following error

(node:1854) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'maxTransactionFee' of undefined
    at new TransactionBuilder (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/TransactionBuilder.js:19:78)
    at new CryptoTransferTransaction (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/node_modules/@hashgraph/sdk/lib/account/CryptoTransferTransaction.js:11:9)
    at main (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/new-example.js:23:14)
    at Object.<anonymous> (/Users/cooperkunz/Desktop/hide/Hedera-JS-Examples/test1/new-example.js:32:1)
    at Module._compile (internal/modules/cjs/loader.js:778:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
    at Module.load (internal/modules/cjs/loader.js:653:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
    at Function.Module._load (internal/modules/cjs/loader.js:585:3)
    at Function.Module.runMain (internal/modules/cjs/loader.js:831:12)
(node:1854) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:1854) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Code to reproduce

require("dotenv").config();

const { Client, CryptoTransferTransaction } = require("@hashgraph/sdk");

async function main() {
  const operatorPrivateKey = process.env.OPERATOR_KEY;
  const operatorAccount = process.env.OPERATOR_ID;

  if (operatorPrivateKey == null || operatorAccount == null) {
    throw new Error(
      "environment variables OPERATOR_KEY and OPERATOR_ID must be present"
    );
  }

  const client = new Client({
    nodes: { "0.testnet.hedera.com:50211": "0.0.3" },
    operator: {
      account: operatorAccount,
      privateKey: operatorPrivateKey
    }
  });

  const tx = new CryptoTransferTransaction()
    .addSender(operatorAccount, 10)
    .addRecipient("0.0.3", 10)
    .setMemo("[sdk example] transfer to 0.0.3")
    .build(client);

  await tx.execute(client);
}

main();