Skip to content

fix: propagate provider option through session and broker to trustles… #833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: propagate provider option through session and broker to trustles… #833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/block-brokers/src/trustless-gateway/broker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import type { CID } from 'multiformats/cid'
export interface CreateTrustlessGatewaySessionOptions extends CreateSessionOptions<TrustlessGatewayGetBlockProgressEvents> {
/**
* By default we will only connect to peers with HTTPS addresses, pass true
* to also connect to HTTP addresses.
* to also connect to HTTP addresses.
*
* @default false
*/
Expand Down Expand Up @@ -57,7 +57,7 @@ export class TrustlessGatewayBlockBroker implements BlockBroker<TrustlessGateway
this.log('getting block for %c from %s', cid, gateway.url)

try {
const block = await gateway.getRawBlock(cid, options)
const block = await gateway.getRawBlock(cid, { ...options, provider: options.provider })
this.log.trace('got block for %c from %s', cid, gateway.url)

try {
Expand Down
13 changes: 9 additions & 4 deletions packages/block-brokers/src/trustless-gateway/trustless-gateway.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export interface GetRawBlockOptions {
* @default 2_097_152 (2MiB)
*/
maxSize?: number
provider?: string
}

/**
Expand Down Expand Up @@ -102,13 +103,17 @@ export class TrustlessGateway {
* Fetch a raw block from `this.url` following the specification defined at
* https://specs.ipfs.tech/http-gateways/trustless-gateway/
*/
async getRawBlock (cid: CID, { signal, maxSize = DEFAULT_MAX_SIZE }: GetRawBlockOptions = {}): Promise<Uint8Array> {
async getRawBlock (cid: CID, { signal, maxSize = DEFAULT_MAX_SIZE, provider }: GetRawBlockOptions = {}): Promise<Uint8Array> {
const gwUrl = new URL(this.url.toString())
gwUrl.pathname = `/ipfs/${cid.toString()}`

// necessary as not every gateway supports dag-cbor, but every should support
// sending raw block as-is
gwUrl.search = '?format=raw'
const params = new URLSearchParams( {format: 'raw'})
if (provider != null) {
params.set('provider', provider)
}
gwUrl.search = params.toString()



if (signal?.aborted === true) {
throw new Error(`Signal to fetch raw block for CID ${cid} from gateway ${this.url} was aborted prior to fetch`)
Expand Down
1 change: 1 addition & 0 deletions packages/interface/src/blocks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ export interface BlockRetrievalOptions <ProgressEvents extends ProgressEvent<any
* @default 2_097_152
*/
maxSize?: number
provider?: string
}

export interface BlockAnnounceOptions <ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>> extends AbortOptions, ProgressOptions<ProgressEvents> {
Expand Down