Skip to content

Commit

Permalink
Merge branch 'master' into replace-tweetnacl-by-@noble/curves
Browse files Browse the repository at this point in the history
  • Loading branch information
gtsonevv authored Dec 15, 2023
2 parents 2b17056 + ecf29e2 commit cd351b2
Show file tree
Hide file tree
Showing 67 changed files with 735 additions and 235 deletions.
5 changes: 5 additions & 0 deletions .changeset/healthy-bees-shout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@near-js/providers": patch
---

retry RPC request on 408 HTTP error
9 changes: 9 additions & 0 deletions .changeset/nervous-bugs-doubt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
"near-api-js": minor
"@near-js/accounts": patch
"@near-js/providers": patch
"@near-js/utils": patch
"@near-js/wallet-account": patch
---

Internal logging library with capabilities for integration with modern logging libraries like Pino, Winston, etc
31 changes: 0 additions & 31 deletions .github/workflows/docs-generator-trigger.yml

This file was deleted.

48 changes: 48 additions & 0 deletions .github/workflows/typedoc-generator.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Deploy TypeDoc on GitHub pages

on:
push:
branches:
master

env:
NODE_VERSION: 18.x
ENTRY_FILE: 'packages'
CONFIG_PATH: 'tsconfig.base.json'
USES_PNPM: 'true'
DESTINATION_FOLDER: "docs"

jobs:
deploy:
concurrency: ci-${{ github.ref }}
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v3
with:
node-version: ${{ env.NODE_VERSION }}

- name: Setup pnpm
uses: pnpm/[email protected]
with:
version: 7

- name: Install dependencies
run: pnpm install

- name: Build project
run: pnpm build

- name: Build documentation
run: pnpm docs:generate

- name: Deploy to GitHub pages
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: ${{ env.DESTINATION_FOLDER }}
clean: true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ lib/
test-keys/

.turbo

typedoc-docs/
2 changes: 2 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ const {
format,
logWarning,
rpc_errors,
Logger
} = utils;
const {
formatNearAmount,
Expand Down Expand Up @@ -316,5 +317,6 @@ import {
parseNearAmount,
parseResultError,
parseRpcError,
Logger
} from '@near-js/utils';
```
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NEAR JavaScript API

[![Build Status](https://travis-ci.com/near/near-api-js.svg?branch=master)](https://travis-ci.com/near/near-api-js)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fnear%2Fnear-api-js%2Fbadge&style=flat&label=Build)](https://actions-badge.atrox.dev/near/near-api-js/goto)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/near/near-api-js)

NEAR JavaScript API is a complete library to interact with the NEAR blockchain. You can use it in the browser, or in Node.js runtime.
Expand Down
10 changes: 0 additions & 10 deletions docs/README.md

This file was deleted.

25 changes: 12 additions & 13 deletions docs/README_TYPEDOC.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
"autoclave": "rimraf packages/**/dist && rimraf packages/**/lib && rimraf packages/**/node_modules && rimraf packages/**/coverage && rimraf packages/**/.turbo && rm -rf node_modules",
"test": "turbo run test",
"release": "changeset publish",
"prepare": "husky install"
"prepare": "husky install",
"docs:generate": "typedoc"
},
"devDependencies": {
"@changesets/changelog-github": "^0.4.6",
Expand All @@ -28,6 +29,7 @@
"husky": "^7.0.4",
"rimraf": "^3.0.2",
"turbo": "^1.4.5",
"typedoc": "^0.25.3",
"typescript": "^4.9.4"
}
}
16 changes: 8 additions & 8 deletions packages/accounts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ A collection of classes, functions, and types for interacting with accounts and

## Modules

- [Account](src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc.
- [AccountMultisig](src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions
- [Account2FA](src/account_2fa.ts) extension of `AccountMultisig` used in conjunction with 2FA provided by [near-contract-helper](https://github.com/near/near-contract-helper)
- [AccountCreator](src/account_creator.ts) classes for creating NEAR accounts
- [Contract](src/contract.ts) represents a deployed smart contract with view and/or change methods
- [Connection](src/connection.ts) a record containing the information required to connect to NEAR RPC
- [Constants](src/constants.ts) account-specific constants
- [Types](src/types.ts) account-specific types
- [Account](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc.
- [AccountMultisig](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions
- [Account2FA](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_2fa.ts) extension of `AccountMultisig` used in conjunction with 2FA provided by [near-contract-helper](https://github.com/near/near-contract-helper)
- [AccountCreator](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_creator.ts) classes for creating NEAR accounts
- [Contract](https://github.com/near/near-api-js/blob/master/packages/accounts/src/contract.ts) represents a deployed smart contract with view and/or change methods
- [Connection](https://github.com/near/near-api-js/blob/master/packages/accounts/src/connection.ts) a record containing the information required to connect to NEAR RPC
- [Constants](https://github.com/near/near-api-js/blob/master/packages/accounts/src/constants.ts) account-specific constants
- [Types](https://github.com/near/near-api-js/blob/master/packages/accounts/src/types.ts) account-specific types

# License

Expand Down
Loading

0 comments on commit cd351b2

Please sign in to comment.