diff --git a/404.html b/404.html index 1ba44c72..22f5fe7c 100644 --- a/404.html +++ b/404.html @@ -4,8 +4,8 @@ Greenfield JavaScript SDK - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/api/account/index.html b/api/account/index.html index f8f8504a..0d0e384a 100644 --- a/api/account/index.html +++ b/api/account/index.html @@ -4,8 +4,8 @@ Account | Greenfield JavaScript SDK - - + +
Skip to main content

Account

getAccount Query​

diff --git a/api/api-overview/index.html b/api/api-overview/index.html index 30907c18..6dbd6056 100644 --- a/api/api-overview/index.html +++ b/api/api-overview/index.html @@ -4,8 +4,8 @@ Overview | Greenfield JavaScript SDK - - + +

Overview

The SDK contains three APIs:

diff --git a/api/bucket/index.html b/api/bucket/index.html index a5622c61..ac92f8f5 100644 --- a/api/bucket/index.html +++ b/api/bucket/index.html @@ -4,76 +4,76 @@ Bucket | Greenfield JavaScript SDK - - + +

Bucket

createBucket Storage Provider Tx​

Create a new bucket in greenfield. This API sends a request to the storage provider to get approval for creating bucket and sends the createBucket transaction to the Greenfield.

paramsdescription
bucketNamebucket name
creatorcreator account address
visibilityVisibilityType
chargedReadQuotadefines the traffic quota that you read from primary sp
spInfoprimary sp address
paymentAddresspayment address
authTypeAuthType
-
example
const tx = await client.bucket.createBucket(
  {
    bucketName: 'bucket_name',
    creator: address,
    visibility: 'VISIBILITY_TYPE_PUBLIC_READ',
    chargedReadQuota: '0',
    spInfo: {
      primarySpAddress: 'primary_sp_address',
    },
    paymentAddress: address,
  },
  {
    type: 'EDDSA',
    domain: window.location.origin,
    seed: offChainData.seedString,
    address,
  },
);
+
const tx = await client.bucket.createBucket(
  {
    bucketName: 'bucket_name',
    creator: address,
    visibility: 'VISIBILITY_TYPE_PUBLIC_READ',
    chargedReadQuota: '0',
    spInfo: {
      primarySpAddress: 'primary_sp_address',
    },
    paymentAddress: address,
  },
  {
    type: 'EDDSA',
    domain: window.location.origin,
    seed: offChainData.seedString,
    address,
  },
);

deleteBucket Tx​

Send DeleteBucket msg to greenfield chain and return txn hash.

paramsdescription
bucketNameThe name of the bucket to be deleted
operatoroperator account address
-
example
const tx = await client.bucket.deleteBucket({
  bucketName: bucketName,
  operator: address,
});
+
Browser | Nodejs
const tx = await client.bucket.deleteBucket({
  bucketName: bucketName,
  operator: address,
});
tip

This is only construct tx, next need simulate and broadcast

deleteBucketPolicy Tx​

Delete the bucket policy of the principal.

paramsdescription
operator
bucketNameThe bucket name identifies the bucket
principalAddrPrincipal define the roles that can grant permissions
principalTypePrincipalType refers to the identity type of system users or entities.
-
example
const tx = await client.bucket.deleteBucketPolicy(
  address,
  bucketName,
  address,
  'PRINCIPAL_TYPE_GNFD_ACCOUNT',
);
+
Browser | Nodejs
const tx = await client.bucket.deleteBucketPolicy(
  address,
  bucketName,
  address,
  'PRINCIPAL_TYPE_GNFD_ACCOUNT',
);
tip

This is only construct tx, next need simulate and broadcast

getBucketMeta Storage Provider​

This API is used to get bucket meta by bucket name.

paramsdescription
bucketNamebucket name
-
example
const bucketInfo = await client.bucket.getBucketMeta({
  bucketName,
});
+
Browser | Nodejs
const bucketInfo = await client.bucket.getBucketMeta({
  bucketName,
});

getBucketPolicy Query​

Get the bucket policy info of the user specified by principalAddr.

-
example
import { GRNToString, newBucketGRN } from '@bnb-chain/greenfield-js-sdk';
await client.bucket.getBucketPolicy({
  resource: GRNToString(newBucketGRN(bucketName)),
  principalAddress: '0x00..',
});
+
Browser | Nodejs
import { GRNToString, newBucketGRN } from '@bnb-chain/greenfield-js-sdk';
await client.bucket.getBucketPolicy({
  resource: GRNToString(newBucketGRN(bucketName)),
  principalAddress: '0x00..',
});

getBucketReadQuota Storage Provider​

Query the quota info of the specific bucket of current month.

paramsdescription
bucketNamebucket name
authTypeAuthType
-
example
await client.bucket.getBucketReadQuota(
  {
    bucketName,
  },
  {
    type: 'EDDSA',
    seed: offChainData.seedString,
    domain: window.location.origin,
    address,
  },
);
+
const tx = await client.bucket.getBucketReadQuota(
  {
    bucketName,
  },
  {
    type: 'EDDSA',
    seed: offChainData.seedString,
    domain: window.location.origin,
    address,
  },
);

headBucket Query​

query the bucketInfo on chain, return the bucket info if exists.

paramsdescription
bucketNamebucket name
-
example
const bucketInfo = await client.bucket.headBucket(bucketName);
+
Browser | Nodejs
const bucketInfo = await client.bucket.headBucket(bucketName);

headBucketById Query​

paramsdescription
bucketIdbucket id
-
example
const bucketInfo = await client.bucket.headBucketById(bucketId);
+
Browser | Nodejs
const bucketInfo = await client.bucket.headBucketById(bucketId);

headBucketExtra Query​

Queries a bucket extra info (with gvg bindings and price time) with specify name.

paramsdescription
bucketNamebucket name
-
example
const bucketInfo = await client.bucket.headBucketExtra(bucketName);
+
Browser | Nodejs
const bucketInfo = await client.bucket.headBucketExtra(bucketName);

listBucketReadRecords Storage Provider​

List the download record info of the specific bucket of the current month.

paramsdescription
bucketNamebucket name
authTypeAuthType
-
example
await client.bucket.listBucketReadRecords(
  {
    bucketName,
    startTimeStamp,
    endTimeStamp,
    maxRecords: 1000,
  },
  {
    type: 'EDDSA',
    domain: window.location.origin,
    seed: offChainData.seedString,
    address,
  },
);
+
const tx = await client.bucket.listBucketReadRecords(
  {
    bucketName,
    startTimeStamp,
    endTimeStamp,
    maxRecords: 1000,
  },
  {
    type: 'EDDSA',
    domain: window.location.origin,
    seed: offChainData.seedString,
    address,
  },
);

listBuckets Storage Provider​

Lists the bucket info of the user.

paramsdescription
addressuser account
-
example
const res = await client.bucket.listBuckets({
  address,
});
+
Browser | Nodejs
const res = await client.bucket.listBuckets({
  address,
});

listBucketsByIds Storage Provider​

Lists the bucket info of the user.

paramsdescription
idsbucket ids array
-
example
await client.bucket.listBucketsByIds({
  ids: ['1', '2'],
});
+
Browser | Nodejs
await client.bucket.listBucketsByIds({
  ids: ['1', '2'],
});

listBucketsByPaymentAccount Storage Provider​

List bucket info by payment account.

paramsdescription
paymentAccountpayment account address
-
example
const res = await client.bucket.listBucketsByPaymentAccount({
  paymentAccount: '0x00...',
});
+
Browser | Nodejs
const res = await client.bucket.listBucketsByPaymentAccount({
  paymentAccount: '0x00...',
});

putBucketPolicy Tx​

Apply bucket policy to the principal, return the txn hash.

paramsdescription
bucketNamebucket name
statementsPolicies outline the specific details of permissions, including the Effect, ActionList, and Resources.
principalIndicates the marshaled principal content of greenfield permission types, users can generate it by NewPrincipalWithAccount or NewPrincipalWithGroupId method.
-
example
import { GRNToString, newBucketGRN, PermissionTypes } from '@bnb-chain/greenfield-js-sdk';
const statement: PermissionTypes.Statement = {
  effect: PermissionTypes.Effect.EFFECT_ALLOW,
  actions: [PermissionTypes.ActionType.ACTION_UPDATE_BUCKET_INFO],
  resources: [GRNToString(newBucketGRN(bucketName))],
};
const tx = await client.bucket.putBucketPolicy(bucketName, {
  operator: address,
  statements: [statement],
  principal: {
    type: PermissionTypes.PrincipalType.PRINCIPAL_TYPE_GNFD_ACCOUNT,
    value: '0x0000000000000000000000000000000000000001',
  },
});
+
Browser | Nodejs
import { GRNToString, newBucketGRN, PermissionTypes } from '@bnb-chain/greenfield-js-sdk';
const statement: PermissionTypes.Statement = {
  effect: PermissionTypes.Effect.EFFECT_ALLOW,
  actions: [PermissionTypes.ActionType.ACTION_UPDATE_BUCKET_INFO],
  resources: [GRNToString(newBucketGRN(bucketName))],
};
const tx = await client.bucket.putBucketPolicy(bucketName, {
  operator: address,
  statements: [statement],
  principal: {
    type: PermissionTypes.PrincipalType.PRINCIPAL_TYPE_GNFD_ACCOUNT,
    value: '0x0000000000000000000000000000000000000001',
  },
});
tip

This is only construct tx, next need simulate and broadcast

updateBucketInfo Tx​

Update the bucket meta on chain, including read quota, payment address or visibility. It will send the MsgUpdateBucketInfo msg to greenfield to update the meta.

paramsdescription
bucketNamebucket name
operatoroperator account address
visibilityVisibilityType
paymentAddresspayment address
chargedReadQuotadefines the traffic quota that you read from primary sp
-
example
await client.bucket.updateBucketInfo({
  bucketName: bucketName,
  operator: address,
  visibility: 1,
  paymentAddress: address,
  chargedReadQuota: '100',
});
+
Browser | Nodejs
await client.bucket.updateBucketInfo({
  bucketName: bucketName,
  operator: address,
  visibility: 1,
  paymentAddress: address,
  chargedReadQuota: '100',
});
tip

This is only construct tx, next need simulate and broadcast

diff --git a/api/crosschain/index.html b/api/crosschain/index.html index 1bf7d7fe..ac885c9e 100644 --- a/api/crosschain/index.html +++ b/api/crosschain/index.html @@ -4,8 +4,8 @@ Crosschain | Greenfield JavaScript SDK - - + +

Crosschain

getChannelSendSequence Query​

diff --git a/api/feegrant/index.html b/api/feegrant/index.html index 1f2bf412..d9ffc2cc 100644 --- a/api/feegrant/index.html +++ b/api/feegrant/index.html @@ -4,8 +4,8 @@ Feegrant | Greenfield JavaScript SDK - - + +

Feegrant

grantAllowance Tx​

diff --git a/api/gashub/index.html b/api/gashub/index.html index f1bf02d4..1e52b2ed 100644 --- a/api/gashub/index.html +++ b/api/gashub/index.html @@ -4,8 +4,8 @@ Gashub | Greenfield JavaScript SDK - - + +

Gashub

getMsgGasParams Query​

diff --git a/api/group/index.html b/api/group/index.html index b417bd2c..55ace8e8 100644 --- a/api/group/index.html +++ b/api/group/index.html @@ -4,8 +4,8 @@ Group | Greenfield JavaScript SDK - - + +

Group

createGroup Tx​

diff --git a/api/object/index.html b/api/object/index.html index af8d4992..83be0228 100644 --- a/api/object/index.html +++ b/api/object/index.html @@ -4,8 +4,8 @@ Object | Greenfield JavaScript SDK - - + +

Object

cancelCreateObject Tx​

diff --git a/api/payment/index.html b/api/payment/index.html index d838a547..882858c9 100644 --- a/api/payment/index.html +++ b/api/payment/index.html @@ -4,8 +4,8 @@ Payment | Greenfield JavaScript SDK - - + +

Payment

getStreamRecord Query​

diff --git a/api/sp/index.html b/api/sp/index.html index a00ad455..e0d15b7c 100644 --- a/api/sp/index.html +++ b/api/sp/index.html @@ -4,8 +4,8 @@ Sp | Greenfield JavaScript SDK - - + +

Sp

getStorageProviders Query​

diff --git a/api/virtual-group/index.html b/api/virtual-group/index.html index 863ce2b6..f0142a41 100644 --- a/api/virtual-group/index.html +++ b/api/virtual-group/index.html @@ -4,8 +4,8 @@ VirtualGroup | Greenfield JavaScript SDK - - + +

VirtualGroup

getGlobalVirtualGroup Query​

diff --git a/assets/js/469c860f.008a2764.js b/assets/js/469c860f.008a2764.js new file mode 100644 index 00000000..e02e3bfa --- /dev/null +++ b/assets/js/469c860f.008a2764.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkgreenfield_js_sdk_docs=self.webpackChunkgreenfield_js_sdk_docs||[]).push([[87],{8695:(e,t,n)=>{n.d(t,{ZP:()=>c});var s=n(5250),r=n(1118);function i(e){const t={a:"a",admonition:"admonition",p:"p",...(0,r.a)(),...e.components};return(0,s.jsx)(t.admonition,{type:"tip",children:(0,s.jsxs)(t.p,{children:["This is only ",(0,s.jsx)(t.a,{href:"/client/tx-client",children:"construct"})," tx, next need ",(0,s.jsx)(t.a,{href:"/client/tx-client#simulate",children:"simulate"})," and\n",(0,s.jsx)(t.a,{href:"/client/tx-client#broadcast",children:"broadcast"})]})})}function c(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},9258:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>o,default:()=>j,frontMatter:()=>l,metadata:()=>h,toc:()=>p});var s=n(5250),r=n(1118),i=n(2),c=n(186),a=n(7482),d=n(8695);const l={id:"bucket",title:"Bucket"},o=void 0,h={id:"api/bucket",title:"Bucket",description:"createBucket",source:"@site/docs/api/bucket.mdx",sourceDirName:"api",slug:"/api/bucket",permalink:"/greenfield-js-sdk/api/bucket",draft:!1,unlisted:!1,editUrl:"https://github.com/bnb-chain/greenfield-js-sdk/tree/main/doc-site/docs/api/bucket.mdx",tags:[],version:"current",frontMatter:{id:"bucket",title:"Bucket"},sidebar:"GettingStartSidebar",previous:{title:"Account",permalink:"/greenfield-js-sdk/api/account"},next:{title:"Crosschain",permalink:"/greenfield-js-sdk/api/crosschain"}},u={},p=[{value:"createBucket ",id:"createbucket--",level:2},{value:"deleteBucket ",id:"deletebucket-",level:2},{value:"deleteBucketPolicy ",id:"deletebucketpolicy-",level:2},{value:"getBucketMeta ",id:"getbucketmeta-",level:2},{value:"getBucketPolicy ",id:"getbucketpolicy-",level:2},{value:"getBucketReadQuota ",id:"getbucketreadquota-",level:2},{value:"headBucket ",id:"headbucket-",level:2},{value:"headBucketById ",id:"headbucketbyid-",level:2},{value:"headBucketExtra ",id:"headbucketextra-",level:2},{value:"listBucketReadRecords ",id:"listbucketreadrecords-",level:2},{value:"listBuckets ",id:"listbuckets-",level:2},{value:"listBucketsByIds ",id:"listbucketsbyids-",level:2},{value:"listBucketsByPaymentAccount ",id:"listbucketsbypaymentaccount-",level:2},{value:"putBucketPolicy ",id:"putbucketpolicy-",level:2},{value:"updateBucketInfo ",id:"updatebucketinfo-",level:2}];function x(e){const t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.h2,{id:"createbucket--",children:["createBucket ",(0,s.jsx)(a.Z,{type:"Storage Provider"})," ",(0,s.jsx)(a.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Create a new bucket in greenfield. This API sends a request to the storage provider to get approval\nfor creating bucket and sends the createBucket transaction to the Greenfield."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"creator"}),(0,s.jsx)(t.td,{children:"creator account address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"visibility"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/visibility",children:"VisibilityType"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"chargedReadQuota"}),(0,s.jsx)(t.td,{children:"defines the traffic quota that you read from primary sp"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"spInfo"}),(0,s.jsx)(t.td,{children:"primary sp address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"paymentAddress"}),(0,s.jsx)(t.td,{children:"payment address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,s.jsxs)(i.Z,{groupId:"example",children:[(0,s.jsx)(c.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"const tx = await client.bucket.createBucket(\n {\n bucketName: 'bucket_name',\n creator: address,\n visibility: 'VISIBILITY_TYPE_PUBLIC_READ',\n chargedReadQuota: '0',\n spInfo: {\n primarySpAddress: 'primary_sp_address',\n },\n paymentAddress: address,\n },\n // highlight-start\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(c.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"const createBucketTx = await client.bucket.createBucket(\n {\n bucketName: bucketName,\n creator: ACCOUNT_ADDRESS,\n visibility: 'VISIBILITY_TYPE_PUBLIC_READ',\n chargedReadQuota: '0',\n spInfo: {\n primarySpAddress: spInfo.primarySpAddress,\n },\n paymentAddress: ACCOUNT_ADDRESS,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsxs)(t.h2,{id:"deletebucket-",children:["deleteBucket ",(0,s.jsx)(a.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Send DeleteBucket msg to greenfield chain and return txn hash."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"The name of the bucket to be deleted"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"operator account address"})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"const tx = await client.bucket.deleteBucket({\n bucketName: bucketName,\n operator: address,\n});\n"})}),"\n",(0,s.jsx)(d.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"deletebucketpolicy-",children:["deleteBucketPolicy ",(0,s.jsx)(a.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Delete the bucket policy of the principal."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"The bucket name identifies the bucket"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principalAddr"}),(0,s.jsx)(t.td,{children:"Principal define the roles that can grant permissions"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principalType"}),(0,s.jsx)(t.td,{children:"PrincipalType refers to the identity type of system users or entities."})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"const tx = await client.bucket.deleteBucketPolicy(\n address,\n bucketName,\n address,\n 'PRINCIPAL_TYPE_GNFD_ACCOUNT',\n);\n"})}),"\n",(0,s.jsx)(d.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"getbucketmeta-",children:["getBucketMeta ",(0,s.jsx)(a.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"This API is used to get bucket meta by bucket name."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"const bucketInfo = await client.bucket.getBucketMeta({\n bucketName,\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"getbucketpolicy-",children:["getBucketPolicy ",(0,s.jsx)(a.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"Get the bucket policy info of the user specified by principalAddr."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"import { GRNToString, newBucketGRN } from '@bnb-chain/greenfield-js-sdk';\nawait client.bucket.getBucketPolicy({\n resource: GRNToString(newBucketGRN(bucketName)),\n principalAddress: '0x00..',\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"getbucketreadquota-",children:["getBucketReadQuota ",(0,s.jsx)(a.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Query the quota info of the specific bucket of current month."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,s.jsxs)(i.Z,{groupId:"example",children:[(0,s.jsx)(c.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"const tx = await client.bucket.getBucketReadQuota(\n {\n bucketName,\n },\n // highlight-start\n {\n type: 'EDDSA',\n seed: offChainData.seedString,\n domain: window.location.origin,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(c.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"const tx = await client.bucket.getBucketReadQuota(\n {\n bucketName,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsxs)(t.h2,{id:"headbucket-",children:["headBucket ",(0,s.jsx)(a.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"query the bucketInfo on chain, return the bucket info if exists."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"const bucketInfo = await client.bucket.headBucket(bucketName);\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"headbucketbyid-",children:["headBucketById ",(0,s.jsx)(a.Z,{type:"Query"})]}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketId"}),(0,s.jsx)(t.td,{children:"bucket id"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"const bucketInfo = await client.bucket.headBucketById(bucketId);\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"headbucketextra-",children:["headBucketExtra ",(0,s.jsx)(a.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"Queries a bucket extra info (with gvg bindings and price time) with specify name."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"const bucketInfo = await client.bucket.headBucketExtra(bucketName);\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listbucketreadrecords-",children:["listBucketReadRecords ",(0,s.jsx)(a.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"List the download record info of the specific bucket of the current month."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,s.jsxs)(i.Z,{groupId:"example",children:[(0,s.jsx)(c.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"const tx = await client.bucket.listBucketReadRecords(\n {\n bucketName,\n startTimeStamp,\n endTimeStamp,\n maxRecords: 1000,\n },\n // highlight-start\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(c.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"const tx = await client.bucket.listBucketReadRecords(\n {\n bucketName,\n startTimeStamp,\n endTimeStamp,\n maxRecords: 1000,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsxs)(t.h2,{id:"listbuckets-",children:["listBuckets ",(0,s.jsx)(a.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Lists the bucket info of the user."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"address"}),(0,s.jsx)(t.td,{children:"user account"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"const res = await client.bucket.listBuckets({\n address,\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listbucketsbyids-",children:["listBucketsByIds ",(0,s.jsx)(a.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Lists the bucket info of the user."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ids"}),(0,s.jsx)(t.td,{children:"bucket ids array"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"await client.bucket.listBucketsByIds({\n ids: ['1', '2'],\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listbucketsbypaymentaccount-",children:["listBucketsByPaymentAccount ",(0,s.jsx)(a.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"List bucket info by payment account."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"paymentAccount"}),(0,s.jsx)(t.td,{children:"payment account address"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"const res = await client.bucket.listBucketsByPaymentAccount({\n paymentAccount: '0x00...',\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"putbucketpolicy-",children:["putBucketPolicy ",(0,s.jsx)(a.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Apply bucket policy to the principal, return the txn hash."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"statements"}),(0,s.jsx)(t.td,{children:"Policies outline the specific details of permissions, including the Effect, ActionList, and Resources."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principal"}),(0,s.jsx)(t.td,{children:"Indicates the marshaled principal content of greenfield permission types, users can generate it by NewPrincipalWithAccount or NewPrincipalWithGroupId method."})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"import { GRNToString, newBucketGRN, PermissionTypes } from '@bnb-chain/greenfield-js-sdk';\nconst statement: PermissionTypes.Statement = {\n effect: PermissionTypes.Effect.EFFECT_ALLOW,\n actions: [PermissionTypes.ActionType.ACTION_UPDATE_BUCKET_INFO],\n resources: [GRNToString(newBucketGRN(bucketName))],\n};\nconst tx = await client.bucket.putBucketPolicy(bucketName, {\n operator: address,\n statements: [statement],\n principal: {\n type: PermissionTypes.PrincipalType.PRINCIPAL_TYPE_GNFD_ACCOUNT,\n value: '0x0000000000000000000000000000000000000001',\n },\n});\n"})}),"\n",(0,s.jsx)(d.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"updatebucketinfo-",children:["updateBucketInfo ",(0,s.jsx)(a.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Update the bucket meta on chain, including read quota, payment address or visibility. It will send\nthe MsgUpdateBucketInfo msg to greenfield to update the meta."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"operator account address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"visibility"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/visibility",children:"VisibilityType"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"paymentAddress"}),(0,s.jsx)(t.td,{children:"payment address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"chargedReadQuota"}),(0,s.jsx)(t.td,{children:"defines the traffic quota that you read from primary sp"})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser | Nodejs"',children:"await client.bucket.updateBucketInfo({\n bucketName: bucketName,\n operator: address,\n visibility: 1,\n paymentAddress: address,\n chargedReadQuota: '100',\n});\n"})}),"\n",(0,s.jsx)(d.ZP,{})]})}function j(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},7482:(e,t,n)=>{n.d(t,{Z:()=>r});n(79);var s=n(5250);const r=e=>{const{type:t}=e;return(0,s.jsx)("span",{style:{backgroundColor:"#25c2a0",borderRadius:"5px",color:"#FFF",fontSize:14,padding:2},children:t})}},186:(e,t,n)=>{n.d(t,{Z:()=>c});n(79);var s=n(3230);const r={tabItem:"tabItem_QnA5"};var i=n(5250);function c(e){let{children:t,hidden:n,className:c}=e;return(0,i.jsx)("div",{role:"tabpanel",className:(0,s.Z)(r.tabItem,c),hidden:n,children:t})}},2:(e,t,n)=>{n.d(t,{Z:()=>v});var s=n(79),r=n(3230),i=n(8153),c=n(7911),a=n(7962),d=n(1529),l=n(6922),o=n(5778);function h(e){return s.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,s.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function u(e){const{values:t,children:n}=e;return(0,s.useMemo)((()=>{const e=t??function(e){return h(e).map((e=>{let{props:{value:t,label:n,attributes:s,default:r}}=e;return{value:t,label:n,attributes:s,default:r}}))}(n);return function(e){const t=(0,l.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function p(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function x(e){let{queryString:t=!1,groupId:n}=e;const r=(0,c.k6)(),i=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,d._X)(i),(0,s.useCallback)((e=>{if(!i)return;const t=new URLSearchParams(r.location.search);t.set(i,e),r.replace({...r.location,search:t.toString()})}),[i,r])]}function j(e){const{defaultValue:t,queryString:n=!1,groupId:r}=e,i=u(e),[c,d]=(0,s.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!p({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const s=n.find((e=>e.default))??n[0];if(!s)throw new Error("Unexpected error: 0 tabValues");return s.value}({defaultValue:t,tabValues:i}))),[l,h]=x({queryString:n,groupId:r}),[j,b]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[r,i]=(0,o.Nk)(n);return[r,(0,s.useCallback)((e=>{n&&i.set(e)}),[n,i])]}({groupId:r}),m=(()=>{const e=l??j;return p({value:e,tabValues:i})?e:null})();(0,a.Z)((()=>{m&&d(m)}),[m]);return{selectedValue:c,selectValue:(0,s.useCallback)((e=>{if(!p({value:e,tabValues:i}))throw new Error(`Can't select invalid tab value=${e}`);d(e),h(e),b(e)}),[h,b,i]),tabValues:i}}var b=n(908);const m={tabList:"tabList_rv84",tabItem:"tabItem_thon"};var y=n(5250);function k(e){let{className:t,block:n,selectedValue:s,selectValue:c,tabValues:a}=e;const d=[],{blockElementScrollPositionUntilNextRender:l}=(0,i.o5)(),o=e=>{const t=e.currentTarget,n=d.indexOf(t),r=a[n].value;r!==s&&(l(t),c(r))},h=e=>{let t=null;switch(e.key){case"Enter":o(e);break;case"ArrowRight":{const n=d.indexOf(e.currentTarget)+1;t=d[n]??d[0];break}case"ArrowLeft":{const n=d.indexOf(e.currentTarget)-1;t=d[n]??d[d.length-1];break}}t?.focus()};return(0,y.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.Z)("tabs",{"tabs--block":n},t),children:a.map((e=>{let{value:t,label:n,attributes:i}=e;return(0,y.jsx)("li",{role:"tab",tabIndex:s===t?0:-1,"aria-selected":s===t,ref:e=>d.push(e),onKeyDown:h,onClick:o,...i,className:(0,r.Z)("tabs__item",m.tabItem,i?.className,{"tabs__item--active":s===t}),children:n??t},t)}))})}function g(e){let{lazy:t,children:n,selectedValue:r}=e;const i=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){const e=i.find((e=>e.props.value===r));return e?(0,s.cloneElement)(e,{className:"margin-top--md"}):null}return(0,y.jsx)("div",{className:"margin-top--md",children:i.map(((e,t)=>(0,s.cloneElement)(e,{key:t,hidden:e.props.value!==r})))})}function f(e){const t=j(e);return(0,y.jsxs)("div",{className:(0,r.Z)("tabs-container",m.tabList),children:[(0,y.jsx)(k,{...e,...t}),(0,y.jsx)(g,{...e,...t})]})}function v(e){const t=(0,b.Z)();return(0,y.jsx)(f,{...e,children:h(e.children)},String(t))}},1118:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>c});var s=n(79);const r={},i=s.createContext(r);function c(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/469c860f.e106fe16.js b/assets/js/469c860f.e106fe16.js deleted file mode 100644 index 19678e27..00000000 --- a/assets/js/469c860f.e106fe16.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkgreenfield_js_sdk_docs=self.webpackChunkgreenfield_js_sdk_docs||[]).push([[87],{8695:(e,t,s)=>{s.d(t,{ZP:()=>d});var n=s(5250),i=s(1118);function c(e){const t={a:"a",admonition:"admonition",p:"p",...(0,i.a)(),...e.components};return(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["This is only ",(0,n.jsx)(t.a,{href:"/client/tx-client",children:"construct"})," tx, next need ",(0,n.jsx)(t.a,{href:"/client/tx-client#simulate",children:"simulate"})," and\n",(0,n.jsx)(t.a,{href:"/client/tx-client#broadcast",children:"broadcast"})]})})}function d(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},9258:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>h,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>l,toc:()=>x});var n=s(5250),i=s(1118),c=s(7482),d=s(8695);const r={id:"bucket",title:"Bucket"},a=void 0,l={id:"api/bucket",title:"Bucket",description:"createBucket",source:"@site/docs/api/bucket.mdx",sourceDirName:"api",slug:"/api/bucket",permalink:"/greenfield-js-sdk/api/bucket",draft:!1,unlisted:!1,editUrl:"https://github.com/bnb-chain/greenfield-js-sdk/tree/main/doc-site/docs/api/bucket.mdx",tags:[],version:"current",frontMatter:{id:"bucket",title:"Bucket"},sidebar:"GettingStartSidebar",previous:{title:"Account",permalink:"/greenfield-js-sdk/api/account"},next:{title:"Crosschain",permalink:"/greenfield-js-sdk/api/crosschain"}},h={},x=[{value:"createBucket ",id:"createbucket--",level:2},{value:"deleteBucket ",id:"deletebucket-",level:2},{value:"deleteBucketPolicy ",id:"deletebucketpolicy-",level:2},{value:"getBucketMeta ",id:"getbucketmeta-",level:2},{value:"getBucketPolicy ",id:"getbucketpolicy-",level:2},{value:"getBucketReadQuota ",id:"getbucketreadquota-",level:2},{value:"headBucket ",id:"headbucket-",level:2},{value:"headBucketById ",id:"headbucketbyid-",level:2},{value:"headBucketExtra ",id:"headbucketextra-",level:2},{value:"listBucketReadRecords ",id:"listbucketreadrecords-",level:2},{value:"listBuckets ",id:"listbuckets-",level:2},{value:"listBucketsByIds ",id:"listbucketsbyids-",level:2},{value:"listBucketsByPaymentAccount ",id:"listbucketsbypaymentaccount-",level:2},{value:"putBucketPolicy ",id:"putbucketpolicy-",level:2},{value:"updateBucketInfo ",id:"updatebucketinfo-",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(t.h2,{id:"createbucket--",children:["createBucket ",(0,n.jsx)(c.Z,{type:"Storage Provider"})," ",(0,n.jsx)(c.Z,{type:"Tx"})]}),"\n",(0,n.jsx)(t.p,{children:"Create a new bucket in greenfield. This API sends a request to the storage provider to get approval\nfor creating bucket and sends the createBucket transaction to the Greenfield."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"bucket name"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"creator"}),(0,n.jsx)(t.td,{children:"creator account address"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"visibility"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/types/visibility",children:"VisibilityType"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"chargedReadQuota"}),(0,n.jsx)(t.td,{children:"defines the traffic quota that you read from primary sp"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"spInfo"}),(0,n.jsx)(t.td,{children:"primary sp address"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"paymentAddress"}),(0,n.jsx)(t.td,{children:"payment address"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"authType"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const tx = await client.bucket.createBucket(\n {\n bucketName: 'bucket_name',\n creator: address,\n visibility: 'VISIBILITY_TYPE_PUBLIC_READ',\n chargedReadQuota: '0',\n spInfo: {\n primarySpAddress: 'primary_sp_address',\n },\n paymentAddress: address,\n },\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n);\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"deletebucket-",children:["deleteBucket ",(0,n.jsx)(c.Z,{type:"Tx"})]}),"\n",(0,n.jsx)(t.p,{children:"Send DeleteBucket msg to greenfield chain and return txn hash."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"The name of the bucket to be deleted"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"operator"}),(0,n.jsx)(t.td,{children:"operator account address"})]})]})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const tx = await client.bucket.deleteBucket({\n bucketName: bucketName,\n operator: address,\n});\n"})}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsxs)(t.h2,{id:"deletebucketpolicy-",children:["deleteBucketPolicy ",(0,n.jsx)(c.Z,{type:"Tx"})]}),"\n",(0,n.jsx)(t.p,{children:"Delete the bucket policy of the principal."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"operator"}),(0,n.jsx)(t.td,{})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"The bucket name identifies the bucket"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"principalAddr"}),(0,n.jsx)(t.td,{children:"Principal define the roles that can grant permissions"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"principalType"}),(0,n.jsx)(t.td,{children:"PrincipalType refers to the identity type of system users or entities."})]})]})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const tx = await client.bucket.deleteBucketPolicy(\n address,\n bucketName,\n address,\n 'PRINCIPAL_TYPE_GNFD_ACCOUNT',\n);\n"})}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsxs)(t.h2,{id:"getbucketmeta-",children:["getBucketMeta ",(0,n.jsx)(c.Z,{type:"Storage Provider"})]}),"\n",(0,n.jsx)(t.p,{children:"This API is used to get bucket meta by bucket name."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"bucket name"})]})})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const bucketInfo = await client.bucket.getBucketMeta({\n bucketName,\n});\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"getbucketpolicy-",children:["getBucketPolicy ",(0,n.jsx)(c.Z,{type:"Query"})]}),"\n",(0,n.jsx)(t.p,{children:"Get the bucket policy info of the user specified by principalAddr."}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"import { GRNToString, newBucketGRN } from '@bnb-chain/greenfield-js-sdk';\nawait client.bucket.getBucketPolicy({\n resource: GRNToString(newBucketGRN(bucketName)),\n principalAddress: '0x00..',\n});\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"getbucketreadquota-",children:["getBucketReadQuota ",(0,n.jsx)(c.Z,{type:"Storage Provider"})]}),"\n",(0,n.jsx)(t.p,{children:"Query the quota info of the specific bucket of current month."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"bucket name"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"authType"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.bucket.getBucketReadQuota(\n {\n bucketName,\n },\n {\n type: 'EDDSA',\n seed: offChainData.seedString,\n domain: window.location.origin,\n address,\n },\n);\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"headbucket-",children:["headBucket ",(0,n.jsx)(c.Z,{type:"Query"})]}),"\n",(0,n.jsx)(t.p,{children:"query the bucketInfo on chain, return the bucket info if exists."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"bucket name"})]})})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const bucketInfo = await client.bucket.headBucket(bucketName);\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"headbucketbyid-",children:["headBucketById ",(0,n.jsx)(c.Z,{type:"Query"})]}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketId"}),(0,n.jsx)(t.td,{children:"bucket id"})]})})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const bucketInfo = await client.bucket.headBucketById(bucketId);\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"headbucketextra-",children:["headBucketExtra ",(0,n.jsx)(c.Z,{type:"Query"})]}),"\n",(0,n.jsx)(t.p,{children:"Queries a bucket extra info (with gvg bindings and price time) with specify name."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"bucket name"})]})})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const bucketInfo = await client.bucket.headBucketExtra(bucketName);\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"listbucketreadrecords-",children:["listBucketReadRecords ",(0,n.jsx)(c.Z,{type:"Storage Provider"})]}),"\n",(0,n.jsx)(t.p,{children:"List the download record info of the specific bucket of the current month."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"bucket name"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"authType"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.bucket.listBucketReadRecords(\n {\n bucketName,\n startTimeStamp,\n endTimeStamp,\n maxRecords: 1000,\n },\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n);\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"listbuckets-",children:["listBuckets ",(0,n.jsx)(c.Z,{type:"Storage Provider"})]}),"\n",(0,n.jsx)(t.p,{children:"Lists the bucket info of the user."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"address"}),(0,n.jsx)(t.td,{children:"user account"})]})})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const res = await client.bucket.listBuckets({\n address,\n});\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"listbucketsbyids-",children:["listBucketsByIds ",(0,n.jsx)(c.Z,{type:"Storage Provider"})]}),"\n",(0,n.jsx)(t.p,{children:"Lists the bucket info of the user."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"ids"}),(0,n.jsx)(t.td,{children:"bucket ids array"})]})})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.bucket.listBucketsByIds({\n ids: ['1', '2'],\n});\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"listbucketsbypaymentaccount-",children:["listBucketsByPaymentAccount ",(0,n.jsx)(c.Z,{type:"Storage Provider"})]}),"\n",(0,n.jsx)(t.p,{children:"List bucket info by payment account."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"paymentAccount"}),(0,n.jsx)(t.td,{children:"payment account address"})]})})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const res = await client.bucket.listBucketsByPaymentAccount({\n paymentAccount: '0x00...',\n});\n"})}),"\n",(0,n.jsxs)(t.h2,{id:"putbucketpolicy-",children:["putBucketPolicy ",(0,n.jsx)(c.Z,{type:"Tx"})]}),"\n",(0,n.jsx)(t.p,{children:"Apply bucket policy to the principal, return the txn hash."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"bucket name"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"statements"}),(0,n.jsx)(t.td,{children:"Policies outline the specific details of permissions, including the Effect, ActionList, and Resources."})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"principal"}),(0,n.jsx)(t.td,{children:"Indicates the marshaled principal content of greenfield permission types, users can generate it by NewPrincipalWithAccount or NewPrincipalWithGroupId method."})]})]})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"import { GRNToString, newBucketGRN, PermissionTypes } from '@bnb-chain/greenfield-js-sdk';\nconst statement: PermissionTypes.Statement = {\n effect: PermissionTypes.Effect.EFFECT_ALLOW,\n actions: [PermissionTypes.ActionType.ACTION_UPDATE_BUCKET_INFO],\n resources: [GRNToString(newBucketGRN(bucketName))],\n};\nconst tx = await client.bucket.putBucketPolicy(bucketName, {\n operator: address,\n statements: [statement],\n principal: {\n type: PermissionTypes.PrincipalType.PRINCIPAL_TYPE_GNFD_ACCOUNT,\n value: '0x0000000000000000000000000000000000000001',\n },\n});\n"})}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsxs)(t.h2,{id:"updatebucketinfo-",children:["updateBucketInfo ",(0,n.jsx)(c.Z,{type:"Tx"})]}),"\n",(0,n.jsx)(t.p,{children:"Update the bucket meta on chain, including read quota, payment address or visibility. It will send\nthe MsgUpdateBucketInfo msg to greenfield to update the meta."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"params"}),(0,n.jsx)(t.th,{children:"description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"bucketName"}),(0,n.jsx)(t.td,{children:"bucket name"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"operator"}),(0,n.jsx)(t.td,{children:"operator account address"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"visibility"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/types/visibility",children:"VisibilityType"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"paymentAddress"}),(0,n.jsx)(t.td,{children:"payment address"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"chargedReadQuota"}),(0,n.jsx)(t.td,{children:"defines the traffic quota that you read from primary sp"})]})]})]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.bucket.updateBucketInfo({\n bucketName: bucketName,\n operator: address,\n visibility: 1,\n paymentAddress: address,\n chargedReadQuota: '100',\n});\n"})}),"\n",(0,n.jsx)(d.ZP,{})]})}function p(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},7482:(e,t,s)=>{s.d(t,{Z:()=>i});s(79);var n=s(5250);const i=e=>{const{type:t}=e;return(0,n.jsx)("span",{style:{backgroundColor:"#25c2a0",borderRadius:"5px",color:"#FFF",fontSize:14,padding:2},children:t})}},1118:(e,t,s)=>{s.d(t,{Z:()=>r,a:()=>d});var n=s(79);const i={},c=n.createContext(i);function d(e){const t=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),n.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b8570a6.6242da4c.js b/assets/js/5b8570a6.6242da4c.js deleted file mode 100644 index 72a8abd4..00000000 --- a/assets/js/5b8570a6.6242da4c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkgreenfield_js_sdk_docs=self.webpackChunkgreenfield_js_sdk_docs||[]).push([[426],{8695:(e,t,n)=>{n.d(t,{ZP:()=>c});var s=n(5250),r=n(1118);function i(e){const t={a:"a",admonition:"admonition",p:"p",...(0,r.a)(),...e.components};return(0,s.jsx)(t.admonition,{type:"tip",children:(0,s.jsxs)(t.p,{children:["This is only ",(0,s.jsx)(t.a,{href:"/client/tx-client",children:"construct"})," tx, next need ",(0,s.jsx)(t.a,{href:"/client/tx-client#simulate",children:"simulate"})," and\n",(0,s.jsx)(t.a,{href:"/client/tx-client#broadcast",children:"broadcast"})]})})}function c(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},9283:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>o,default:()=>b,frontMatter:()=>d,metadata:()=>h,toc:()=>x});var s=n(5250),r=n(1118),i=n(7482),c=n(8695),l=n(2),a=n(186);const d={id:"object",title:"Object"},o=void 0,h={id:"api/object",title:"Object",description:"cancelCreateObject",source:"@site/docs/api/object.mdx",sourceDirName:"api",slug:"/api/object",permalink:"/greenfield-js-sdk/api/object",draft:!1,unlisted:!1,editUrl:"https://github.com/bnb-chain/greenfield-js-sdk/tree/main/doc-site/docs/api/object.mdx",tags:[],version:"current",frontMatter:{id:"object",title:"Object"},sidebar:"GettingStartSidebar",previous:{title:"Group",permalink:"/greenfield-js-sdk/api/group"},next:{title:"Payment",permalink:"/greenfield-js-sdk/api/payment"}},j={},x=[{value:"cancelCreateObject ",id:"cancelcreateobject-",level:2},{value:"createFolder ",id:"createfolder--",level:2},{value:"createObject ",id:"createobject--",level:2},{value:"deleteObject ",id:"deleteobject-",level:2},{value:"deleteObjectPolicy ",id:"deleteobjectpolicy-",level:2},{value:"downloadFile ",id:"downloadfile-",level:2},{value:"getObjectPolicy ",id:"getobjectpolicy-",level:2},{value:"getObjectPreviewUrl ",id:"getobjectpreviewurl-",level:2},{value:"headObject ",id:"headobject-",level:2},{value:"headObjectById ",id:"headobjectbyid-",level:2},{value:"listObjects ",id:"listobjects-",level:2},{value:"listObjectsByIds ",id:"listobjectsbyids-",level:2},{value:"listObjectPolicies ",id:"listobjectpolicies-",level:2},{value:"putObjectPolicy ",id:"putobjectpolicy-",level:2},{value:"updateObjectInfo ",id:"updateobjectinfo-",level:2},{value:"uploadObject ",id:"uploadobject-",level:2}];function p(e){const t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.h2,{id:"cancelcreateobject-",children:["cancelCreateObject ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsxs)(t.p,{children:["Send ",(0,s.jsx)(t.code,{children:"CancelCreateObject"})," txn to greenfield chain."]}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"the account address of the operator"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"the name of the bucket"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"the name of the object"})]})]})]}),"\n",(0,s.jsxs)(t.h2,{id:"createfolder--",children:["createFolder ",(0,s.jsx)(i.Z,{type:"Storage Provider"})," ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Send create empty object txn to greenfield chain."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"creator"}),(0,s.jsx)(t.td,{children:"the creator of object"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,s.jsxs)(l.Z,{children:[(0,s.jsx)(a.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"const tx = await client.object.createFolder(\n {\n bucketName: createObjectInfo.bucketName,\n objectName: createObjectInfo.objectName + '/',\n creator: address,\n },\n // highlight-start\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(a.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"const tx = await client.object.createFolder(\n {\n bucketName: bucketName,\n objectName: objectName + '/',\n creator: ACCOUNT_ADDRESS,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"createobject--",children:["createObject ",(0,s.jsx)(i.Z,{type:"Storage Provider"})," ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Get approval of creating object and send createObject txn to greenfield chain."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"creator"}),(0,s.jsx)(t.td,{children:"the creator of object"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"visibility"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/visibility",children:"VisibilityType"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"fileType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/File/type",children:"file type"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"redundancyType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/redundancy",children:"RedundancyType"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"contentLength"}),(0,s.jsx)(t.td,{children:"file content length"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"expectCheckSums"}),(0,s.jsx)(t.td,{children:"file's expectCheckSums"})]})]})]}),"\n",(0,s.jsxs)(l.Z,{children:[(0,s.jsx)(a.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"// https://github.com/bnb-chain/greenfield-js-sdk/blob/main/examples/nextjs/src/components/object/create/index.tsx#L76-L95\nconst tx = await client.object.createObject(\n {\n bucketName: 'bucket_name',\n objectName: 'object_name',\n creator: '0x...',\n visibility: 'VISIBILITY_TYPE_PRIVATE',\n fileType: 'json',\n redundancyType: 'REDUNDANCY_EC_TYPE',\n contentLength: 13311,\n expectCheckSums: JSON.parse(expectCheckSums),\n },\n // highlight-start\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(a.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"// https://github.com/bnb-chain/greenfield-js-sdk/blob/main/examples/nodejs/cases/storage.js#L61-L76\nconst tx = await client.object.createObject(\n {\n bucketName: bucketName,\n objectName: objectName,\n creator: ACCOUNT_ADDRESS,\n visibility: 'VISIBILITY_TYPE_PRIVATE',\n fileType: fileType,\n redundancyType: 'REDUNDANCY_EC_TYPE',\n contentLength,\n expectCheckSums: JSON.parse(expectCheckSums),\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"deleteobject-",children:["deleteObject ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Send DeleteObject msg to greenfield chain and return txn hash."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"the account address of the operator who has the DeleteObject permission of the object to be deleted"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"the name of the bucket where the object which to be deleted is stored"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"the name of the object which to be deleted"})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser / Nodejs Example"',children:"const tx = await client.object.deleteObject({\n bucketName: 'bucket_name',\n objectName: 'object_name',\n operator: '0x000..',\n});\n"})}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"deleteobjectpolicy-",children:["deleteObjectPolicy ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Delete the object policy of the principal."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"the granter who grant the permission to another principal"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"the name of the bucket"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"the name of the object"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principalAddr"}),(0,s.jsx)(t.td,{children:"principal address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principal"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/principal",children:"PrincipalType"})})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser / Nodejs Example"',children:"const tx = await client.object.deleteObjectPolicy(\n '0x000..', // operator\n 'bucket_name', // bucket name\n 'object_name', // object name\n '0x000..', // principalAddr\n 'PRINCIPAL_TYPE_GNFD_GROUP', // PrincipalType\n);\n"})}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"downloadfile-",children:["downloadFile ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Download s3 object payload and return the related object info."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]})]})]}),"\n",(0,s.jsxs)(l.Z,{children:[(0,s.jsx)(a.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"await client.object.downloadFile(\n {\n bucketName,\n objectName,\n },\n // highlight-start\n {\n type: 'EDDSA',\n address,\n domain: window.location.origin,\n seed: offChainData.seedString,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(a.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"await client.object.downloadFile(\n {\n bucketName,\n objectName,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsxs)(t.h2,{id:"getobjectpolicy-",children:["getObjectPolicy ",(0,s.jsx)(i.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"Get the object policy info of the user specified by principalAddr."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principalAddr"}),(0,s.jsx)(t.td,{children:"principal address"})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const tx = await client.object.getObjectPolicy('bucket_name', 'object_name', '0x...');\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"getobjectpreviewurl-",children:["getObjectPreviewUrl ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Get the object preview url."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser"',children:"const res = await client.object.getObjectPreviewUrl(\n {\n bucketName: 'bucket_name',\n objectName: 'object_name',\n queryMap: {\n view: '1',\n 'X-Gnfd-User-Address': address,\n 'X-Gnfd-App-Domain': window.location.origin,\n 'X-Gnfd-Expiry-Timestamp': '2023-09-03T09%3A23%3A39Z',\n },\n },\n {\n type: 'EDDSA',\n address,\n domain: window.location.origin,\n seed: offChainData.seedString,\n },\n);\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"headobject-",children:["headObject ",(0,s.jsx)(i.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"Query the objectInfo on chain to check the object id, return the object info if exists."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.object.headObject(bucketName, objectName);\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"headobjectbyid-",children:["headObjectById ",(0,s.jsx)(i.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"Query the objectInfo on chain by object id, return the object info if exists."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.object.headObjectById('12');\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listobjects-",children:["listObjects ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Lists the object info of the bucket."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const res = await client.object.listObjects({\n bucketName,\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listobjectsbyids-",children:["listObjectsByIds ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"List objects by object ids."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ids"}),(0,s.jsx)(t.td,{children:"object ids array"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.object.listObjectsByIds({\n ids: ['1', '2'],\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listobjectpolicies-",children:["listObjectPolicies ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"List object policies by object info and action type."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"actionType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/action",children:"ActionType"})})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const res = await client.object.listObjectPolicies({\n bucketName: 'bucket_name',\n objectName: 'object_name',\n actionType: 'ACTION_GET_OBJECT',\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"putobjectpolicy-",children:["putObjectPolicy ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"operator address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principal"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/principal",children:"Principal"})})]})]})]}),"\n",(0,s.jsx)(t.p,{children:"Apply object policy to the principal, return the txn hash."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"import { PermissionTypes } from '@bnb-chain/greenfield-js-sdk';\nconst statement: PermissionTypes.Statement = {\n effect: PermissionTypes.Effect.EFFECT_ALLOW,\n actions: [PermissionTypes.ActionType.ACTION_GET_OBJECT],\n resources: [],\n};\nawait client.object.putObjectPolicy('bucket_name', 'object_name', {\n operator: '0x...',\n statements: [statement],\n principal: {\n type: PermissionTypes.PrincipalType.PRINCIPAL_TYPE_GNFD_ACCOUNT,\n value: '0x0000000000000000000000000000000000000001',\n },\n});\n"})}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"updateobjectinfo-",children:["updateObjectInfo ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Update object info by sending message to greenfield."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"operator address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"visibility"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/visibility",children:"VisibilityType"})})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const tx = await client.object.updateObjectInfo({\n bucketName: 'bucket_name',\n objectName: 'object_name',\n operator: '0x...',\n visibility: 'VISIBILITY_TYPE_PUBLIC_READ',\n});\n"})}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"uploadobject-",children:["uploadObject ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Uploading the object to bucket."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"body"}),(0,s.jsx)(t.td,{children:"file"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"txnHash"}),(0,s.jsxs)(t.td,{children:[(0,s.jsx)(t.a,{href:"#createobject",children:"createObject"})," 's hash"]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,s.jsxs)(l.Z,{children:[(0,s.jsx)(a.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"const uploadRes = await client.object.uploadObject(\n {\n bucketName: createObjectInfo.bucketName,\n objectName: createObjectInfo.objectName,\n body: file,\n txnHash: txHash,\n },\n // highlight-start\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(a.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"const uploadRes = await client.object.uploadObject(\n {\n bucketName: bucketName,\n objectName: objectName,\n body: fileBuffer,\n txnHash: createObjectTxRes.transactionHash,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]})]})}function b(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},7482:(e,t,n)=>{n.d(t,{Z:()=>r});n(79);var s=n(5250);const r=e=>{const{type:t}=e;return(0,s.jsx)("span",{style:{backgroundColor:"#25c2a0",borderRadius:"5px",color:"#FFF",fontSize:14,padding:2},children:t})}},186:(e,t,n)=>{n.d(t,{Z:()=>c});n(79);var s=n(3230);const r={tabItem:"tabItem_QnA5"};var i=n(5250);function c(e){let{children:t,hidden:n,className:c}=e;return(0,i.jsx)("div",{role:"tabpanel",className:(0,s.Z)(r.tabItem,c),hidden:n,children:t})}},2:(e,t,n)=>{n.d(t,{Z:()=>N});var s=n(79),r=n(3230),i=n(8153),c=n(7911),l=n(7962),a=n(1529),d=n(6922),o=n(5778);function h(e){return s.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,s.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function j(e){const{values:t,children:n}=e;return(0,s.useMemo)((()=>{const e=t??function(e){return h(e).map((e=>{let{props:{value:t,label:n,attributes:s,default:r}}=e;return{value:t,label:n,attributes:s,default:r}}))}(n);return function(e){const t=(0,d.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function x(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function p(e){let{queryString:t=!1,groupId:n}=e;const r=(0,c.k6)(),i=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,a._X)(i),(0,s.useCallback)((e=>{if(!i)return;const t=new URLSearchParams(r.location.search);t.set(i,e),r.replace({...r.location,search:t.toString()})}),[i,r])]}function b(e){const{defaultValue:t,queryString:n=!1,groupId:r}=e,i=j(e),[c,a]=(0,s.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!x({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const s=n.find((e=>e.default))??n[0];if(!s)throw new Error("Unexpected error: 0 tabValues");return s.value}({defaultValue:t,tabValues:i}))),[d,h]=p({queryString:n,groupId:r}),[b,u]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[r,i]=(0,o.Nk)(n);return[r,(0,s.useCallback)((e=>{n&&i.set(e)}),[n,i])]}({groupId:r}),m=(()=>{const e=d??b;return x({value:e,tabValues:i})?e:null})();(0,l.Z)((()=>{m&&a(m)}),[m]);return{selectedValue:c,selectValue:(0,s.useCallback)((e=>{if(!x({value:e,tabValues:i}))throw new Error(`Can't select invalid tab value=${e}`);a(e),h(e),u(e)}),[h,u,i]),tabValues:i}}var u=n(908);const m={tabList:"tabList_rv84",tabItem:"tabItem_thon"};var y=n(5250);function g(e){let{className:t,block:n,selectedValue:s,selectValue:c,tabValues:l}=e;const a=[],{blockElementScrollPositionUntilNextRender:d}=(0,i.o5)(),o=e=>{const t=e.currentTarget,n=a.indexOf(t),r=l[n].value;r!==s&&(d(t),c(r))},h=e=>{let t=null;switch(e.key){case"Enter":o(e);break;case"ArrowRight":{const n=a.indexOf(e.currentTarget)+1;t=a[n]??a[0];break}case"ArrowLeft":{const n=a.indexOf(e.currentTarget)-1;t=a[n]??a[a.length-1];break}}t?.focus()};return(0,y.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.Z)("tabs",{"tabs--block":n},t),children:l.map((e=>{let{value:t,label:n,attributes:i}=e;return(0,y.jsx)("li",{role:"tab",tabIndex:s===t?0:-1,"aria-selected":s===t,ref:e=>a.push(e),onKeyDown:h,onClick:o,...i,className:(0,r.Z)("tabs__item",m.tabItem,i?.className,{"tabs__item--active":s===t}),children:n??t},t)}))})}function f(e){let{lazy:t,children:n,selectedValue:r}=e;const i=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){const e=i.find((e=>e.props.value===r));return e?(0,s.cloneElement)(e,{className:"margin-top--md"}):null}return(0,y.jsx)("div",{className:"margin-top--md",children:i.map(((e,t)=>(0,s.cloneElement)(e,{key:t,hidden:e.props.value!==r})))})}function v(e){const t=b(e);return(0,y.jsxs)("div",{className:(0,r.Z)("tabs-container",m.tabList),children:[(0,y.jsx)(g,{...e,...t}),(0,y.jsx)(f,{...e,...t})]})}function N(e){const t=(0,u.Z)();return(0,y.jsx)(v,{...e,children:h(e.children)},String(t))}},1118:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>c});var s=n(79);const r={},i=s.createContext(r);function c(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b8570a6.f50cf435.js b/assets/js/5b8570a6.f50cf435.js new file mode 100644 index 00000000..a755cd86 --- /dev/null +++ b/assets/js/5b8570a6.f50cf435.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkgreenfield_js_sdk_docs=self.webpackChunkgreenfield_js_sdk_docs||[]).push([[426],{8695:(e,t,n)=>{n.d(t,{ZP:()=>c});var s=n(5250),r=n(1118);function i(e){const t={a:"a",admonition:"admonition",p:"p",...(0,r.a)(),...e.components};return(0,s.jsx)(t.admonition,{type:"tip",children:(0,s.jsxs)(t.p,{children:["This is only ",(0,s.jsx)(t.a,{href:"/client/tx-client",children:"construct"})," tx, next need ",(0,s.jsx)(t.a,{href:"/client/tx-client#simulate",children:"simulate"})," and\n",(0,s.jsx)(t.a,{href:"/client/tx-client#broadcast",children:"broadcast"})]})})}function c(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},9283:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>o,default:()=>b,frontMatter:()=>d,metadata:()=>h,toc:()=>x});var s=n(5250),r=n(1118),i=n(7482),c=n(8695),l=n(2),a=n(186);const d={id:"object",title:"Object"},o=void 0,h={id:"api/object",title:"Object",description:"cancelCreateObject",source:"@site/docs/api/object.mdx",sourceDirName:"api",slug:"/api/object",permalink:"/greenfield-js-sdk/api/object",draft:!1,unlisted:!1,editUrl:"https://github.com/bnb-chain/greenfield-js-sdk/tree/main/doc-site/docs/api/object.mdx",tags:[],version:"current",frontMatter:{id:"object",title:"Object"},sidebar:"GettingStartSidebar",previous:{title:"Group",permalink:"/greenfield-js-sdk/api/group"},next:{title:"Payment",permalink:"/greenfield-js-sdk/api/payment"}},j={},x=[{value:"cancelCreateObject ",id:"cancelcreateobject-",level:2},{value:"createFolder ",id:"createfolder--",level:2},{value:"createObject ",id:"createobject--",level:2},{value:"deleteObject ",id:"deleteobject-",level:2},{value:"deleteObjectPolicy ",id:"deleteobjectpolicy-",level:2},{value:"downloadFile ",id:"downloadfile-",level:2},{value:"getObjectPolicy ",id:"getobjectpolicy-",level:2},{value:"getObjectPreviewUrl ",id:"getobjectpreviewurl-",level:2},{value:"headObject ",id:"headobject-",level:2},{value:"headObjectById ",id:"headobjectbyid-",level:2},{value:"listObjects ",id:"listobjects-",level:2},{value:"listObjectsByIds ",id:"listobjectsbyids-",level:2},{value:"listObjectPolicies ",id:"listobjectpolicies-",level:2},{value:"putObjectPolicy ",id:"putobjectpolicy-",level:2},{value:"updateObjectInfo ",id:"updateobjectinfo-",level:2},{value:"uploadObject ",id:"uploadobject-",level:2}];function p(e){const t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.h2,{id:"cancelcreateobject-",children:["cancelCreateObject ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsxs)(t.p,{children:["Send ",(0,s.jsx)(t.code,{children:"CancelCreateObject"})," txn to greenfield chain."]}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"the account address of the operator"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"the name of the bucket"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"the name of the object"})]})]})]}),"\n",(0,s.jsxs)(t.h2,{id:"createfolder--",children:["createFolder ",(0,s.jsx)(i.Z,{type:"Storage Provider"})," ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Send create empty object txn to greenfield chain."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"creator"}),(0,s.jsx)(t.td,{children:"the creator of object"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,s.jsxs)(l.Z,{groupId:"example",children:[(0,s.jsx)(a.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"const tx = await client.object.createFolder(\n {\n bucketName: createObjectInfo.bucketName,\n objectName: createObjectInfo.objectName + '/',\n creator: address,\n },\n // highlight-start\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(a.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"const tx = await client.object.createFolder(\n {\n bucketName: bucketName,\n objectName: objectName + '/',\n creator: ACCOUNT_ADDRESS,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"createobject--",children:["createObject ",(0,s.jsx)(i.Z,{type:"Storage Provider"})," ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Get approval of creating object and send createObject txn to greenfield chain."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"creator"}),(0,s.jsx)(t.td,{children:"the creator of object"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"visibility"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/visibility",children:"VisibilityType"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"fileType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/File/type",children:"file type"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"redundancyType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/redundancy",children:"RedundancyType"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"contentLength"}),(0,s.jsx)(t.td,{children:"file content length"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"expectCheckSums"}),(0,s.jsx)(t.td,{children:"file's expectCheckSums"})]})]})]}),"\n",(0,s.jsxs)(l.Z,{groupId:"example",children:[(0,s.jsx)(a.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"// https://github.com/bnb-chain/greenfield-js-sdk/blob/main/examples/nextjs/src/components/object/create/index.tsx#L76-L95\nconst tx = await client.object.createObject(\n {\n bucketName: 'bucket_name',\n objectName: 'object_name',\n creator: '0x...',\n visibility: 'VISIBILITY_TYPE_PRIVATE',\n fileType: 'json',\n redundancyType: 'REDUNDANCY_EC_TYPE',\n contentLength: 13311,\n expectCheckSums: JSON.parse(expectCheckSums),\n },\n // highlight-start\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(a.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"// https://github.com/bnb-chain/greenfield-js-sdk/blob/main/examples/nodejs/cases/storage.js#L61-L76\nconst tx = await client.object.createObject(\n {\n bucketName: bucketName,\n objectName: objectName,\n creator: ACCOUNT_ADDRESS,\n visibility: 'VISIBILITY_TYPE_PRIVATE',\n fileType: fileType,\n redundancyType: 'REDUNDANCY_EC_TYPE',\n contentLength,\n expectCheckSums: JSON.parse(expectCheckSums),\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"deleteobject-",children:["deleteObject ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Send DeleteObject msg to greenfield chain and return txn hash."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"the account address of the operator who has the DeleteObject permission of the object to be deleted"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"the name of the bucket where the object which to be deleted is stored"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"the name of the object which to be deleted"})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser / Nodejs Example"',children:"const tx = await client.object.deleteObject({\n bucketName: 'bucket_name',\n objectName: 'object_name',\n operator: '0x000..',\n});\n"})}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"deleteobjectpolicy-",children:["deleteObjectPolicy ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Delete the object policy of the principal."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"the granter who grant the permission to another principal"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"the name of the bucket"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"the name of the object"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principalAddr"}),(0,s.jsx)(t.td,{children:"principal address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principal"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/principal",children:"PrincipalType"})})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser / Nodejs Example"',children:"const tx = await client.object.deleteObjectPolicy(\n '0x000..', // operator\n 'bucket_name', // bucket name\n 'object_name', // object name\n '0x000..', // principalAddr\n 'PRINCIPAL_TYPE_GNFD_GROUP', // PrincipalType\n);\n"})}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"downloadfile-",children:["downloadFile ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Download s3 object payload and return the related object info."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]})]})]}),"\n",(0,s.jsxs)(l.Z,{groupId:"example",children:[(0,s.jsx)(a.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"await client.object.downloadFile(\n {\n bucketName,\n objectName,\n },\n // highlight-start\n {\n type: 'EDDSA',\n address,\n domain: window.location.origin,\n seed: offChainData.seedString,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(a.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"await client.object.downloadFile(\n {\n bucketName,\n objectName,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]}),"\n",(0,s.jsxs)(t.h2,{id:"getobjectpolicy-",children:["getObjectPolicy ",(0,s.jsx)(i.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"Get the object policy info of the user specified by principalAddr."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principalAddr"}),(0,s.jsx)(t.td,{children:"principal address"})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const tx = await client.object.getObjectPolicy('bucket_name', 'object_name', '0x...');\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"getobjectpreviewurl-",children:["getObjectPreviewUrl ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Get the object preview url."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="Browser"',children:"const res = await client.object.getObjectPreviewUrl(\n {\n bucketName: 'bucket_name',\n objectName: 'object_name',\n queryMap: {\n view: '1',\n 'X-Gnfd-User-Address': address,\n 'X-Gnfd-App-Domain': window.location.origin,\n 'X-Gnfd-Expiry-Timestamp': '2023-09-03T09%3A23%3A39Z',\n },\n },\n {\n type: 'EDDSA',\n address,\n domain: window.location.origin,\n seed: offChainData.seedString,\n },\n);\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"headobject-",children:["headObject ",(0,s.jsx)(i.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"Query the objectInfo on chain to check the object id, return the object info if exists."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.object.headObject(bucketName, objectName);\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"headobjectbyid-",children:["headObjectById ",(0,s.jsx)(i.Z,{type:"Query"})]}),"\n",(0,s.jsx)(t.p,{children:"Query the objectInfo on chain by object id, return the object info if exists."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.object.headObjectById('12');\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listobjects-",children:["listObjects ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Lists the object info of the bucket."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const res = await client.object.listObjects({\n bucketName,\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listobjectsbyids-",children:["listObjectsByIds ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"List objects by object ids."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ids"}),(0,s.jsx)(t.td,{children:"object ids array"})]})})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"await client.object.listObjectsByIds({\n ids: ['1', '2'],\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"listobjectpolicies-",children:["listObjectPolicies ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"List object policies by object info and action type."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"actionType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/action",children:"ActionType"})})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const res = await client.object.listObjectPolicies({\n bucketName: 'bucket_name',\n objectName: 'object_name',\n actionType: 'ACTION_GET_OBJECT',\n});\n"})}),"\n",(0,s.jsxs)(t.h2,{id:"putobjectpolicy-",children:["putObjectPolicy ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"operator address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"principal"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/principal",children:"Principal"})})]})]})]}),"\n",(0,s.jsx)(t.p,{children:"Apply object policy to the principal, return the txn hash."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"import { PermissionTypes } from '@bnb-chain/greenfield-js-sdk';\nconst statement: PermissionTypes.Statement = {\n effect: PermissionTypes.Effect.EFFECT_ALLOW,\n actions: [PermissionTypes.ActionType.ACTION_GET_OBJECT],\n resources: [],\n};\nawait client.object.putObjectPolicy('bucket_name', 'object_name', {\n operator: '0x...',\n statements: [statement],\n principal: {\n type: PermissionTypes.PrincipalType.PRINCIPAL_TYPE_GNFD_ACCOUNT,\n value: '0x0000000000000000000000000000000000000001',\n },\n});\n"})}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"updateobjectinfo-",children:["updateObjectInfo ",(0,s.jsx)(i.Z,{type:"Tx"})]}),"\n",(0,s.jsx)(t.p,{children:"Update object info by sending message to greenfield."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"operator"}),(0,s.jsx)(t.td,{children:"operator address"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"visibility"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/types/visibility",children:"VisibilityType"})})]})]})]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",metastring:'title="example"',children:"const tx = await client.object.updateObjectInfo({\n bucketName: 'bucket_name',\n objectName: 'object_name',\n operator: '0x...',\n visibility: 'VISIBILITY_TYPE_PUBLIC_READ',\n});\n"})}),"\n",(0,s.jsx)(c.ZP,{}),"\n",(0,s.jsxs)(t.h2,{id:"uploadobject-",children:["uploadObject ",(0,s.jsx)(i.Z,{type:"Storage Provider"})]}),"\n",(0,s.jsx)(t.p,{children:"Uploading the object to bucket."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"params"}),(0,s.jsx)(t.th,{children:"description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"bucketName"}),(0,s.jsx)(t.td,{children:"bucket name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"objectName"}),(0,s.jsx)(t.td,{children:"object name"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"body"}),(0,s.jsx)(t.td,{children:"file"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"txnHash"}),(0,s.jsxs)(t.td,{children:[(0,s.jsx)(t.a,{href:"#createobject",children:"createObject"})," 's hash"]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"authType"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/client/sp-client#authtype",children:"AuthType"})})]})]})]}),"\n",(0,s.jsxs)(l.Z,{groupId:"example",children:[(0,s.jsx)(a.Z,{value:"Browser",label:"Browser",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-jsx",children:"const uploadRes = await client.object.uploadObject(\n {\n bucketName: createObjectInfo.bucketName,\n objectName: createObjectInfo.objectName,\n body: file,\n txnHash: txHash,\n },\n // highlight-start\n {\n type: 'EDDSA',\n domain: window.location.origin,\n seed: offChainData.seedString,\n address,\n },\n // highlight-end\n);\n"})})}),(0,s.jsx)(a.Z,{value:"Nodejs",label:"Nodejs",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-js",children:"const uploadRes = await client.object.uploadObject(\n {\n bucketName: bucketName,\n objectName: objectName,\n body: fileBuffer,\n txnHash: createObjectTxRes.transactionHash,\n },\n // highlight-start\n {\n type: 'ECDSA',\n privateKey: ACCOUNT_PRIVATEKEY,\n },\n // highlight-end\n);\n"})})})]})]})}function b(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},7482:(e,t,n)=>{n.d(t,{Z:()=>r});n(79);var s=n(5250);const r=e=>{const{type:t}=e;return(0,s.jsx)("span",{style:{backgroundColor:"#25c2a0",borderRadius:"5px",color:"#FFF",fontSize:14,padding:2},children:t})}},186:(e,t,n)=>{n.d(t,{Z:()=>c});n(79);var s=n(3230);const r={tabItem:"tabItem_QnA5"};var i=n(5250);function c(e){let{children:t,hidden:n,className:c}=e;return(0,i.jsx)("div",{role:"tabpanel",className:(0,s.Z)(r.tabItem,c),hidden:n,children:t})}},2:(e,t,n)=>{n.d(t,{Z:()=>N});var s=n(79),r=n(3230),i=n(8153),c=n(7911),l=n(7962),a=n(1529),d=n(6922),o=n(5778);function h(e){return s.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,s.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function j(e){const{values:t,children:n}=e;return(0,s.useMemo)((()=>{const e=t??function(e){return h(e).map((e=>{let{props:{value:t,label:n,attributes:s,default:r}}=e;return{value:t,label:n,attributes:s,default:r}}))}(n);return function(e){const t=(0,d.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function x(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function p(e){let{queryString:t=!1,groupId:n}=e;const r=(0,c.k6)(),i=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,a._X)(i),(0,s.useCallback)((e=>{if(!i)return;const t=new URLSearchParams(r.location.search);t.set(i,e),r.replace({...r.location,search:t.toString()})}),[i,r])]}function b(e){const{defaultValue:t,queryString:n=!1,groupId:r}=e,i=j(e),[c,a]=(0,s.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!x({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const s=n.find((e=>e.default))??n[0];if(!s)throw new Error("Unexpected error: 0 tabValues");return s.value}({defaultValue:t,tabValues:i}))),[d,h]=p({queryString:n,groupId:r}),[b,u]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[r,i]=(0,o.Nk)(n);return[r,(0,s.useCallback)((e=>{n&&i.set(e)}),[n,i])]}({groupId:r}),m=(()=>{const e=d??b;return x({value:e,tabValues:i})?e:null})();(0,l.Z)((()=>{m&&a(m)}),[m]);return{selectedValue:c,selectValue:(0,s.useCallback)((e=>{if(!x({value:e,tabValues:i}))throw new Error(`Can't select invalid tab value=${e}`);a(e),h(e),u(e)}),[h,u,i]),tabValues:i}}var u=n(908);const m={tabList:"tabList_rv84",tabItem:"tabItem_thon"};var y=n(5250);function g(e){let{className:t,block:n,selectedValue:s,selectValue:c,tabValues:l}=e;const a=[],{blockElementScrollPositionUntilNextRender:d}=(0,i.o5)(),o=e=>{const t=e.currentTarget,n=a.indexOf(t),r=l[n].value;r!==s&&(d(t),c(r))},h=e=>{let t=null;switch(e.key){case"Enter":o(e);break;case"ArrowRight":{const n=a.indexOf(e.currentTarget)+1;t=a[n]??a[0];break}case"ArrowLeft":{const n=a.indexOf(e.currentTarget)-1;t=a[n]??a[a.length-1];break}}t?.focus()};return(0,y.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.Z)("tabs",{"tabs--block":n},t),children:l.map((e=>{let{value:t,label:n,attributes:i}=e;return(0,y.jsx)("li",{role:"tab",tabIndex:s===t?0:-1,"aria-selected":s===t,ref:e=>a.push(e),onKeyDown:h,onClick:o,...i,className:(0,r.Z)("tabs__item",m.tabItem,i?.className,{"tabs__item--active":s===t}),children:n??t},t)}))})}function f(e){let{lazy:t,children:n,selectedValue:r}=e;const i=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){const e=i.find((e=>e.props.value===r));return e?(0,s.cloneElement)(e,{className:"margin-top--md"}):null}return(0,y.jsx)("div",{className:"margin-top--md",children:i.map(((e,t)=>(0,s.cloneElement)(e,{key:t,hidden:e.props.value!==r})))})}function v(e){const t=b(e);return(0,y.jsxs)("div",{className:(0,r.Z)("tabs-container",m.tabList),children:[(0,y.jsx)(g,{...e,...t}),(0,y.jsx)(f,{...e,...t})]})}function N(e){const t=(0,u.Z)();return(0,y.jsx)(v,{...e,children:h(e.children)},String(t))}},1118:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>c});var s=n(79);const r={},i=s.createContext(r);function c(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/95b97511.a2290297.js b/assets/js/95b97511.a2290297.js deleted file mode 100644 index d711bf07..00000000 --- a/assets/js/95b97511.a2290297.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkgreenfield_js_sdk_docs=self.webpackChunkgreenfield_js_sdk_docs||[]).push([[285],{5072:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>x,frontMatter:()=>l,metadata:()=>o,toc:()=>u});var a=n(5250),r=n(1118),s=n(2),i=n(186);const l={id:"tx-client",sidebar_position:1,title:"Tx Client"},c=void 0,o={id:"client/tx-client",title:"Tx Client",description:"About Tx",source:"@site/docs/client/tx-client.mdx",sourceDirName:"client",slug:"/client/tx-client",permalink:"/greenfield-js-sdk/client/tx-client",draft:!1,unlisted:!1,editUrl:"https://github.com/bnb-chain/greenfield-js-sdk/tree/main/doc-site/docs/client/tx-client.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"tx-client",sidebar_position:1,title:"Tx Client"},sidebar:"GettingStartSidebar",previous:{title:"Greenfield Client",permalink:"/greenfield-js-sdk/client/greenfield-client"},next:{title:"Query Client",permalink:"/greenfield-js-sdk/client/query-client"}},d={},u=[{value:"About Tx",id:"about-tx",level:2},{value:"simulate",id:"simulate",level:2},{value:"broadcast",id:"broadcast",level:2},{value:"Example",id:"example",level:2},{value:"1. construct a transaction",id:"1-construct-a-transaction",level:3},{value:"2. simulate",id:"2-simulate",level:3},{value:"3. broadcast",id:"3-broadcast",level:3}];function h(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h2,{id:"about-tx",children:"About Tx"}),"\n",(0,a.jsx)(t.p,{children:"A transaction contains at least:"}),"\n",(0,a.jsxs)(t.ol,{children:["\n",(0,a.jsx)(t.li,{children:"construct a transaction: The sdk already provides each transaction type"}),"\n",(0,a.jsxs)(t.li,{children:["simulate: ",(0,a.jsx)(t.a,{href:"#simulate",children:"txClient.simulate"})]}),"\n",(0,a.jsxs)(t.li,{children:["broadcast ",(0,a.jsx)(t.a,{href:"#broadcast",children:"txClient.broadcast"})]}),"\n"]}),"\n",(0,a.jsx)(t.h2,{id:"simulate",children:"simulate"}),"\n",(0,a.jsx)(t.p,{children:"Just Simulate a transaction and valid transaction."}),"\n",(0,a.jsxs)(t.table,{children:[(0,a.jsx)(t.thead,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.th,{children:"params"}),(0,a.jsx)(t.th,{children:"description"})]})}),(0,a.jsx)(t.tbody,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"denom"}),(0,a.jsx)(t.td,{children:"the coin denom to query balances for"})]})})]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-jsx",metastring:'title="simulate tx"',children:"// `tx` is a transaction constructed by the sdk\nconst simulateInfo = await tx.simulate({\n denom: 'BNB',\n});\n"})}),"\n",(0,a.jsx)(t.h2,{id:"broadcast",children:"broadcast"}),"\n",(0,a.jsx)(t.p,{children:"Broadcast the transaction to the chain."}),"\n",(0,a.jsxs)(t.table,{children:[(0,a.jsx)(t.thead,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.th,{children:"params"}),(0,a.jsx)(t.th,{children:"description"})]})}),(0,a.jsxs)(t.tbody,{children:[(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"denom"}),(0,a.jsx)(t.td,{children:"the coin denom to query balances for"})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"gasLimit"}),(0,a.jsxs)(t.td,{children:["can be set to any number, but not too small or the transaction may fail (recommended use ",(0,a.jsx)(t.code,{children:"simulateInfo.gasLimit"}),")"]})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"gasPrice"}),(0,a.jsx)(t.td,{children:"1 unit of Gas that the transaction sender is willing to pay."})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"payer"}),(0,a.jsx)(t.td,{children:"transaction sender"})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"granter"}),(0,a.jsxs)(t.td,{children:["transaction ganter (Generally empty ",(0,a.jsx)(t.code,{children:"''"}),")"]})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"signTypedDataCallback"}),(0,a.jsxs)(t.td,{children:["broadcast use ",(0,a.jsx)(t.code,{children:"window.ethereum"})," as signature provider by default."]})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"privateKey"}),(0,a.jsx)(t.td,{children:"If you broadcast in Nodejs, you can broadcast a tx by privateKey"})]})]})]}),"\n",(0,a.jsxs)(s.Z,{children:[(0,a.jsxs)(i.Z,{value:"Browser",label:"Browser",children:[(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-js",metastring:'title="broadcast tx"',children:"const broadcastRes = await transferTx.broadcast({\n denom: 'BNB',\n gasLimit: Number(simulateInfo.gasLimit),\n gasPrice: simulateInfo.gasPrice,\n payer: '0x0000000000000000000000000000000000000001',\n granter: '',\n});\n"})}),(0,a.jsxs)(t.admonition,{type:"tip",children:[(0,a.jsxs)(t.p,{children:["If you want to use others wallet, you can set ",(0,a.jsx)(t.code,{children:"signTypedDataCallback"}),":"]}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-js",children:"// trustwallet:\nconst broadcastRes = await transferTx.broadcast({\n // ...\n signTypedDataCallback: async (addr: string, message: string) => {\n return await window.trustwallet.request({\n method: 'eth_signTypedData_v4',\n params: [addr, message],\n });\n },\n});\n"})})]})]}),(0,a.jsxs)(i.Z,{value:"Nodejs",label:"Nodejs",children:[(0,a.jsxs)(t.p,{children:["If you broadcast in Nodejs, you can broadcast a tx by ",(0,a.jsx)(t.code,{children:"privateKey"}),":"]}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-js",metastring:'title="broadcast tx"',children:"const broadcastRes = await transferTx.broadcast({\n denom: 'BNB',\n gasLimit: Number(simulateInfo.gasLimit),\n gasPrice: simulateInfo.gasPrice,\n payer: '0x0000000000000000000000000000000000000001',\n granter: '',\n // highlight-start\n privateKey: '0x.......',\n // highlight-end\n});\n"})})]})]}),"\n",(0,a.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,a.jsxs)(t.p,{children:["Take ",(0,a.jsx)(t.code,{children:"transfer"})," tx as a complete example:"]}),"\n",(0,a.jsx)(t.h3,{id:"1-construct-a-transaction",children:"1. construct a transaction"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-jsx",metastring:'title="construct tx"',children:"const transferTx = await client.account.transfer({\n fromAddress: address,\n toAddress: transferInfo.to,\n amount: [\n {\n denom: 'BNB',\n amount: '1000000000',\n },\n ],\n});\n"})}),"\n",(0,a.jsx)(t.h3,{id:"2-simulate",children:"2. simulate"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-jsx",metastring:'title="simulate tx"',children:"const simulateInfo = await transferTx.simulate({\n denom: 'BNB',\n});\n"})}),"\n",(0,a.jsx)(t.h3,{id:"3-broadcast",children:"3. broadcast"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-jsx",metastring:'title="broadcast tx"',children:"const broadcastRes = await transferTx.broadcast({\n denom: 'BNB',\n gasLimit: Number(simulateInfo.gasLimit),\n gasPrice: simulateInfo.gasPrice,\n payer: address,\n granter: '',\n});\n"})})]})}function x(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},186:(e,t,n)=>{n.d(t,{Z:()=>i});n(79);var a=n(3230);const r={tabItem:"tabItem_QnA5"};var s=n(5250);function i(e){let{children:t,hidden:n,className:i}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,a.Z)(r.tabItem,i),hidden:n,children:t})}},2:(e,t,n)=>{n.d(t,{Z:()=>w});var a=n(79),r=n(3230),s=n(8153),i=n(7911),l=n(7962),c=n(1529),o=n(6922),d=n(5778);function u(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function h(e){const{values:t,children:n}=e;return(0,a.useMemo)((()=>{const e=t??function(e){return u(e).map((e=>{let{props:{value:t,label:n,attributes:a,default:r}}=e;return{value:t,label:n,attributes:a,default:r}}))}(n);return function(e){const t=(0,o.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function x(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function m(e){let{queryString:t=!1,groupId:n}=e;const r=(0,i.k6)(),s=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,c._X)(s),(0,a.useCallback)((e=>{if(!s)return;const t=new URLSearchParams(r.location.search);t.set(s,e),r.replace({...r.location,search:t.toString()})}),[s,r])]}function b(e){const{defaultValue:t,queryString:n=!1,groupId:r}=e,s=h(e),[i,c]=(0,a.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!x({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const a=n.find((e=>e.default))??n[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:t,tabValues:s}))),[o,u]=m({queryString:n,groupId:r}),[b,p]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[r,s]=(0,d.Nk)(n);return[r,(0,a.useCallback)((e=>{n&&s.set(e)}),[n,s])]}({groupId:r}),f=(()=>{const e=o??b;return x({value:e,tabValues:s})?e:null})();(0,l.Z)((()=>{f&&c(f)}),[f]);return{selectedValue:i,selectValue:(0,a.useCallback)((e=>{if(!x({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);c(e),u(e),p(e)}),[u,p,s]),tabValues:s}}var p=n(908);const f={tabList:"tabList_rv84",tabItem:"tabItem_thon"};var j=n(5250);function g(e){let{className:t,block:n,selectedValue:a,selectValue:i,tabValues:l}=e;const c=[],{blockElementScrollPositionUntilNextRender:o}=(0,s.o5)(),d=e=>{const t=e.currentTarget,n=c.indexOf(t),r=l[n].value;r!==a&&(o(t),i(r))},u=e=>{let t=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":{const n=c.indexOf(e.currentTarget)+1;t=c[n]??c[0];break}case"ArrowLeft":{const n=c.indexOf(e.currentTarget)-1;t=c[n]??c[c.length-1];break}}t?.focus()};return(0,j.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.Z)("tabs",{"tabs--block":n},t),children:l.map((e=>{let{value:t,label:n,attributes:s}=e;return(0,j.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>c.push(e),onKeyDown:u,onClick:d,...s,className:(0,r.Z)("tabs__item",f.tabItem,s?.className,{"tabs__item--active":a===t}),children:n??t},t)}))})}function v(e){let{lazy:t,children:n,selectedValue:r}=e;const s=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){const e=s.find((e=>e.props.value===r));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,j.jsx)("div",{className:"margin-top--md",children:s.map(((e,t)=>(0,a.cloneElement)(e,{key:t,hidden:e.props.value!==r})))})}function y(e){const t=b(e);return(0,j.jsxs)("div",{className:(0,r.Z)("tabs-container",f.tabList),children:[(0,j.jsx)(g,{...e,...t}),(0,j.jsx)(v,{...e,...t})]})}function w(e){const t=(0,p.Z)();return(0,j.jsx)(y,{...e,children:u(e.children)},String(t))}},1118:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>i});var a=n(79);const r={},s=a.createContext(r);function i(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/95b97511.b707c920.js b/assets/js/95b97511.b707c920.js new file mode 100644 index 00000000..95932ff1 --- /dev/null +++ b/assets/js/95b97511.b707c920.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkgreenfield_js_sdk_docs=self.webpackChunkgreenfield_js_sdk_docs||[]).push([[285],{5072:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>u});var a=n(5250),r=n(1118),s=n(2),i=n(186);const l={id:"tx-client",sidebar_position:1,title:"Tx Client"},c=void 0,o={id:"client/tx-client",title:"Tx Client",description:"About Tx",source:"@site/docs/client/tx-client.mdx",sourceDirName:"client",slug:"/client/tx-client",permalink:"/greenfield-js-sdk/client/tx-client",draft:!1,unlisted:!1,editUrl:"https://github.com/bnb-chain/greenfield-js-sdk/tree/main/doc-site/docs/client/tx-client.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"tx-client",sidebar_position:1,title:"Tx Client"},sidebar:"GettingStartSidebar",previous:{title:"Greenfield Client",permalink:"/greenfield-js-sdk/client/greenfield-client"},next:{title:"Query Client",permalink:"/greenfield-js-sdk/client/query-client"}},d={},u=[{value:"About Tx",id:"about-tx",level:2},{value:"simulate",id:"simulate",level:2},{value:"broadcast",id:"broadcast",level:2},{value:"Example",id:"example",level:2},{value:"1. construct a transaction",id:"1-construct-a-transaction",level:3},{value:"2. simulate",id:"2-simulate",level:3},{value:"3. broadcast",id:"3-broadcast",level:3}];function h(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h2,{id:"about-tx",children:"About Tx"}),"\n",(0,a.jsx)(t.p,{children:"A transaction contains at least:"}),"\n",(0,a.jsxs)(t.ol,{children:["\n",(0,a.jsx)(t.li,{children:"construct a transaction: The sdk already provides each transaction type"}),"\n",(0,a.jsxs)(t.li,{children:["simulate: ",(0,a.jsx)(t.a,{href:"#simulate",children:"txClient.simulate"})]}),"\n",(0,a.jsxs)(t.li,{children:["broadcast ",(0,a.jsx)(t.a,{href:"#broadcast",children:"txClient.broadcast"})]}),"\n"]}),"\n",(0,a.jsx)(t.h2,{id:"simulate",children:"simulate"}),"\n",(0,a.jsx)(t.p,{children:"Just Simulate a transaction and valid transaction."}),"\n",(0,a.jsxs)(t.table,{children:[(0,a.jsx)(t.thead,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.th,{children:"params"}),(0,a.jsx)(t.th,{children:"description"})]})}),(0,a.jsx)(t.tbody,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"denom"}),(0,a.jsx)(t.td,{children:"the coin denom to query balances for"})]})})]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-jsx",metastring:'title="simulate tx"',children:"// `tx` is a transaction constructed by the sdk\nconst simulateInfo = await tx.simulate({\n denom: 'BNB',\n});\n"})}),"\n",(0,a.jsx)(t.h2,{id:"broadcast",children:"broadcast"}),"\n",(0,a.jsx)(t.p,{children:"Broadcast the transaction to the chain."}),"\n",(0,a.jsxs)(t.table,{children:[(0,a.jsx)(t.thead,{children:(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.th,{children:"params"}),(0,a.jsx)(t.th,{children:"description"})]})}),(0,a.jsxs)(t.tbody,{children:[(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"denom"}),(0,a.jsx)(t.td,{children:"the coin denom to query balances for"})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"gasLimit"}),(0,a.jsxs)(t.td,{children:["can be set to any number, but not too small or the transaction may fail (recommended use ",(0,a.jsx)(t.code,{children:"simulateInfo.gasLimit"}),")"]})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"gasPrice"}),(0,a.jsx)(t.td,{children:"1 unit of Gas that the transaction sender is willing to pay."})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"payer"}),(0,a.jsx)(t.td,{children:"transaction sender"})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"granter"}),(0,a.jsxs)(t.td,{children:["transaction ganter (Generally empty ",(0,a.jsx)(t.code,{children:"''"}),")"]})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"signTypedDataCallback"}),(0,a.jsxs)(t.td,{children:["broadcast use ",(0,a.jsx)(t.code,{children:"window.ethereum"})," as signature provider by default."]})]}),(0,a.jsxs)(t.tr,{children:[(0,a.jsx)(t.td,{children:"privateKey"}),(0,a.jsx)(t.td,{children:"If you broadcast in Nodejs, you can broadcast a tx by privateKey"})]})]})]}),"\n",(0,a.jsxs)(s.Z,{children:[(0,a.jsx)(i.Z,{value:"Browser",label:"Browser",children:(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-js",metastring:'title="broadcast tx"',children:"const broadcastRes = await transferTx.broadcast({\n denom: 'BNB',\n gasLimit: Number(simulateInfo.gasLimit),\n gasPrice: simulateInfo.gasPrice,\n payer: '0x0000000000000000000000000000000000000001',\n granter: '',\n // highlight-start\n // If you want to use others wallet(such as trustwallet), you can set `signTypedDataCallback`:\n signTypedDataCallback: async (addr: string, message: string) => {\n return await window.trustwallet.request({\n method: 'eth_signTypedData_v4',\n params: [addr, message],\n });\n },\n // highlight-end\n});\n"})})}),(0,a.jsxs)(i.Z,{value:"Nodejs",label:"Nodejs",children:[(0,a.jsxs)(t.p,{children:["If you broadcast in Nodejs, you can broadcast a tx by ",(0,a.jsx)(t.code,{children:"privateKey"}),":"]}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-js",metastring:'title="broadcast tx"',children:"const broadcastRes = await transferTx.broadcast({\n denom: 'BNB',\n gasLimit: Number(simulateInfo.gasLimit),\n gasPrice: simulateInfo.gasPrice,\n payer: '0x0000000000000000000000000000000000000001',\n granter: '',\n // highlight-start\n privateKey: '0x.......',\n // highlight-end\n});\n"})})]})]}),"\n",(0,a.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,a.jsxs)(t.p,{children:["Take ",(0,a.jsx)(t.code,{children:"transfer"})," tx as a complete example:"]}),"\n",(0,a.jsx)(t.h3,{id:"1-construct-a-transaction",children:"1. construct a transaction"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-jsx",metastring:'title="construct tx"',children:"const transferTx = await client.account.transfer({\n fromAddress: address,\n toAddress: transferInfo.to,\n amount: [\n {\n denom: 'BNB',\n amount: '1000000000',\n },\n ],\n});\n"})}),"\n",(0,a.jsx)(t.h3,{id:"2-simulate",children:"2. simulate"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-jsx",metastring:'title="simulate tx"',children:"const simulateInfo = await transferTx.simulate({\n denom: 'BNB',\n});\n"})}),"\n",(0,a.jsx)(t.h3,{id:"3-broadcast",children:"3. broadcast"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-jsx",metastring:'title="broadcast tx"',children:"const broadcastRes = await transferTx.broadcast({\n denom: 'BNB',\n gasLimit: Number(simulateInfo.gasLimit),\n gasPrice: simulateInfo.gasPrice,\n payer: address,\n granter: '',\n});\n"})})]})}function m(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},186:(e,t,n)=>{n.d(t,{Z:()=>i});n(79);var a=n(3230);const r={tabItem:"tabItem_QnA5"};var s=n(5250);function i(e){let{children:t,hidden:n,className:i}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,a.Z)(r.tabItem,i),hidden:n,children:t})}},2:(e,t,n)=>{n.d(t,{Z:()=>w});var a=n(79),r=n(3230),s=n(8153),i=n(7911),l=n(7962),c=n(1529),o=n(6922),d=n(5778);function u(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function h(e){const{values:t,children:n}=e;return(0,a.useMemo)((()=>{const e=t??function(e){return u(e).map((e=>{let{props:{value:t,label:n,attributes:a,default:r}}=e;return{value:t,label:n,attributes:a,default:r}}))}(n);return function(e){const t=(0,o.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function m(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function x(e){let{queryString:t=!1,groupId:n}=e;const r=(0,i.k6)(),s=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,c._X)(s),(0,a.useCallback)((e=>{if(!s)return;const t=new URLSearchParams(r.location.search);t.set(s,e),r.replace({...r.location,search:t.toString()})}),[s,r])]}function b(e){const{defaultValue:t,queryString:n=!1,groupId:r}=e,s=h(e),[i,c]=(0,a.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!m({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const a=n.find((e=>e.default))??n[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:t,tabValues:s}))),[o,u]=x({queryString:n,groupId:r}),[b,p]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[r,s]=(0,d.Nk)(n);return[r,(0,a.useCallback)((e=>{n&&s.set(e)}),[n,s])]}({groupId:r}),f=(()=>{const e=o??b;return m({value:e,tabValues:s})?e:null})();(0,l.Z)((()=>{f&&c(f)}),[f]);return{selectedValue:i,selectValue:(0,a.useCallback)((e=>{if(!m({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);c(e),u(e),p(e)}),[u,p,s]),tabValues:s}}var p=n(908);const f={tabList:"tabList_rv84",tabItem:"tabItem_thon"};var j=n(5250);function g(e){let{className:t,block:n,selectedValue:a,selectValue:i,tabValues:l}=e;const c=[],{blockElementScrollPositionUntilNextRender:o}=(0,s.o5)(),d=e=>{const t=e.currentTarget,n=c.indexOf(t),r=l[n].value;r!==a&&(o(t),i(r))},u=e=>{let t=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":{const n=c.indexOf(e.currentTarget)+1;t=c[n]??c[0];break}case"ArrowLeft":{const n=c.indexOf(e.currentTarget)-1;t=c[n]??c[c.length-1];break}}t?.focus()};return(0,j.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.Z)("tabs",{"tabs--block":n},t),children:l.map((e=>{let{value:t,label:n,attributes:s}=e;return(0,j.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>c.push(e),onKeyDown:u,onClick:d,...s,className:(0,r.Z)("tabs__item",f.tabItem,s?.className,{"tabs__item--active":a===t}),children:n??t},t)}))})}function v(e){let{lazy:t,children:n,selectedValue:r}=e;const s=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){const e=s.find((e=>e.props.value===r));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,j.jsx)("div",{className:"margin-top--md",children:s.map(((e,t)=>(0,a.cloneElement)(e,{key:t,hidden:e.props.value!==r})))})}function y(e){const t=b(e);return(0,j.jsxs)("div",{className:(0,r.Z)("tabs-container",f.tabList),children:[(0,j.jsx)(g,{...e,...t}),(0,j.jsx)(v,{...e,...t})]})}function w(e){const t=(0,p.Z)();return(0,j.jsx)(y,{...e,children:u(e.children)},String(t))}},1118:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>i});var a=n(79);const r={},s=a.createContext(r);function i(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/main.2c272bb5.js b/assets/js/main.2c272bb5.js new file mode 100644 index 00000000..11c5233f --- /dev/null +++ b/assets/js/main.2c272bb5.js @@ -0,0 +1,2 @@ +/*! For license information please see main.2c272bb5.js.LICENSE.txt */ +(self.webpackChunkgreenfield_js_sdk_docs=self.webpackChunkgreenfield_js_sdk_docs||[]).push([[179],{2657:(e,t,n)=>{var r={"./":9637};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=2657},1724:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});n(79);var r=n(3425),a=n.n(r),o=n(6887);const i={"0335934b":[()=>n.e(122).then(n.t.bind(n,3678,19)),"~docs/default/category-greenfield-js-sdk-gettingstartsidebar-category-clients-e99.json",3678],"037672a1":[()=>n.e(981).then(n.bind(n,2909)),"@site/docs/types/visibility.mdx",2909],"053d6f47":[()=>Promise.all([n.e(721),n.e(83)]).then(n.bind(n,1466)),"@site/docs/getting-started/quick-start.mdx",1466],"07a5499a":[()=>n.e(863).then(n.t.bind(n,3769,19)),"/home/runner/work/greenfield-js-sdk/greenfield-js-sdk/doc-site/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],"143f79dd":[()=>n.e(284).then(n.bind(n,4442)),"@site/docs/types/principal.mdx",4442],"14eb3368":[()=>Promise.all([n.e(532),n.e(817)]).then(n.bind(n,7492)),"@theme/DocCategoryGeneratedIndexPage",7492],17896441:[()=>Promise.all([n.e(532),n.e(918)]).then(n.bind(n,1456)),"@theme/DocItem",1456],"1a061de6":[()=>n.e(69).then(n.t.bind(n,2501,19)),"~docs/default/category-greenfield-js-sdk-gettingstartsidebar-category-types-8b6.json",2501],"209101c8":[()=>n.e(888).then(n.bind(n,9882)),"@site/docs/client/greenfield.mdx",9882],"23206eaf":[()=>n.e(982).then(n.bind(n,1369)),"@site/docs/client/query-client.mdx",1369],"2ae18816":[()=>n.e(36).then(n.bind(n,6178)),"@site/docs/types/redundancy.mdx",6178],"2dbd2a66":[()=>n.e(380).then(n.bind(n,4374)),"@site/docs/types/action.mdx",4374],"3be563aa":[()=>n.e(728).then(n.bind(n,3658)),"@site/docs/types/timestamp.mdx",3658],"3beee713":[()=>n.e(266).then(n.bind(n,5655)),"@site/docs/api/gashub.mdx",5655],"43352d7e":[()=>n.e(135).then(n.bind(n,1962)),"@site/docs/api/virtualGroup.mdx",1962],"45e29900":[()=>Promise.all([n.e(532),n.e(656)]).then(n.bind(n,1891)),"@site/docs/api/group.mdx",1891],"469c860f":[()=>Promise.all([n.e(532),n.e(87)]).then(n.bind(n,9258)),"@site/docs/api/bucket.mdx",9258],"5b8570a6":[()=>Promise.all([n.e(532),n.e(426)]).then(n.bind(n,9283)),"@site/docs/api/object.mdx",9283],"5e95c892":[()=>n.e(661).then(n.bind(n,4735)),"@theme/DocsRoot",4735],"6e6aa86b":[()=>n.e(594).then(n.bind(n,9518)),"@site/docs/api/overview.mdx",9518],"6f233aca":[()=>Promise.all([n.e(532),n.e(411)]).then(n.bind(n,9627)),"@site/docs/client/sp-client.mdx",9627],"7a96ca3d":[()=>n.e(835).then(n.bind(n,9136)),"@site/docs/getting-started/overview.md",9136],"7bcd82cb":[()=>n.e(660).then(n.bind(n,1394)),"@site/docs/api/crosschain.mdx",1394],"830818e7":[()=>n.e(582).then(n.bind(n,1834)),"@site/docs/api/sp.mdx",1834],"932f6281":[()=>n.e(483).then(n.bind(n,7849)),"@site/docs/api/account.mdx",7849],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"95b97511":[()=>Promise.all([n.e(532),n.e(285)]).then(n.bind(n,5072)),"@site/docs/client/tx-client.mdx",5072],"9cf271e3":[()=>n.e(514).then(n.bind(n,1750)),"@site/docs/constants/msg-type-url.mdx",1750],a7bd4aaa:[()=>n.e(518).then(n.bind(n,3164)),"@theme/DocVersionRoot",3164],a94703ab:[()=>Promise.all([n.e(532),n.e(368)]).then(n.bind(n,6772)),"@theme/DocRoot",6772],ab701698:[()=>n.e(922).then(n.bind(n,9394)),"@site/docs/api/payment.mdx",9394],c4eca321:[()=>n.e(907).then(n.bind(n,2363)),"@site/docs/types/pagination.mdx",2363],ce5f3660:[()=>n.e(969).then(n.bind(n,2239)),"@site/docs/types/coin.mdx",2239],dd1e196a:[()=>n.e(920).then(n.t.bind(n,4490,19)),"~docs/default/category-greenfield-js-sdk-gettingstartsidebar-category-getting-started-365.json",4490],e397e610:[()=>Promise.all([n.e(532),n.e(556)]).then(n.bind(n,3245)),"@site/docs/getting-started/install.mdx",3245],ebfe9495:[()=>n.e(2).then(n.t.bind(n,9259,19)),"~docs/default/category-greenfield-js-sdk-gettingstartsidebar-category-apis-4f5.json",9259],ef037885:[()=>n.e(30).then(n.bind(n,6472)),"@site/docs/api/feegrant.mdx",6472]};var l=n(5250);function s(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,l.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,l.jsx)("p",{children:String(t)}),(0,l.jsx)("div",{children:(0,l.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,l.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,l.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,l.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,l.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var u=n(6943),c=n(4931);function d(e,t){if("*"===e)return a()({loading:s,loader:()=>n.e(895).then(n.bind(n,1895)),modules:["@theme/NotFound"],webpack:()=>[1895],render(e,t){const n=e.default;return(0,l.jsx)(c.z,{value:{plugin:{name:"native",id:"default"}},children:(0,l.jsx)(n,{...t})})}});const r=o[`${e}-${t}`],d={},p=[],f=[],g=(0,u.Z)(r);return Object.entries(g).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],p.push(r[1]),f.push(r[2]))})),a().Map({loading:s,loader:d,modules:p,webpack:()=>f,render(t,n){const a=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const o=r.default;if(!o)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof o&&"function"!=typeof o||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{o[e]=r[e]}));let i=a;const l=n.split(".");l.slice(0,-1).forEach((e=>{i=i[e]})),i[l[l.length-1]]=o}));const o=a.__comp;delete a.__comp;const i=a.__context;return delete a.__context,(0,l.jsx)(c.z,{value:i,children:(0,l.jsx)(o,{...a,...n})})}})}const p=[{path:"/greenfield-js-sdk/",component:d("/greenfield-js-sdk/","8d6"),routes:[{path:"/greenfield-js-sdk/",component:d("/greenfield-js-sdk/","28c"),routes:[{path:"/greenfield-js-sdk/",component:d("/greenfield-js-sdk/","c06"),routes:[{path:"/greenfield-js-sdk/api/account",component:d("/greenfield-js-sdk/api/account","f42"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/api-overview",component:d("/greenfield-js-sdk/api/api-overview","810"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/bucket",component:d("/greenfield-js-sdk/api/bucket","855"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/crosschain",component:d("/greenfield-js-sdk/api/crosschain","ec8"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/feegrant",component:d("/greenfield-js-sdk/api/feegrant","3d0"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/gashub",component:d("/greenfield-js-sdk/api/gashub","b8f"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/group",component:d("/greenfield-js-sdk/api/group","89c"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/object",component:d("/greenfield-js-sdk/api/object","2e7"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/payment",component:d("/greenfield-js-sdk/api/payment","258"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/sp",component:d("/greenfield-js-sdk/api/sp","f54"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/api/virtual-group",component:d("/greenfield-js-sdk/api/virtual-group","256"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/category/api",component:d("/greenfield-js-sdk/category/api","ab3"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/category/client",component:d("/greenfield-js-sdk/category/client","314"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/category/getting-started",component:d("/greenfield-js-sdk/category/getting-started","4ce"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/category/types",component:d("/greenfield-js-sdk/category/types","c2e"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/client/greenfield-client",component:d("/greenfield-js-sdk/client/greenfield-client","8a1"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/client/query-client",component:d("/greenfield-js-sdk/client/query-client","4b5"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/client/sp-client",component:d("/greenfield-js-sdk/client/sp-client","ad6"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/client/tx-client",component:d("/greenfield-js-sdk/client/tx-client","5da"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/constants/msg-type-url",component:d("/greenfield-js-sdk/constants/msg-type-url","bac"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/getting-started/install",component:d("/greenfield-js-sdk/getting-started/install","a57"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/getting-started/quick-start",component:d("/greenfield-js-sdk/getting-started/quick-start","2c0"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/types/action",component:d("/greenfield-js-sdk/types/action","e00"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/types/coin",component:d("/greenfield-js-sdk/types/coin","50a"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/types/pagination",component:d("/greenfield-js-sdk/types/pagination","938"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/types/principal",component:d("/greenfield-js-sdk/types/principal","44b"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/types/redundancy",component:d("/greenfield-js-sdk/types/redundancy","b53"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/types/timestamp",component:d("/greenfield-js-sdk/types/timestamp","48e"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/types/visibility",component:d("/greenfield-js-sdk/types/visibility","3b8"),exact:!0,sidebar:"GettingStartSidebar"},{path:"/greenfield-js-sdk/",component:d("/greenfield-js-sdk/","f82"),exact:!0,sidebar:"GettingStartSidebar"}]}]}]},{path:"*",component:d("*")}]},9747:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,t:()=>i});var r=n(79),a=n(5250);const o=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,a.jsx)(o.Provider,{value:n,children:t})}},2646:(e,t,n)=>{"use strict";var r=n(79),a=n(2226),o=n(4938),i=n(5131),l=n(8621);const s=[n(6790),n(601),n(5796),n(3461)];var u=n(1724),c=n(7911),d=n(6254),p=n(5250);function f(e){let{children:t}=e;return(0,p.jsx)(p.Fragment,{children:t})}var g=n(6211),m=n(5302),h=n(4979),y=n(4104),b=n(8752),v=n(9252),w=n(2195),k=n(1279),x=n(2985),S=n(1469);function E(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,m.Z)(),r=(0,v.l)(),a=n[e].htmlLang,o=e=>e.replace("-","_");return(0,p.jsxs)(g.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,p.jsx)("meta",{property:"og:locale",content:o(a)}),Object.values(n).filter((e=>a!==e.htmlLang)).map((e=>(0,p.jsx)("meta",{property:"og:locale:alternate",content:o(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function C(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,m.Z)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,m.Z)(),{pathname:r}=(0,c.TH)();return e+(0,x.applyTrailingSlash)((0,h.Z)(r),{trailingSlash:n,baseUrl:t})}(),a=t?`${n}${t}`:r;return(0,p.jsxs)(g.Z,{children:[(0,p.jsx)("meta",{property:"og:url",content:a}),(0,p.jsx)("link",{rel:"canonical",href:a})]})}function _(){const{i18n:{currentLocale:e}}=(0,m.Z)(),{metadata:t,image:n}=(0,y.L)();return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsxs)(g.Z,{children:[(0,p.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,p.jsx)("body",{className:w.h})]}),n&&(0,p.jsx)(b.d,{image:n}),(0,p.jsx)(C,{}),(0,p.jsx)(E,{}),(0,p.jsx)(S.Z,{tag:k.HX,locale:e}),(0,p.jsx)(g.Z,{children:t.map(((e,t)=>(0,p.jsx)("meta",{...e},t)))})]})}const j=new Map;function T(e){if(j.has(e.pathname))return{...e,pathname:j.get(e.pathname)};if((0,d.f)(u.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return j.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return j.set(e.pathname,t),{...e,pathname:t}}var L=n(9747),A=n(2729),N=n(7962);function R(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>a.forEach((e=>e?.()))}const P=function(e){let{children:t,location:n,previousLocation:r}=e;return(0,N.Z)((()=>{r!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,a=t.hash===n.hash,o=t.search===n.search;if(r&&a&&!o)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:r}),R("onRouteDidUpdate",{previousLocation:r,location:n}))}),[r,n]),t};function O(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(u.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class D extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.Z.canUseDOM?R("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=R("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),O(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,p.jsx)(P,{previousLocation:this.previousLocation,location:t,children:(0,p.jsx)(c.AW,{location:t,render:()=>e})})}}const I=D,F="__docusaurus-base-url-issue-banner-container",M="__docusaurus-base-url-issue-banner",z="__docusaurus-base-url-issue-banner-suggestion-container";function B(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${F}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const a=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;a?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var K=n(6943);const Y=new Set,X=new Set,J=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ee={prefetch(e){if(!(e=>!J()&&!X.has(e)&&!Y.has(e))(e))return!1;Y.add(e);const t=(0,d.f)(u.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(W).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,K.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Q(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!J()&&!X.has(e))(e)&&(X.add(e),O(e))},te=Object.freeze(ee),ne=Boolean(!0);if(l.Z.canUseDOM){window.docusaurus=te;const e=document.getElementById("__docusaurus"),t=(0,p.jsx)(i.B6,{children:(0,p.jsx)(o.VK,{children:(0,p.jsx)(V,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},l=()=>{if(ne)r.startTransition((()=>{a.hydrateRoot(e,t,{onRecoverableError:n})}));else{const o=a.createRoot(e,{onRecoverableError:n});r.startTransition((()=>{o.render(t)}))}};O(window.location.pathname).then(l)}},2729:(e,t,n)=>{"use strict";n.d(t,{_:()=>d,M:()=>p});var r=n(79),a=n(6809);const o=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/greenfield-js-sdk/","versions":[{"name":"current","label":"Next","isLast":true,"path":"/greenfield-js-sdk/","mainDocId":"getting-started/getting-started-overview","docs":[{"id":"api/account","path":"/greenfield-js-sdk/api/account","sidebar":"GettingStartSidebar"},{"id":"api/api-overview","path":"/greenfield-js-sdk/api/api-overview","sidebar":"GettingStartSidebar"},{"id":"api/bucket","path":"/greenfield-js-sdk/api/bucket","sidebar":"GettingStartSidebar"},{"id":"api/crosschain","path":"/greenfield-js-sdk/api/crosschain","sidebar":"GettingStartSidebar"},{"id":"api/feegrant","path":"/greenfield-js-sdk/api/feegrant","sidebar":"GettingStartSidebar"},{"id":"api/gashub","path":"/greenfield-js-sdk/api/gashub","sidebar":"GettingStartSidebar"},{"id":"api/group","path":"/greenfield-js-sdk/api/group","sidebar":"GettingStartSidebar"},{"id":"api/object","path":"/greenfield-js-sdk/api/object","sidebar":"GettingStartSidebar"},{"id":"api/payment","path":"/greenfield-js-sdk/api/payment","sidebar":"GettingStartSidebar"},{"id":"api/sp","path":"/greenfield-js-sdk/api/sp","sidebar":"GettingStartSidebar"},{"id":"api/virtual-group","path":"/greenfield-js-sdk/api/virtual-group","sidebar":"GettingStartSidebar"},{"id":"client/greenfield-client","path":"/greenfield-js-sdk/client/greenfield-client","sidebar":"GettingStartSidebar"},{"id":"client/query-client","path":"/greenfield-js-sdk/client/query-client","sidebar":"GettingStartSidebar"},{"id":"client/sp-client","path":"/greenfield-js-sdk/client/sp-client","sidebar":"GettingStartSidebar"},{"id":"client/tx-client","path":"/greenfield-js-sdk/client/tx-client","sidebar":"GettingStartSidebar"},{"id":"constants/msg-type-url","path":"/greenfield-js-sdk/constants/msg-type-url","sidebar":"GettingStartSidebar"},{"id":"getting-started/getting-started-overview","path":"/greenfield-js-sdk/","sidebar":"GettingStartSidebar"},{"id":"getting-started/install","path":"/greenfield-js-sdk/getting-started/install","sidebar":"GettingStartSidebar"},{"id":"getting-started/quick-start","path":"/greenfield-js-sdk/getting-started/quick-start","sidebar":"GettingStartSidebar"},{"id":"types/action","path":"/greenfield-js-sdk/types/action","sidebar":"GettingStartSidebar"},{"id":"types/coin","path":"/greenfield-js-sdk/types/coin","sidebar":"GettingStartSidebar"},{"id":"types/pagination","path":"/greenfield-js-sdk/types/pagination","sidebar":"GettingStartSidebar"},{"id":"types/principal","path":"/greenfield-js-sdk/types/principal","sidebar":"GettingStartSidebar"},{"id":"types/redundancy","path":"/greenfield-js-sdk/types/redundancy","sidebar":"GettingStartSidebar"},{"id":"types/timestamp","path":"/greenfield-js-sdk/types/timestamp","sidebar":"GettingStartSidebar"},{"id":"types/visibility","path":"/greenfield-js-sdk/types/visibility","sidebar":"GettingStartSidebar"},{"id":"/category/getting-started","path":"/greenfield-js-sdk/category/getting-started","sidebar":"GettingStartSidebar"},{"id":"/category/client","path":"/greenfield-js-sdk/category/client","sidebar":"GettingStartSidebar"},{"id":"/category/api","path":"/greenfield-js-sdk/category/api","sidebar":"GettingStartSidebar"},{"id":"/category/types","path":"/greenfield-js-sdk/category/types","sidebar":"GettingStartSidebar"}],"draftIds":[],"sidebars":{"GettingStartSidebar":{"link":{"path":"/greenfield-js-sdk/category/getting-started","label":"Getting Started"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var l=n(7529);const s=JSON.parse('{"docusaurusVersion":"3.0.1","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.0.1"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.0.1"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.0.1"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.0.1"},"docusaurus-plugin-ideal-image":{"type":"package","name":"@docusaurus/plugin-ideal-image","version":"3.0.1"}}}');var u=n(5250);const c={siteConfig:a.default,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},d=r.createContext(c);function p(e){let{children:t}=e;return(0,u.jsx)(d.Provider,{value:c,children:t})}},7864:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(79),a=n(8621),o=n(6211),i=n(2985),l=n(6748),s=n(5250);function u(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,s.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,s.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,s.jsx)(c,{error:t})]})}function c(e){let{error:t}=e;const n=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,s.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function d(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)(f,{fallback:()=>(0,s.jsx)(u,{error:t,tryAgain:n}),children:[(0,s.jsx)(o.Z,{children:(0,s.jsx)("title",{children:"Page Error"})}),(0,s.jsx)(l.Z,{children:(0,s.jsx)(u,{error:t,tryAgain:n})})]})}const p=e=>(0,s.jsx)(d,{...e});class f extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??p)(e)}return e??null}}},8621:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},6211:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(79);var r=n(5131),a=n(5250);function o(e){return(0,a.jsx)(r.ql,{...e})}},1352:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(79),a=n(4938),o=n(2985),i=n(5302),l=n(396),s=n(8621),u=n(5250);const c=r.createContext({collectLink:()=>{}});var d=n(4979);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:g,isActive:m,"data-noBrokenLinkCheck":h,autoAddBaseUrl:y=!0,...b}=e;const{siteConfig:{trailingSlash:v,baseUrl:w}}=(0,i.Z)(),{withBaseUrl:k}=(0,d.C)(),x=(0,r.useContext)(c),S=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>S.current));const E=p||f;const C=(0,l.Z)(E),_=E?.replace("pathname://","");let j=void 0!==_?(T=_,y&&(e=>e.startsWith("/"))(T)?k(T):T):void 0;var T;j&&C&&(j=(0,o.applyTrailingSlash)(j,{trailingSlash:v,baseUrl:w}));const L=(0,r.useRef)(!1),A=n?a.OL:a.rU,N=s.Z.canUseIntersectionObserver,R=(0,r.useRef)(),P=()=>{L.current||null==j||(window.docusaurus.preload(j),L.current=!0)};(0,r.useEffect)((()=>(!N&&C&&null!=j&&window.docusaurus.prefetch(j),()=>{N&&R.current&&R.current.disconnect()})),[R,j,N,C]);const O=j?.startsWith("#")??!1,D=!j||!C||O;return D||h||x.collectLink(j),D?(0,u.jsx)("a",{ref:S,href:j,...E&&!C&&{target:"_blank",rel:"noopener noreferrer"},...b}):(0,u.jsx)(A,{...b,onMouseEnter:P,onTouchStart:P,innerRef:e=>{S.current=e,N&&e&&C&&(R.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(R.current.unobserve(e),R.current.disconnect(),null!=j&&window.docusaurus.prefetch(j))}))})),R.current.observe(e))},to:j,...n&&{isActive:m,activeClassName:g}})}const f=r.forwardRef(p)},8081:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=()=>null},578:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u,I:()=>s});var r=n(79),a=n(5250);function o(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var i=n(7529);function l(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??n]??n??t}function s(e,t){let{message:n,id:r}=e;return o(l({message:n,id:r}),t)}function u(e){let{children:t,id:n,values:r}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const i=l({message:t,id:n});return(0,a.jsx)(a.Fragment,{children:o(i,r)})}},8414:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},396:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},4979:(e,t,n)=>{"use strict";n.d(t,{C:()=>i,Z:()=>l});var r=n(79),a=n(5302),o=n(396);function i(){const{siteConfig:{baseUrl:e,url:t}}=(0,a.Z)(),n=(0,r.useCallback)(((n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:a=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,o.b)(n))return n;if(a)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const l=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+l:l}(t,e,n,r)),[t,e]);return{withBaseUrl:n}}function l(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},5302:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(79),a=n(2729);function o(){return(0,r.useContext)(a._)}},908:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(79),a=n(9747);function o(){return(0,r.useContext)(a._)}},7962:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});var r=n(79);const a=n(8621).Z.canUseDOM?r.useLayoutEffect:r.useEffect},6943:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function a(e){const t={};return function e(n,a){Object.entries(n).forEach((n=>{let[o,i]=n;const l=a?`${a}.${o}`:o;r(i)?e(i,l):t[l]=i}))}(e),t}},4931:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,z:()=>i});var r=n(79),a=n(5250);const o=r.createContext(null);function i(e){let{children:t,value:n}=e;const i=r.useContext(o),l=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:i,value:n})),[i,n]);return(0,a.jsx)(o.Provider,{value:l,children:t})}},698:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>m,gA:()=>p,_r:()=>c,Jo:()=>h,zh:()=>d,yW:()=>g,gB:()=>f});var r=n(7911),a=n(5302),o=n(8414);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,a.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const l=e=>e.versions.find((e=>e.isLast));function s(e,t){const n=function(e,t){const n=l(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),a=n?.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const u={},c=()=>i("docusaurus-plugin-content-docs")??u,d=e=>function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});const r=i(e),a=r?.[t];if(!a&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return a}("docusaurus-plugin-content-docs",e,{failfast:!0});function p(e){void 0===e&&(e={});const t=c(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return o}(t,n,e)}function f(e){return d(e).versions}function g(e){const t=d(e);return l(t)}function m(e){const t=d(e),{pathname:n}=(0,r.TH)();return s(t,n)}function h(e){const t=d(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=l(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},3425:(e,t,n)=>{"use strict";function r(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,e.__proto__=t}function a(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(){return i=Object.assign||function(e){for(var t=1;t{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(7811),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},601:(e,t,n)=>{"use strict";n.r(t);var r=n(4503),a=n(6809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(3715),n(2657)(`./prism-${e}`)})),delete globalThis.Prism}(r.p1)},6104:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});n(79);var r=n(3230),a=n(578),o=n(4104),i=n(1352);const l={anchorWithStickyNavbar:"anchorWithStickyNavbar_SxSj",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_v51y"};var s=n(5250);function u(e){let{as:t,id:n,...u}=e;const{navbar:{hideOnScroll:c}}=(0,o.L)();if("h1"===t||!n)return(0,s.jsx)(t,{...u,id:void 0});const d=(0,a.I)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,s.jsxs)(t,{...u,className:(0,r.Z)("anchor",c?l.anchorWithHideOnScrollNavbar:l.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,s.jsx)(i.Z,{className:"hash-link",to:`#${n}`,"aria-label":d,title:d,children:"\u200b"})]})}},4118:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(79);const r={iconExternalLink:"iconExternalLink_MkL9"};var a=n(5250);function o(e){let{width:t=13.5,height:n=13.5}=e;return(0,a.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,a.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},6748:(e,t,n)=>{"use strict";n.d(t,{Z:()=>ft});var r=n(79),a=n(3230),o=n(7864),i=n(8752),l=n(7911),s=n(578),u=n(5289),c=n(5250);const d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,l.k6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,u.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const g=(0,s.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function m(e){const t=e.children??g,{containerRef:n,onClick:r}=f();return(0,c.jsx)("div",{ref:n,role:"region","aria-label":g,children:(0,c.jsx)("a",{...e,href:`#${d}`,onClick:r,children:t})})}var h=n(6477),y=n(2195);const b={skipToContent:"skipToContent_IcsY"};function v(){return(0,c.jsx)(m,{className:b.skipToContent})}var w=n(4104),k=n(2812);function x(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:a=1.2,className:o,...i}=e;return(0,c.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,c.jsx)("g",{stroke:r,strokeWidth:a,children:(0,c.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const S={closeButton:"closeButton_jvUs"};function E(e){return(0,c.jsx)("button",{type:"button","aria-label":(0,s.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,a.Z)("clean-btn close",S.closeButton,e.className),children:(0,c.jsx)(x,{width:14,height:14,strokeWidth:3.1})})}const C={content:"content_LCDc"};function _(e){const{announcementBar:t}=(0,w.L)(),{content:n}=t;return(0,c.jsx)("div",{...e,className:(0,a.Z)(C.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const j={announcementBar:"announcementBar_bPh9",announcementBarPlaceholder:"announcementBarPlaceholder_xjJ1",announcementBarClose:"announcementBarClose_V7al",announcementBarContent:"announcementBarContent_SALj"};function T(){const{announcementBar:e}=(0,w.L)(),{isActive:t,close:n}=(0,k.nT)();if(!t)return null;const{backgroundColor:r,textColor:a,isCloseable:o}=e;return(0,c.jsxs)("div",{className:j.announcementBar,style:{backgroundColor:r,color:a},role:"banner",children:[o&&(0,c.jsx)("div",{className:j.announcementBarPlaceholder}),(0,c.jsx)(_,{className:j.announcementBarContent}),o&&(0,c.jsx)(E,{onClick:n,className:j.announcementBarClose})]})}var L=n(6259),A=n(8153);var N=n(3619),R=n(6111);const P=r.createContext(null);function O(e){let{children:t}=e;const n=function(){const e=(0,L.e)(),t=(0,R.HY)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,N.D9)(o);return(0,r.useEffect)((()=>{o&&!i&&a(!0)}),[o,i]),(0,r.useEffect)((()=>{o?e.shown||a(!0):a(!1)}),[e.shown,o]),(0,r.useMemo)((()=>[n,a]),[n])}();return(0,c.jsx)(P.Provider,{value:n,children:t})}function D(e){if(e.component){const t=e.component;return(0,c.jsx)(t,{...e.props})}}function I(){const e=(0,r.useContext)(P);if(!e)throw new N.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,R.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:D(o)})),[a,o,t])}function F(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:o}=I();return(0,c.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,c.jsxs)("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":o}),children:[(0,c.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,c.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var M=n(5519),z=n(908);function B(e){return(0,c.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,c.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function $(e){return(0,c.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,c.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const U={toggle:"toggle_xQyk",toggleButton:"toggleButton_H37A",darkToggleIcon:"darkToggleIcon_TUIf",lightToggleIcon:"lightToggleIcon_kcqk",toggleButtonDisabled:"toggleButtonDisabled_CUnX"};function G(e){let{className:t,buttonClassName:n,value:r,onChange:o}=e;const i=(0,z.Z)(),l=(0,s.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===r?(0,s.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,s.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,c.jsx)("div",{className:(0,a.Z)(U.toggle,t),children:(0,c.jsxs)("button",{className:(0,a.Z)("clean-btn",U.toggleButton,!i&&U.toggleButtonDisabled,n),type:"button",onClick:()=>o("dark"===r?"light":"dark"),disabled:!i,title:l,"aria-label":l,"aria-live":"polite",children:[(0,c.jsx)(B,{className:(0,a.Z)(U.toggleIcon,U.lightToggleIcon)}),(0,c.jsx)($,{className:(0,a.Z)(U.toggleIcon,U.darkToggleIcon)})]})})}const q=r.memo(G),H={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_AcDD"};function Z(e){let{className:t}=e;const n=(0,w.L)().navbar.style,r=(0,w.L)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,M.I)();return r?null:(0,c.jsx)(q,{className:t,buttonClassName:"dark"===n?H.darkNavbarColorModeToggle:void 0,value:a,onChange:o})}var V=n(2143);function W(){return(0,c.jsx)(V.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){const e=(0,L.e)();return(0,c.jsx)("button",{type:"button","aria-label":(0,s.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,c.jsx)(x,{color:"var(--ifm-color-emphasis-600)"})})}function K(){return(0,c.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,c.jsx)(W,{}),(0,c.jsx)(Z,{className:"margin-right--md"}),(0,c.jsx)(Q,{})]})}var Y=n(1352),X=n(4979),J=n(396);function ee(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var te=n(4118);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:a,label:o,html:i,isDropdownLink:l,prependBaseUrlToHref:s,...u}=e;const d=(0,X.Z)(r),p=(0,X.Z)(t),f=(0,X.Z)(a,{forcePrependBaseUrl:!0}),g=o&&a&&!(0,J.Z)(a),m=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,c.jsxs)(c.Fragment,{children:[o,g&&(0,c.jsx)(te.Z,{...l&&{width:12,height:12}})]})};return a?(0,c.jsx)(Y.Z,{href:s?f:a,...u,...m}):(0,c.jsx)(Y.Z,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?ee(n,t.pathname):t.pathname.startsWith(p)},...u,...m})}function re(e){let{className:t,isDropdownItem:n=!1,...r}=e;const o=(0,c.jsx)(ne,{className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,c.jsx)("li",{children:o}):o}function ae(e){let{className:t,isDropdownItem:n,...r}=e;return(0,c.jsx)("li",{className:"menu__list-item",children:(0,c.jsx)(ne,{className:(0,a.Z)("menu__link",t),...r})})}function oe(e){let{mobile:t=!1,position:n,...r}=e;const a=t?ae:re;return(0,c.jsx)(a,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var ie=n(7598),le=n(2098),se=n(5302);const ue={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_rAGy"};function ce(e,t){return e.some((e=>function(e,t){return!!(0,le.Mg)(e.to,t)||!!ee(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function de(e){let{items:t,position:n,className:o,onClick:i,...l}=e;const s=(0,r.useRef)(null),[u,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{s.current&&!s.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[s]),(0,c.jsxs)("div",{ref:s,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":u}),children:[(0,c.jsx)(ne,{"aria-haspopup":"true","aria-expanded":u,role:"button",href:l.to?void 0:"#",className:(0,a.Z)("navbar__link",o),...l,onClick:l.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!u))},children:l.children??l.label}),(0,c.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(Ce,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:o,onClick:i,...s}=e;const u=function(){const{siteConfig:{baseUrl:e}}=(0,se.Z)(),{pathname:t}=(0,l.TH)();return t.replace(e,"/")}(),d=ce(t,u),{collapsed:p,toggleCollapsed:f,setCollapsed:g}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&g(!d)}),[u,d,g]),(0,c.jsxs)("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,c.jsx)(ne,{role:"button",className:(0,a.Z)(ue.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...s,onClick:e=>{e.preventDefault(),f()},children:s.children??s.label}),(0,c.jsx)(ie.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,r.createElement)(Ce,{mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active",...e,key:t})))})]})}function fe(e){let{mobile:t=!1,...n}=e;const r=t?pe:de;return(0,c.jsx)(r,{...n})}var ge=n(9252);function me(e){let{width:t=20,height:n=20,...r}=e;return(0,c.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,c.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const he="iconLanguage_nSbO";var ye=n(8081);const be={navbarSearchContainer:"navbarSearchContainer_zLz3"};function ve(e){let{children:t,className:n}=e;return(0,c.jsx)("div",{className:(0,a.Z)(n,be.navbarSearchContainer),children:t})}var we=n(698),ke=n(3288);var xe=n(1017);const Se=e=>e.docs.find((t=>t.id===e.mainDocId));const Ee={default:oe,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:a="",...o}=e;const{i18n:{currentLocale:i,locales:u,localeConfigs:d}}=(0,se.Z)(),p=(0,ge.l)(),{search:f,hash:g}=(0,l.TH)(),m=[...n,...u.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${g}${a}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...r],h=t?(0,s.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return(0,c.jsx)(fe,{...o,mobile:t,label:(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(me,{className:he}),h]}),items:m})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,c.jsx)(ve,{className:n,children:(0,c.jsx)(ye.Z,{})})},dropdown:fe,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:o=!1}=e;const i=o?"li":"div";return(0,c.jsx)(i,{className:(0,a.Z)({navbar__item:!r&&!o,"menu__list-item":r},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:r,...a}=e;const{activeDoc:o}=(0,we.Iw)(r),i=(0,ke.vY)(t,r),l=o?.path===i?.path;return null===i||i.unlisted&&!l?null:(0,c.jsx)(oe,{exact:!0,...a,isActive:()=>l||!!o?.sidebar&&o.sidebar===i.sidebar,label:n??i.id,to:i.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:r,...a}=e;const{activeDoc:o}=(0,we.Iw)(r),i=(0,ke.oz)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,c.jsx)(oe,{exact:!0,...a,isActive:()=>o?.sidebar===t,label:n??i.label,to:i.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:r,...a}=e;const o=(0,ke.lO)(r)[0],i=t??o.label,l=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(o).path;return(0,c.jsx)(oe,{...a,label:i,to:l})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:r,dropdownItemsBefore:a,dropdownItemsAfter:o,...i}=e;const{search:u,hash:d}=(0,l.TH)(),p=(0,we.Iw)(n),f=(0,we.gB)(n),{savePreferredVersionName:g}=(0,xe.J)(n),m=[...a,...f.map((e=>{const t=p.alternateDocVersions[e.name]??Se(e);return{label:e.label,to:`${t.path}${u}${d}`,isActive:()=>e===p.activeVersion,onClick:()=>g(e.name)}})),...o],h=(0,ke.lO)(n)[0],y=t&&m.length>1?(0,s.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):h.label,b=t&&m.length>1?void 0:Se(h).path;return m.length<=1?(0,c.jsx)(oe,{...i,mobile:t,label:y,to:b,isActive:r?()=>!1:void 0}):(0,c.jsx)(fe,{...i,mobile:t,label:y,to:b,items:m,isActive:r?()=>!1:void 0})}};function Ce(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),a=Ee[r];if(!a)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,c.jsx)(a,{...n})}function _e(){const e=(0,L.e)(),t=(0,w.L)().navbar.items;return(0,c.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(Ce,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function je(e){return(0,c.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,c.jsx)(s.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Te(){const e=0===(0,w.L)().navbar.items.length,t=I();return(0,c.jsxs)(c.Fragment,{children:[!e&&(0,c.jsx)(je,{onClick:()=>t.hide()}),t.content]})}function Le(){const e=(0,L.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,c.jsx)(F,{header:(0,c.jsx)(K,{}),primaryMenu:(0,c.jsx)(_e,{}),secondaryMenu:(0,c.jsx)(Te,{})}):null}const Ae={navbarHideable:"navbarHideable_Nh89",navbarHidden:"navbarHidden_dLFU"};function Ne(e){return(0,c.jsx)("div",{role:"presentation",...e,className:(0,a.Z)("navbar-sidebar__backdrop",e.className)})}function Re(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,w.L)(),i=(0,L.e)(),{navbarRef:l,isNavbarVisible:d}=function(e){const[t,n]=(0,r.useState)(e),a=(0,r.useRef)(!1),o=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(o.current=e.getBoundingClientRect().height)}),[]);return(0,A.RF)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=l?n(!1):i+u{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return a.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return(0,c.jsxs)("nav",{ref:l,"aria-label":(0,s.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,a.Z)("navbar","navbar--fixed-top",n&&[Ae.navbarHideable,!d&&Ae.navbarHidden],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown}),children:[t,(0,c.jsx)(Ne,{onClick:i.toggle}),(0,c.jsx)(Le,{})]})}var Pe=n(2985);const Oe={errorBoundaryError:"errorBoundaryError_Lk1U",errorBoundaryFallback:"errorBoundaryFallback_SsrO"};function De(e){return(0,c.jsx)("button",{type:"button",...e,children:(0,c.jsx)(s.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function Ie(e){let{error:t}=e;const n=(0,Pe.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,c.jsx)("p",{className:Oe.errorBoundaryError,children:n})}class Fe extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const Me="right";function ze(e){let{width:t=30,height:n=30,className:r,...a}=e;return(0,c.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...a,children:(0,c.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function Be(){const{toggle:e,shown:t}=(0,L.e)();return(0,c.jsx)("button",{onClick:e,"aria-label":(0,s.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,c.jsx)(ze,{})})}const $e={colorModeToggle:"colorModeToggle_rcJb"};function Ue(e){let{items:t}=e;return(0,c.jsx)(c.Fragment,{children:t.map(((e,t)=>(0,c.jsx)(Fe,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,c.jsx)(Ce,{...e})},t)))})}function Ge(e){let{left:t,right:n}=e;return(0,c.jsxs)("div",{className:"navbar__inner",children:[(0,c.jsx)("div",{className:"navbar__items",children:t}),(0,c.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function qe(){const e=(0,L.e)(),t=(0,w.L)().navbar.items,[n,r]=function(e){function t(e){return"left"===(e.position??Me)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),a=t.find((e=>"search"===e.type));return(0,c.jsx)(Ge,{left:(0,c.jsxs)(c.Fragment,{children:[!e.disabled&&(0,c.jsx)(Be,{}),(0,c.jsx)(W,{}),(0,c.jsx)(Ue,{items:n})]}),right:(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(Ue,{items:r}),(0,c.jsx)(Z,{className:$e.colorModeToggle}),!a&&(0,c.jsx)(ve,{children:(0,c.jsx)(ye.Z,{})})]})})}function He(){return(0,c.jsx)(Re,{children:(0,c.jsx)(qe,{})})}function Ze(e){let{item:t}=e;const{to:n,href:r,label:a,prependBaseUrlToHref:o,...i}=t,l=(0,X.Z)(n),s=(0,X.Z)(r,{forcePrependBaseUrl:!0});return(0,c.jsxs)(Y.Z,{className:"footer__link-item",...r?{href:o?s:r}:{to:l},...i,children:[a,r&&!(0,J.Z)(r)&&(0,c.jsx)(te.Z,{})]})}function Ve(e){let{item:t}=e;return t.html?(0,c.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,c.jsx)("li",{className:"footer__item",children:(0,c.jsx)(Ze,{item:t})},t.href??t.to)}function We(e){let{column:t}=e;return(0,c.jsxs)("div",{className:"col footer__col",children:[(0,c.jsx)("div",{className:"footer__title",children:t.title}),(0,c.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,c.jsx)(Ve,{item:e},t)))})]})}function Qe(e){let{columns:t}=e;return(0,c.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,c.jsx)(We,{column:e},t)))})}function Ke(){return(0,c.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function Ye(e){let{item:t}=e;return t.html?(0,c.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,c.jsx)(Ze,{item:t})}function Xe(e){let{links:t}=e;return(0,c.jsx)("div",{className:"footer__links text--center",children:(0,c.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,c.jsxs)(r.Fragment,{children:[(0,c.jsx)(Ye,{item:e}),t.length!==n+1&&(0,c.jsx)(Ke,{})]},n)))})})}function Je(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,c.jsx)(Qe,{columns:t}):(0,c.jsx)(Xe,{links:t})}var et=n(8941);const tt={footerLogoLink:"footerLogoLink_YSh_"};function nt(e){let{logo:t}=e;const{withBaseUrl:n}=(0,X.C)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,c.jsx)(et.Z,{className:(0,a.Z)("footer__logo",t.className),alt:t.alt,sources:r,width:t.width,height:t.height,style:t.style})}function rt(e){let{logo:t}=e;return t.href?(0,c.jsx)(Y.Z,{href:t.href,className:tt.footerLogoLink,target:t.target,children:(0,c.jsx)(nt,{logo:t})}):(0,c.jsx)(nt,{logo:t})}function at(e){let{copyright:t}=e;return(0,c.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function ot(e){let{style:t,links:n,logo:r,copyright:o}=e;return(0,c.jsx)("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t}),children:(0,c.jsxs)("div",{className:"container container-fluid",children:[n,(r||o)&&(0,c.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,c.jsx)("div",{className:"margin-bottom--sm",children:r}),o]})]})})}function it(){const{footer:e}=(0,w.L)();if(!e)return null;const{copyright:t,links:n,logo:r,style:a}=e;return(0,c.jsx)(ot,{style:a,links:n&&n.length>0&&(0,c.jsx)(Je,{links:n}),logo:r&&(0,c.jsx)(rt,{logo:r}),copyright:t&&(0,c.jsx)(at,{copyright:t})})}const lt=r.memo(it),st=(0,N.Qc)([M.S,k.pl,A.OC,xe.L5,i.VC,function(e){let{children:t}=e;return(0,c.jsx)(R.n2,{children:(0,c.jsx)(L.M,{children:(0,c.jsx)(O,{children:t})})})}]);function ut(e){let{children:t}=e;return(0,c.jsx)(st,{children:t})}var ct=n(6104);function dt(e){let{error:t,tryAgain:n}=e;return(0,c.jsx)("main",{className:"container margin-vert--xl",children:(0,c.jsx)("div",{className:"row",children:(0,c.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,c.jsx)(ct.Z,{as:"h1",className:"hero__title",children:(0,c.jsx)(s.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,c.jsx)("div",{className:"margin-vert--lg",children:(0,c.jsx)(De,{onClick:n,className:"button button--primary shadow--lw"})}),(0,c.jsx)("hr",{}),(0,c.jsx)("div",{className:"margin-vert--md",children:(0,c.jsx)(Ie,{error:t})})]})})})}const pt={mainWrapper:"mainWrapper_GDTr"};function ft(e){const{children:t,noFooter:n,wrapperClassName:r,title:l,description:s}=e;return(0,y.t)(),(0,c.jsxs)(ut,{children:[(0,c.jsx)(i.d,{title:l,description:s}),(0,c.jsx)(v,{}),(0,c.jsx)(T,{}),(0,c.jsx)(He,{}),(0,c.jsx)("div",{id:d,className:(0,a.Z)(h.k.wrapper.main,pt.mainWrapper,r),children:(0,c.jsx)(o.Z,{fallback:e=>(0,c.jsx)(dt,{...e}),children:t})}),!n&&(0,c.jsx)(lt,{})]})}},2143:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c});n(79);var r=n(1352),a=n(4979),o=n(5302),i=n(4104),l=n(8941),s=n(5250);function u(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,a.Z)(t.src),dark:(0,a.Z)(t.srcDark||t.src)},i=(0,s.jsx)(l.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,s.jsx)("div",{className:r,children:i}):i}function c(e){const{siteConfig:{title:t}}=(0,o.Z)(),{navbar:{title:n,logo:l}}=(0,i.L)(),{imageClassName:c,titleClassName:d,...p}=e,f=(0,a.Z)(l?.href||"/"),g=n?"":t,m=l?.alt??g;return(0,s.jsxs)(r.Z,{to:f,...p,...l?.target&&{target:l.target},children:[l&&(0,s.jsx)(u,{logo:l,alt:m,imageClassName:c}),null!=n&&(0,s.jsx)("b",{className:d,children:n})]})}},1469:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(79);var r=n(6211),a=n(5250);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return(0,a.jsxs)(r.Z,{children:[t&&(0,a.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,a.jsx)("meta",{name:"docusaurus_version",content:n}),o&&(0,a.jsx)("meta",{name:"docusaurus_tag",content:o}),i&&(0,a.jsx)("meta",{name:"docsearch:language",content:i}),n&&(0,a.jsx)("meta",{name:"docsearch:version",content:n}),o&&(0,a.jsx)("meta",{name:"docsearch:docusaurus_tag",content:o})]})}},8941:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c});var r=n(79),a=n(3230),o=n(908),i=n(5519);const l={themedComponent:"themedComponent_HOkb","themedComponent--light":"themedComponent--light_rQCO","themedComponent--dark":"themedComponent--dark_wf9T"};var s=n(5250);function u(e){let{className:t,children:n}=e;const u=(0,o.Z)(),{colorMode:c}=(0,i.I)();return(0,s.jsx)(s.Fragment,{children:(u?"dark"===c?["dark"]:["light"]:["light","dark"]).map((e=>{const o=n({theme:e,className:(0,a.Z)(t,l.themedComponent,l[`themedComponent--${e}`])});return(0,s.jsx)(r.Fragment,{children:o},e)}))})}function c(e){const{sources:t,className:n,alt:r,...a}=e;return(0,s.jsx)(u,{className:n,children:e=>{let{theme:n,className:o}=e;return(0,s.jsx)("img",{src:t[n],alt:r,className:o,...a})}})}},7598:(e,t,n)=>{"use strict";n.d(t,{u:()=>u,z:()=>y});var r=n(79),a=n(8621),o=n(7962),i=n(2104),l=n(5250);const s="ease-in-out";function u(e){let{initialState:t}=e;const[n,a]=(0,r.useState)(t??!1),o=(0,r.useCallback)((()=>{a((e=>!e))}),[]);return{collapsed:n,setCollapsed:a,toggleCollapsed:o}}const c={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?c:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function f(e){let{collapsibleRef:t,collapsed:n,animation:a}=e;const o=(0,r.useRef)(!1);(0,r.useEffect)((()=>{const e=t.current;function r(){const t=e.scrollHeight,n=a?.duration??function(e){if((0,i.n)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${a?.easing??s}`,height:`${t}px`}}function l(){const t=r();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return p(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(l(),requestAnimationFrame((()=>{e.style.height=c.height,e.style.overflow=c.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{l()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,a])}function g(e){if(!a.Z.canUseDOM)return e?c:d}function m(e){let{as:t="div",collapsed:n,children:a,animation:o,onCollapseTransitionEnd:i,className:s,disableSSRStyle:u}=e;const c=(0,r.useRef)(null);return f({collapsibleRef:c,collapsed:n,animation:o}),(0,l.jsx)(t,{ref:c,style:u?void 0:g(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(c.current,n),i?.(n))},className:s,children:a})}function h(e){let{collapsed:t,...n}=e;const[a,i]=(0,r.useState)(!t),[s,u]=(0,r.useState)(t);return(0,o.Z)((()=>{t||i(!0)}),[t]),(0,o.Z)((()=>{a&&u(t)}),[a,t]),a?(0,l.jsx)(m,{...n,collapsed:s}):null}function y(e){let{lazy:t,...n}=e;const r=t?h:m;return(0,l.jsx)(r,{...n})}},2812:(e,t,n)=>{"use strict";n.d(t,{nT:()=>m,pl:()=>g});var r=n(79),a=n(908),o=n(5778),i=n(3619),l=n(4104),s=n(5250);const u=(0,o.WA)("docusaurus.announcement.dismiss"),c=(0,o.WA)("docusaurus.announcement.id"),d=()=>"true"===u.get(),p=e=>u.set(String(e)),f=r.createContext(null);function g(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.L)(),t=(0,a.Z)(),[n,o]=(0,r.useState)((()=>!!t&&d()));(0,r.useEffect)((()=>{o(d())}),[]);const i=(0,r.useCallback)((()=>{p(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=c.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;c.set(t),r&&p(!1),!r&&d()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return(0,s.jsx)(f.Provider,{value:n,children:t})}function m(){const e=(0,r.useContext)(f);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},5519:(e,t,n)=>{"use strict";n.d(t,{I:()=>y,S:()=>h});var r=n(79),a=n(8621),o=n(3619),i=n(5778),l=n(4104),s=n(5250);const u=r.createContext(void 0),c="theme",d=(0,i.WA)(c),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,g=e=>a.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),m=e=>{d.set(f(e))};function h(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.L)(),[a,o]=(0,r.useState)(g(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(o(t),a&&m(t)):(o(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(a))}),[a]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==c)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const s=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||s.current?s.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:a,setColorMode:i,get isDarkTheme(){return a===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[a,i])}();return(0,s.jsx)(u.Provider,{value:n,children:t})}function y(){const e=(0,r.useContext)(u);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},1017:(e,t,n)=>{"use strict";n.d(t,{J:()=>v,L5:()=>y});var r=n(79),a=n(698),o=n(8414),i=n(4104),l=n(3288),s=n(3619),u=n(5778),c=n(5250);const d=e=>`docs-preferred-version-${e}`,p={save:(e,t,n)=>{(0,u.WA)(d(e),{persistence:t}).set(n)},read:(e,t)=>(0,u.WA)(d(e),{persistence:t}).get(),clear:(e,t)=>{(0,u.WA)(d(e),{persistence:t}).del()}},f=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const g=r.createContext(null);function m(){const e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,l]=(0,r.useState)((()=>f(n)));(0,r.useEffect)((()=>{l(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=p.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){p.save(e,t,n),l((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function h(e){let{children:t}=e;const n=m();return(0,c.jsx)(g.Provider,{value:n,children:t})}function y(e){let{children:t}=e;return l.cE?(0,c.jsx)(h,{children:t}):(0,c.jsx)(c.Fragment,{children:t})}function b(){const e=(0,r.useContext)(g);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=o.m);const t=(0,a.zh)(e),[n,i]=b(),{preferredVersionName:l}=n[e];return{preferredVersion:t.versions.find((e=>e.name===l))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}},1350:(e,t,n)=>{"use strict";n.d(t,{V:()=>u,b:()=>s});var r=n(79),a=n(3619),o=n(5250);const i=Symbol("EmptyContext"),l=r.createContext(i);function s(e){let{children:t,name:n,items:a}=e;const i=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return(0,o.jsx)(l.Provider,{value:i,children:t})}function u(){const e=(0,r.useContext)(l);if(e===i)throw new a.i6("DocsSidebarProvider");return e}},4650:(e,t,n)=>{"use strict";n.d(t,{E:()=>s,q:()=>l});var r=n(79),a=n(3619),o=n(5250);const i=r.createContext(null);function l(e){let{children:t,version:n}=e;return(0,o.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(null===e)throw new a.i6("DocsVersionProvider");return e}},6259:(e,t,n)=>{"use strict";n.d(t,{M:()=>p,e:()=>f});var r=n(79),a=n(6111),o=n(4581),i=n(1529),l=n(4104),s=n(3619),u=n(5250);const c=r.createContext(void 0);function d(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,l.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[s,u]=(0,r.useState)(!1);(0,i.Rb)((()=>{if(s)return u(!1),!1}));const c=(0,r.useCallback)((()=>{u((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&u(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:c,shown:s})),[e,n,c,s])}function p(e){let{children:t}=e;const n=d();return(0,u.jsx)(c.Provider,{value:n,children:t})}function f(){const e=r.useContext(c);if(void 0===e)throw new s.i6("NavbarMobileSidebarProvider");return e}},6111:(e,t,n)=>{"use strict";n.d(t,{HY:()=>s,Zo:()=>u,n2:()=>l});var r=n(79),a=n(3619),o=n(5250);const i=r.createContext(null);function l(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return(0,o.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function u(e){let{component:t,props:n}=e;const o=(0,r.useContext)(i);if(!o)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,l]=o,s=(0,a.Ql)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},2195:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(79);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},4581:(e,t,n)=>{"use strict";n.d(t,{i:()=>l});var r=n(79),a=n(8621);const o={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function l(){const[e,t]=(0,r.useState)((()=>"ssr"));return(0,r.useEffect)((()=>{function e(){t(function(){if(!a.Z.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>i?o.desktop:o.mobile}())}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[]),e}},6477:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},2104:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{n:()=>r})},3288:(e,t,n)=>{"use strict";n.d(t,{LM:()=>g,MN:()=>j,SN:()=>_,_F:()=>b,cE:()=>p,f:()=>w,jA:()=>m,lO:()=>S,oz:()=>E,s1:()=>x,vY:()=>C,xz:()=>f});var r=n(79),a=n(7911),o=n(6254),i=n(698),l=n(1017),s=n(4650),u=n(1350),c=n(6922),d=n(2098);const p=!!i._r;function f(e){const t=(0,s.E)();if(!e)return;const n=t.docs[e];if(!n)throw new Error(`no version doc found by id=${e}`);return n}function g(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=g(t);if(e)return e}}(e):void 0:e.href}function m(){const{pathname:e}=(0,a.TH)(),t=(0,u.V)();if(!t)throw new Error("Unexpected: cant find current sidebar in context");const n=k({sidebarItems:t.items,pathname:e,onlyCategories:!0}).slice(-1)[0];if(!n)throw new Error(`${e} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);return n}const h=(e,t)=>void 0!==e&&(0,d.Mg)(e,t),y=(e,t)=>e.some((e=>b(e,t)));function b(e,t){return"link"===e.type?h(e.href,t):"category"===e.type&&(h(e.href,t)||y(e.items,t))}function v(e,t){switch(e.type){case"category":return b(e,t)||e.items.some((e=>v(e,t)));case"link":return!e.unlisted||b(e,t);default:return!0}}function w(e,t){return(0,r.useMemo)((()=>e.filter((e=>v(e,t)))),[e,t])}function k(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const a=[];return function e(t){for(const o of t)if("category"===o.type&&((0,d.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,d.Mg)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function x(){const e=(0,u.V)(),{pathname:t}=(0,a.TH)(),n=(0,i.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?k({sidebarItems:e.items,pathname:t}):null}function S(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,l.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>(0,c.j)([t,n,a].filter(Boolean))),[t,n,a])}function E(e,t){const n=S(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function C(e,t){const n=S(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,c.j)(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function _(e){let{route:t}=e;const n=(0,a.TH)(),r=(0,s.E)(),i=t.routes,l=i.find((e=>(0,a.LX)(n.pathname,e)));if(!l)return null;const u=l.sidebar,c=u?r.docsSidebars[u]:void 0;return{docElement:(0,o.H)(i),sidebarName:u,sidebarItems:c}}function j(e){return e.filter((e=>!("category"===e.type||"link"===e.type)||!!g(e)))}},1529:(e,t,n)=>{"use strict";n.d(t,{Rb:()=>i,_X:()=>l});var r=n(79),a=n(7911),o=n(3619);function i(e){!function(e){const t=(0,a.k6)(),n=(0,o.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function l(e){return function(e){const t=(0,a.k6)();return(0,r.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}},6922:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function a(e){return Array.from(new Set(e))}n.d(t,{j:()=>a,l:()=>r})},8752:(e,t,n)=>{"use strict";n.d(t,{FG:()=>f,d:()=>d,VC:()=>g});var r=n(79),a=n(3230),o=n(6211),i=n(4931);function l(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(4979),u=n(5302);var c=n(5250);function d(e){let{title:t,description:n,keywords:r,image:a,children:i}=e;const l=function(e){const{siteConfig:t}=(0,u.Z)(),{title:n,titleDelimiter:r}=t;return e?.trim().length?`${e.trim()} ${r} ${n}`:n}(t),{withBaseUrl:d}=(0,s.C)(),p=a?d(a,{absolute:!0}):void 0;return(0,c.jsxs)(o.Z,{children:[t&&(0,c.jsx)("title",{children:l}),t&&(0,c.jsx)("meta",{property:"og:title",content:l}),n&&(0,c.jsx)("meta",{name:"description",content:n}),n&&(0,c.jsx)("meta",{property:"og:description",content:n}),r&&(0,c.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),p&&(0,c.jsx)("meta",{property:"og:image",content:p}),p&&(0,c.jsx)("meta",{name:"twitter:image",content:p}),i]})}const p=r.createContext(void 0);function f(e){let{className:t,children:n}=e;const i=r.useContext(p),l=(0,a.Z)(i,t);return(0,c.jsxs)(p.Provider,{value:l,children:[(0,c.jsx)(o.Z,{children:(0,c.jsx)("html",{className:l})}),n]})}function g(e){let{children:t}=e;const n=l(),r=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const o=`plugin-id-${n.plugin.id}`;return(0,c.jsx)(f,{className:(0,a.Z)(r,o),children:t})}},3619:(e,t,n)=>{"use strict";n.d(t,{D9:()=>l,Qc:()=>c,Ql:()=>u,i6:()=>s,zX:()=>i});var r=n(79),a=n(7962),o=n(5250);function i(e){const t=(0,r.useRef)(e);return(0,a.Z)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function l(e){const t=(0,r.useRef)();return(0,a.Z)((()=>{t.current=e})),t.current}class s extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function u(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function c(e){return t=>{let{children:n}=t;return(0,o.jsx)(o.Fragment,{children:e.reduceRight(((e,t)=>(0,o.jsx)(t,{children:e})),n)})}}},2098:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>l});var r=n(79),a=n(1724),o=n(5302);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function l(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>e.routes??[])))}(n)}({routes:a.Z,baseUrl:e})),[e])}},8153:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>m,OC:()=>c,RF:()=>f,o5:()=>g});var r=n(79),a=n(8621),o=n(908),i=n(7962),l=n(3619),s=n(5250);const u=r.createContext(void 0);function c(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,s.jsx)(u.Provider,{value:n,children:t})}function d(){const e=(0,r.useContext)(u);if(null==e)throw new l.i6("ScrollControllerProvider");return e}const p=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=d(),a=(0,r.useRef)(p()),o=(0,l.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function g(){const e=d(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}}),[]);return(0,r.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,r.useRef)(void 0),a=(0,r.useCallback)((r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,i.Z)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:a}}function m(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&at&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},1279:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(5302);const r="default";function a(e,t){return`docs-${e}-${t}`}},5778:(e,t,n)=>{"use strict";n.d(t,{Nk:()=>c,WA:()=>u});var r=n(79);const a="localStorage";function o(e){let{key:t,oldValue:n,newValue:r,storage:a}=e;if(n===r)return;const o=document.createEvent("StorageEvent");o.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,a),window.dispatchEvent(o)}function i(e){if(void 0===e&&(e=a),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,l||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),l=!0),null}var t}let l=!1;const s={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function u(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const n=i(t?.persistence);return null===n?s:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const r=n.getItem(e);n.setItem(e,t),o({key:e,oldValue:r,newValue:t,storage:n})}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),o({key:e,oldValue:t,newValue:null,storage:n})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const r=r=>{r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),()=>window.removeEventListener("storage",r)}catch(r){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,r),()=>{}}}}}function c(e,t){const n=(0,r.useRef)((()=>null===e?s:u(e,t))).current(),a=(0,r.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,r.useSyncExternalStore)(a,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}},9252:(e,t,n)=>{"use strict";n.d(t,{l:()=>i});var r=n(5302),a=n(7911),o=n(2985);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:l}}=(0,r.Z)(),{pathname:s}=(0,a.TH)(),u=(0,o.applyTrailingSlash)(s,{trailingSlash:n,baseUrl:e}),c=l===i?e:e.replace(`/${l}/`,"/"),d=u.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${c}`:`${c}${e}/`}(n)}${d}`}}}},5289:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(79),a=n(7911),o=n(3619);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},4104:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(5302);function a(){return(0,r.Z)().siteConfig.themeConfig}},7311:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},1997:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},2985:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var a=n(7311);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}});var o=n(1997);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return o.getErrorCausalChain}})},2852:(e,t,n)=>{"use strict";n.d(t,{lX:()=>w,q_:()=>_,ob:()=>f,PP:()=>T,Ep:()=>p});var r=n(432);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;p--){var f=i[p];"."===f?o(i,p):".."===f?(o(i,p),d++):d&&(o(i,p),d--)}if(!u)for(;d--;d)i.unshift("..");!u||""===i[0]||i[0]&&a(i[0])||i.unshift("");var g=i.join("/");return n&&"/"!==g.substr(-1)&&(g+="/"),g};var l=n(6381);function s(e){return"/"===e.charAt(0)?e:"/"+e}function u(e){return"/"===e.charAt(0)?e.substr(1):e}function c(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function f(e,t,n,a){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),o.state=t):(void 0===(o=(0,r.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function g(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof r?r(o,a):a(!0):a(!1!==o)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=f(e,t,m(),w.location);c.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(5566),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||a}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var u=Object.defineProperty,c=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,g=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(g){var a=f(n);a&&a!==g&&e(t,a,r)}var i=c(n);d&&(i=i.concat(d(n)));for(var l=s(t),m=s(n),h=0;h{"use strict";e.exports=function(e,t,n,r,a,o,i,l){if(!e){var s;if(void 0===t)s=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var u=[n,r,a,o,i,l],c=0;(s=new Error(t.replace(/%s/g,(function(){return u[c++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},566:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},3461:(e,t,n)=>{"use strict";n.r(t)},6790:(e,t,n)=>{"use strict";n.r(t)},7811:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),u=o.querySelector(r.barSelector),c=r.speed,d=r.easing;return o.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(u,i(e,c,d)),1===e?(s(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){s(o,{transition:"all "+c+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),c)}),c)):setTimeout(t,c)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");c(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,i=t.querySelector(r.barSelector),l=e?"-100":o(n.status||0),u=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&f(a),u!=document.body&&c(u,"nprogress-custom-parent"),u.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+o)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function o(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&o(e,n,r);else o(e,a[1],a[2])}}();function u(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function c(e,t){var n=p(e),r=n+t;u(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);u(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},6084:(e,t,n)=>{var r=n(566);e.exports=f,e.exports.parse=o,e.exports.compile=function(e,t){return l(o(e,t),t)},e.exports.tokensToFunction=l,e.exports.tokensToRegExp=p;var a=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function o(e,t){for(var n,r=[],o=0,i=0,l="",c=t&&t.delimiter||"/";null!=(n=a.exec(e));){var d=n[0],p=n[1],f=n.index;if(l+=e.slice(i,f),i=f+d.length,p)l+=p[1];else{var g=e[i],m=n[2],h=n[3],y=n[4],b=n[5],v=n[6],w=n[7];l&&(r.push(l),l="");var k=null!=m&&null!=g&&g!==m,x="+"===v||"*"===v,S="?"===v||"*"===v,E=n[2]||c,C=y||b;r.push({name:h||o++,prefix:m||"",delimiter:E,optional:S,repeat:x,partial:k,asterisk:!!w,pattern:C?u(C):w?".*":"[^"+s(E)+"]+?"})}}return i{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},9637:(e,t,n)=>{const r=n(6744),a=n(6123),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6341).resolve(t)],delete Prism.languages[e],n(6341)(t),o.add(e)}))}i.silent=!1,e.exports=i},3715:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,l=i.length;-1!==n.code.indexOf(a=t(r,l));)++l;return i[l]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(l){for(var s=0;s=o.length);s++){var u=l[s];if("string"==typeof u||u.content&&"string"==typeof u.content){var c=o[a],d=n.tokenStack[c],p="string"==typeof u?u:u.content,f=t(r,c),g=p.indexOf(f);if(g>-1){++a;var m=p.substring(0,g),h=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),y=p.substring(g+f.length),b=[];m&&b.push.apply(b,i([m])),b.push(h),y&&b.push.apply(b,i([y])),"string"==typeof u?l.splice.apply(l,[s,1].concat(b)):u.content=b}}else u.content&&i(u.content)}return l}(n.tokens)}}}})}(Prism)},6341:(e,t,n)=>{var r={"./":9637};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6341},6123:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function u(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var i in a(t,o),l[t]=!0,n[t])l[i]=!0}t(s.require,u),t(s.optional,u),t(s.modify,u)}n[r]=l,o.pop()}}return function(e){var t=n[e];return t||(a(e,r),t=n[e]),t}}function a(e){for(var t in e)return!0;return!1}return function(o,i,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var a in r)if("meta"!=a){var o=r[a];t[a]="string"==typeof o?{title:o}:o}}return t}(o),u=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var a in n={},e){var o=e[a];t(o&&o.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+a+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+a+" because it is a component.");n[t]=a}))}return n[r]||r}}(s);i=i.map(u),l=(l||[]).map(u);var c=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(c[t]=!0,e(t))}))}));for(var p,f=r(s),g=c;a(g);){for(var m in p={},g){var h=s[m];t(h&&h.modify,(function(e){e in d&&(p[e]=!0)}))}for(var y in d)if(!(y in c))for(var b in f(y))if(b in c){p[y]=!0;break}for(var v in g=p)c[v]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,a){var o=a?a.series:void 0,i=a?a.parallel:e,l={},s={};function u(e){if(e in l)return l[e];s[e]=!0;var a,c=[];for(var d in t(e))d in n&&c.push(d);if(0===c.length)a=r(e);else{var p=i(c.map((function(e){var t=u(e);return delete s[e],t})));o?a=o(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var c in n)u(c);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,c,t,n)}};return w}}();e.exports=t},4835:(e,t,n)=>{"use strict";var r=n(1596);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},9519:(e,t,n)=>{e.exports=n(4835)()},1596:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},2920:(e,t,n)=>{"use strict";var r=n(79),a=n(3707);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n