npmpackage.info

Gathering detailed insights and metrics for @terra-money/terra.js

Gathering detailed insights and metrics for @terra-money/terra.js

@terra-money/terra.js

JavaScript SDK for Terra, written in TypeScript

3.1.10

262

MIT

TypeScript

Installations

npm install @terra-money/terra.js

Pull Requests

Open

2

Total

206

Closed

22

Merged

182

Issues

Open

13

Total

161

Closed

148

Releases

39

v3.1.10

Published on 06 Jul 2023

3.1.9

Published on 12 Jun 2023

v3.1.7

Published on 06 Sept 2022

v3.1.6

Published on 17 Aug 2022

v3.1.5

Published on 27 Jul 2022

v3.1.4

Published on 15 Jul 2022

View all 39 releases

Developer

terra-money

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=14

Typescript Support

No

Node Version

16.19.1

NPM Version

9.6.4

Statistics

262 Stars

550 Commits

153 Forks

33 Watching

18 Branches

38 Contributors

Updated on 09 Oct 2024

Languages

TypeScript (99.74%)

JavaScript (0.26%)

Total Downloads

Cumulative downloads

Total Downloads

3,085,336

Last day

16.1%

3,597

Compared to previous day

Last week

3.1%

19,902

Compared to previous week

Last month

2.6%

77,962

Compared to previous month

Last year

4.6%

943,916

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

The JavaScript SDK for Terra

diagram

GitHub npm (scoped)

Explore the Docs »

Examples · API Reference · NPM Package · GitHub

Terra.js is a JavaScript SDK for writing applications that interact with the Terra blockchain from either Node.js, browser, or React Native environments and provides simple abstractions over core data structures, serialization, key management, and API request generation.

Features

Written in TypeScript, with type definitions
Versatile support for key management solutions
Works in Node.js, in the browser, and React Native
Exposes the Terra API through LCDClient
Parses responses into native JavaScript types

We highly suggest using Terra.js with TypeScript, or JavaScript in a code editor that has support for type declarations, so you can take advantage of the helpful type hints that are included with the package.

Installation

Grab the latest version off NPM:

1npm install @terra-money/terra.js

Usage

Terra.js can be used in Node.js, as well as inside the browser. Please check the docs for notes on how to get up and running.

Getting blockchain data

:exclamation: terra.js can connect both terra-classic and terra network. If you want to communicate with classic chain, you have to set isClassic as true.

1import { LCDClient, Coin } from '@terra-money/terra.js';
2
3// connect to pisco testnet
4const terra = new LCDClient({
5  URL: 'https://pisco-lcd.terra.dev',
6  chainID: 'pisco-1',
7  isClassic: false  // if it is unset, LCDClient assumes the flag is false.
8});
9
10// connect to columbus-5 terra classic network
11const terra = new LCDClient({
12  URL: 'https://columbus-lcd.terra.dev',
13  chainID: 'columbus-5',
14  isClassic: true  // *set to true to connect terra-classic chain*
15});
16
17// To use LocalTerra
18// const terra = new LCDClient({
19//   URL: 'http://localhost:1317',
20//   chainID: 'localterra'
21// });
22
23// get the current balance of `terra1x46rqay4d3cssq8gxxvqz8xt6nwlz4td20k38v`
24const balance = terra.bank.balance('terra1x46rqay4d3cssq8gxxvqz8xt6nwlz4td20k38v');
25console.log(balance);

Broadcasting transactions

First, get some testnet tokens for terra1x46rqay4d3cssq8gxxvqz8xt6nwlz4td20k38v, or use LocalTerra.

1import { LCDClient, MsgSend, MnemonicKey } from '@terra-money/terra.js';
2
3// create a key out of a mnemonic
4const mk = new MnemonicKey({
5  mnemonic:
6    'notice oak worry limit wrap speak medal online prefer cluster roof addict wrist behave treat actual wasp year salad speed social layer crew genius',
7});
8
9// connect to bombay testnet
10const terra = new LCDClient({
11  URL: 'https://pisco-lcd.terra.dev',
12  chainID: 'pisco-1',
13});
14
15// To use LocalTerra
16// const terra = new LCDClient({
17//   URL: 'http://localhost:1317',
18//   chainID: 'localterra'
19// });
20
21// a wallet can be created out of any key
22// wallets abstract transaction building
23const wallet = terra.wallet(mk);
24
25// create a simple message that moves coin balances
26const send = new MsgSend(
27  'terra1x46rqay4d3cssq8gxxvqz8xt6nwlz4td20k38v',
28  'terra17lmam6zguazs5q5u6z5mmx76uj63gldnse2pdp',
29  { uluna: 1200000}
30);
31
32wallet
33  .createAndSignTx({
34    msgs: [send],
35    memo: 'test from terra.js!',
36  })
37  .then(tx => terra.tx.broadcast(tx))
38  .then(result => {
39    console.log(`TX hash: ${result.txhash}`);
40  });

Terra.js in the browser

You can access all the objects of the @terra-money/terra.js from the global Terra object if you load Terra.js with a <script> tag.

Include the following in your browser:

1<script
2  crossorigin
3  src="https://unpkg.com/@terra-money/terra.js/dist/bundle.js"
4></script>

You can find a small JSFiddle example that refreshes current Oracle votes here.

Terra.js in React Native

In order to use Terra.js inside React Native, you need to add the node-libs-react-native package and react-native-get-random-values package to your React Native app's package.json.

1yarn add node-libs-react-native react-native-get-random-values

You will need to register Node.js native modules in an entry point of your application, such as index.tsx:

1import 'node-libs-react-native/globals';
2import 'react-native-get-random-values';

Also, add resolvers to your metro.config.js

1module.exports {
2  // ...
3  resolver: {
4    // ...
5    extraNodeModules: require('node-libs-react-native'),
6  },
7  // ...
8}

License

This software is licensed under the MIT license. See LICENSE for full disclosure.

© 2020 Terraform Labs, PTE.

Empty State

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

8

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/npm-publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/npm-publish.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/npm-publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/typedoc.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/typedoc.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/typedoc.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/terra-money/terra.js/typedoc.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/npm-publish.yml:15
Info: 0 out of 7 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 2 out of 3 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.6

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.