Docs/deps (#556)

* docs: Update deps * docs: Update doc refs
bnb-chain · May 31, 2024 · d1b742a · d1b742a
1 parent 87890ab
commit d1b742a
Show file tree

Hide file tree

Showing 27 changed files with 13,498 additions and 11,088 deletions.
diff --git a/doc-site/docs/api/group.mdx b/doc-site/docs/api/group.mdx
@@ -24,8 +24,7 @@ Examples of permissions include:
 - `Create`, `Associate payment accounts`
 - `Grant`, `Revoke` the above permissions
 
-For more details regarding `Group`, please refer to
-https://docs.bnbchain.org/greenfield-docs/docs/guide/greenfield-blockchain/modules/permission.
+For more details regarding `Group`, please refer to [permisson](https://github.com/bnb-chain/greenfield/blob/master/docs/modules/permission.md).
 
 | params    | description                                             |
 | --------- | ------------------------------------------------------- |

diff --git a/doc-site/docs/api/overview.mdx b/doc-site/docs/api/overview.mdx
@@ -14,8 +14,8 @@ The SDK contains three APIs:
 
 - <ApiTypes type="Query" />
 
-  [query](https://docs.bnbchain.org/greenfield-docs/docs/api/blockchain-rest) info from greenfield.
+  [query](https://greenfield-chain.bnbchain.org/openapi#/Query/) info from greenfield.
 
 - <ApiTypes type="Storage Provider" />
 
-  [more details](https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest)
+  [more details](https://github.com/bnb-chain/greenfield-storage-provider/tree/master/docs/modules).
diff --git a/doc-site/docs/api/sp.mdx b/doc-site/docs/api/sp.mdx
@@ -54,8 +54,7 @@ Get the global storage price details, including update time and store price. -->
 Get the group list by name and prefix. It provides fuzzy searches by inputting a specific name and
 prefix.
 
-More details:
-https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/get_group_list.
+More details: [get group list](https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/get_group_list.md).
 
 ```jsx title="example"
 await client.sp.listGroups({

diff --git a/doc-site/docs/client/greenfield.mdx b/doc-site/docs/client/greenfield.mdx
@@ -35,5 +35,5 @@ const client = Client.create(GRPC_URL, GREEN_CHAIN_ID);
 
 The JS SDK consists of two parts:
 
-- Chain: https://docs.bnbchain.org/greenfield-docs/docs/api/blockchain-rest
-- Storage Provider: https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest
+- [BlockChain API](https://greenfield-chain.bnbchain.org/openapi#/Query/StorageParams)
+- [Storage Provider API](https://github.com/bnb-chain/greenfield-storage-provider/tree/master/docs/storage-provider-rest-api)
diff --git a/doc-site/docs/client/query-client.mdx b/doc-site/docs/client/query-client.mdx
@@ -4,8 +4,7 @@ title: 'Query Client'
 sidebar_position: 2
 ---
 
-It's an encapsulation of the
-[Blockchain API](https://docs.bnbchain.org/greenfield-docs/docs/api/blockchain-rest).
+It's an encapsulation of the [BlockChain API](https://greenfield-chain.bnbchain.org/openapi#/Query/StorageParams)
 
 :::info
 
@@ -22,7 +21,7 @@ await rpc.Account({
 });
 ```
 
-More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/account-info
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/AccountInfo
 
 ## getBankQueryClient
 
@@ -34,7 +33,7 @@ await rpc.Balance({
 });
 ```
 
-More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/account-info
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/AccountInfo
 
 ## getBridgeQueryClient
 
@@ -43,7 +42,7 @@ const rpc = await client.queryClient.getBridgeQueryClient();
 await rpc.Params();
 ```
 
-More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/bridge-params
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/BridgeParams
 
 ## getChallengeQueryClient
 
@@ -52,7 +51,7 @@ const rpc = await client.queryClient.getChallengeQueryClient();
 await rpc.Params();
 ```
 
-More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/attested-challenge
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/AttestedChallenge
 
 ## getCrosschainQueryClient
 
@@ -61,7 +60,7 @@ const rpc = await client.queryClient.getCrosschainQueryClient();
 await rpc.Params();
 ```
 
-More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/attested-challenge
+More apis: https://greenfield-chain.bnbchain.org/openapi#/Query/AttestedChallenge
 
 ## getFeeGrantQueryClient
 
@@ -70,7 +69,7 @@ const rpc = await client.queryClient.getFeeGrantQueryClient();
 await rpc.Params();
 ```
 
-More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/allowance
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/Allowance
 
 ## getGashubClient
 
@@ -79,7 +78,7 @@ const rpc = await this.queryClient.getGashubClient();
 await rpc.MsgGasParams(request);
 ```
 
-More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/msg-gas-params
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/MsgGasParams
 
 ## getPaymentQueryClient
 
@@ -88,7 +87,7 @@ const rpc = await this.queryClient.getPaymentQueryClient();
 await rpc.Params();
 ```
 
-More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/msg-gas-params
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/MsgGasParams
 
 ## getSpQueryClient
 
@@ -97,8 +96,7 @@ const rpc = await this.queryClient.getSpQueryClient();
 await rpc.Params();
 ```
 
-More APIs:
-https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/query-global-sp-store-price-by-time
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/QueryGlobalSpStorePriceByTime
 
 ## getStorageQueryClient
 
@@ -109,7 +107,7 @@ await rpc.HeadBucketById({
 });
 ```
 
-More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/query-group-members-exist
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/QueryGroupMembersExist
 
 ## getVirtualGroupClient
 
@@ -118,5 +116,4 @@ const rpc = await client.queryClient.getVirtualGroupClient();
 await rpc.Params();
 ```
 
-More APIs:
-https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/available-global-virtual-group-families
+More APIs: https://greenfield-chain.bnbchain.org/openapi#/Query/AvailableGlobalVirtualGroupFamilies
diff --git a/doc-site/docs/client/sp-client.mdx b/doc-site/docs/client/sp-client.mdx
@@ -12,7 +12,7 @@ The API related to storage providers is troublesome.
 ## AuthType
 
 SDK support two
-[authentication type](https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest#authentication-type):
+[authentication type](https://github.com/bnb-chain/greenfield-storage-provider/tree/master/docs/storage-provider-rest-api#authentication-type):
 
 - ECDSA: It is usually used on Node.js(Because it need to use a private key)
 - EDDSA: It is usually used in a browser

diff --git a/doc-site/package.json b/doc-site/package.json
@@ -15,7 +15,7 @@
   },
   "dependencies": {
     "@docusaurus/core": "3.2.1",
-    "@docusaurus/plugin-ideal-image": "^3.2.1",
+    "@docusaurus/plugin-ideal-image": "3.2.1",
     "@docusaurus/preset-classic": "3.2.1",
     "@mdx-js/react": "^3.0.1",
     "clsx": "^1.2.1",

diff --git a/packages/js-sdk/src/clients/spclient/spApis/approval.ts b/packages/js-sdk/src/clients/spclient/spApis/approval.ts
@@ -5,7 +5,7 @@ import { getSortQueryParams } from '../auth';
 
 export type APPROVAL_ACTION = 'CreateBucket' | 'CreateObject' | 'MigrateBucket';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/get_approval
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/get_approval.md
 export const getApprovalMetaInfo = <T>(endpoint: string, action: APPROVAL_ACTION, msg: T) => {
   const path = '/greenfield/admin/v1/get-approval';
   const queryMap = {

diff --git a/packages/js-sdk/src/clients/spclient/spApis/getBucketMeta.ts b/packages/js-sdk/src/clients/spclient/spApis/getBucketMeta.ts
@@ -4,7 +4,7 @@ import { XMLParser } from 'fast-xml-parser';
 import { getSortQueryParams } from '../auth';
 import { SPMetaInfo } from './metaInfos';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/get_bucket_meta
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/get_bucket_meta.md
 export const getBucketMetaInfo = (
   endpoint: string,
   params: GetBucketMetaRequest,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/getObject.ts b/packages/js-sdk/src/clients/spclient/spApis/getObject.ts
@@ -3,7 +3,7 @@ import { ReqMeta } from '@/types';
 import { generateUrlByBucketName } from '@/utils/asserts/s3';
 import { encodePath } from '../auth';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/get_object
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/get_object.md
 export const getGetObjectMetaInfo = async (
   endpoint: string,
   params: {

diff --git a/packages/js-sdk/src/clients/spclient/spApis/getObjectMeta.ts b/packages/js-sdk/src/clients/spclient/spApis/getObjectMeta.ts
@@ -5,7 +5,7 @@ import { XMLParser } from 'fast-xml-parser';
 import { encodePath, getSortQueryParams } from '../auth';
 import type { SPMetaInfo } from './metaInfos';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/get_object_meta
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/get_object_meta.md
 export const getObjectMetaInfo = (
   endpoint: string,
   params: GetObjectMetaRequest,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/getUserBuckets.ts b/packages/js-sdk/src/clients/spclient/spApis/getUserBuckets.ts
@@ -3,7 +3,7 @@ import { convertStrToBool, formatBucketInfo, formatVGF } from '@/types/sp/Common
 import { XMLParser } from 'fast-xml-parser';
 import { SPMetaInfo } from './metaInfos';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/get_user_buckets
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/get_user_buckets.md
 export const getUserBucketMetaInfo = (endpoint: string): Pick<SPMetaInfo, 'url'> => {
   return {
     url: endpoint,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listBucketReadRecords.ts b/packages/js-sdk/src/clients/spclient/spApis/listBucketReadRecords.ts
@@ -10,7 +10,7 @@ import { XMLParser } from 'fast-xml-parser';
 import { getSortQuery, getSortQueryParams } from '../auth';
 import { SPMetaInfo } from './metaInfos';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/list_bucket_read_records
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_bucket_read_records.md
 export const getListBucketReadRecordMetaInfo = (
   endpoint: string,
   params: ListBucketReadRecordRequest,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listBucketsByIds.ts b/packages/js-sdk/src/clients/spclient/spApis/listBucketsByIds.ts
@@ -4,7 +4,7 @@ import { XMLParser } from 'fast-xml-parser';
 import { getSortQueryParams } from '../auth';
 import { SPMetaInfo } from './metaInfos';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/list_buckets_by_ids
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_buckets_by_ids.md
 export const getListBucketsByIDsMetaInfo = (
   endpoint: string,
   params: ListBucketsByIDsRequest,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listBucketsByPayment.ts b/packages/js-sdk/src/clients/spclient/spApis/listBucketsByPayment.ts
@@ -6,7 +6,7 @@ import {
 import { XMLParser } from 'fast-xml-parser';
 import { getSortQueryParams } from '../auth';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/list_payment_account_streams
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_payment_account_streams.md
 export const getListBucketByPaymentMetaInfo = (
   endpoint: string,
   params: ListBucketsByPaymentAccountRequest,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listGroups.ts b/packages/js-sdk/src/clients/spclient/spApis/listGroups.ts
@@ -4,7 +4,7 @@ import { XMLParser } from 'fast-xml-parser';
 import { getSortQueryParams } from '../auth';
 import { SPMetaInfo } from './metaInfos';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/get_group_list
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/get_group_list.md
 export const getListGroupMetaInfo = (
   endpoint: string,
   params: ListGroupsResquest,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listGroupsMembers.ts b/packages/js-sdk/src/clients/spclient/spApis/listGroupsMembers.ts
@@ -2,7 +2,7 @@ import { ListGroupsMembersResponse } from '@/types';
 import { formatGroupInfo, convertStrToBool } from '@/types/sp/Common';
 import { XMLParser } from 'fast-xml-parser';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/list_group_members
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_group_members.md
 export const parseListGroupsMembersResponse = async (data: string) => {
   const xmlParser = new XMLParser({
     parseTagValue: false,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listObjectsByBucket.ts b/packages/js-sdk/src/clients/spclient/spApis/listObjectsByBucket.ts
@@ -2,7 +2,7 @@ import { convertStrToBool, formatObjectInfo } from '@/types/sp/Common';
 import { ListObjectsByBucketNameResponse } from '@/types/sp/ListObjectsByBucketName';
 import { XMLParser } from 'fast-xml-parser';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/list_objects_by_bucket
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_objects_by_bucket.md
 export const parseListObjectsByBucketNameResponse = async (data: string) => {
   const xmlParser = new XMLParser({
     parseTagValue: false,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listObjectsByIds.ts b/packages/js-sdk/src/clients/spclient/spApis/listObjectsByIds.ts
@@ -3,7 +3,7 @@ import { formatObjectInfo, convertStrToBool } from '@/types/sp/Common';
 import { XMLParser } from 'fast-xml-parser';
 import { getSortQueryParams } from '../auth';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/list_objects_by_ids
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_objects_by_ids.md
 export const getListObjectsByIDsMetaInfo = (endpoint: string, params: ListObjectsByIDsRequest) => {
   const path = '';
   const queryMap = {

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listUserGroups.ts b/packages/js-sdk/src/clients/spclient/spApis/listUserGroups.ts
@@ -2,7 +2,7 @@ import { ListUserGroupsResponse } from '@/types';
 import { formatGroupInfo, convertStrToBool } from '@/types/sp/Common';
 import { XMLParser } from 'fast-xml-parser';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storgae-provider-rest/list_user_groups
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_user_groups.md
 export const parseListUserGroupsResponse = async (data: string) => {
   const xmlParser = new XMLParser({
     parseTagValue: false,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listUserOwnedGroups.ts b/packages/js-sdk/src/clients/spclient/spApis/listUserOwnedGroups.ts
@@ -2,7 +2,7 @@ import { formatGroupInfo, convertStrToBool } from '@/types/sp/Common';
 import { ListUserOwnedGroupsResponse } from '@/types/sp/ListUserOwnedGroups';
 import { XMLParser } from 'fast-xml-parser';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storgae-provider-rest/list_user_owned_groups
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_user_owned_groups.md
 export const parseListUserOwnedGroupsResponse = async (data: string) => {
   const xmlParser = new XMLParser({
     parseTagValue: false,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/listUserPaymentAccounts.ts b/packages/js-sdk/src/clients/spclient/spApis/listUserPaymentAccounts.ts
@@ -8,7 +8,7 @@ import {
 import { XMLParser } from 'fast-xml-parser';
 import { getSortQuery, getSortQueryParams } from '../auth';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/list_user_payment_accounts
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/list_user_payment_accounts.md
 export const getListUserPaymentAccountMetaInfo = (
   endpoint: string,
   params: ListUserPaymentAccountsResquest,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/putObject.ts b/packages/js-sdk/src/clients/spclient/spApis/putObject.ts
@@ -4,7 +4,7 @@ import { UploadFile } from '@/types/sp/Common';
 import { generateUrlByBucketName } from '@/utils/asserts/s3';
 import { encodePath, getSortQueryParams } from '../auth';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/put_object
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/put_object.md
 export const getPutObjectMetaInfo = async (
   endpoint: string,
   params: {

diff --git a/packages/js-sdk/src/clients/spclient/spApis/queryBucketReadQuota.ts b/packages/js-sdk/src/clients/spclient/spApis/queryBucketReadQuota.ts
@@ -5,7 +5,7 @@ import { generateUrlByBucketName } from '@/utils/asserts/s3';
 import { XMLParser } from 'fast-xml-parser';
 import { getSortQuery } from '../auth';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/query_bucket_read_quota
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/query_bucket_read_quota.md
 export const getQueryBucketReadQuotaMetaInfo = async (
   endpoint: string,
   params: ReadQuotaRequest,

diff --git a/packages/js-sdk/src/clients/spclient/spApis/resumablePutObject.ts b/packages/js-sdk/src/clients/spclient/spApis/resumablePutObject.ts
@@ -4,7 +4,7 @@ import { DelegatedOpts } from '@/types/sp/Common';
 import { generateUrlByBucketName } from '@/utils/asserts/s3';
 import { encodePath, getSortQueryParams } from '../auth';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storage-provider-rest/resumable_put_object
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/resumable_put_object.md
 export const getResumablePutObjectMetaInfo = async (
   endpoint: string,
   params: {

diff --git a/packages/js-sdk/src/clients/spclient/spApis/verifyPermission.ts b/packages/js-sdk/src/clients/spclient/spApis/verifyPermission.ts
@@ -1,7 +1,7 @@
 import { VerifyPermissionResponse } from '@/types/sp/VerifyPermission';
 import { XMLParser } from 'fast-xml-parser';
 
-// https://docs.bnbchain.org/greenfield-docs/docs/api/storgae-provider-rest/verify_permission
+// https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/storage-provider-rest-api/verify_permission.md
 export const parseVerifyPermissionResponse = async (data: string) => {
   const xmlParser = new XMLParser({
     parseTagValue: false,